> ## Documentation Index
> Fetch the complete documentation index at: https://docs.salvy.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Detalhar tarefa

> Consulta o andamento de uma tarefa iniciada por uma chave de API da sua empresa, com as contagens de itens aplicados, com falha, pendentes e interrompidos. O resultado de cada item está em GET /tasks/{id}/results. Tarefas iniciadas pelo dashboard não são consultáveis por aqui e respondem 404.



## OpenAPI

````yaml api-reference/v3/openapi.json GET /api/v3/tasks/{id}
openapi: 3.1.0
info:
  version: v3
  title: Salvy API
  x-logo:
    url: web/logo.png
servers:
  - url: https://api.salvy.com.br
    description: Salvy API URL
security:
  - bearerAuth: []
tags:
  - name: Public API
  - name: Outgoing Webhooks
paths:
  /api/v3/tasks/{id}:
    get:
      tags:
        - Public API
      description: >-
        Consulta o andamento de uma tarefa iniciada por uma chave de API da sua
        empresa, com as contagens de itens aplicados, com falha, pendentes e
        interrompidos. O resultado de cada item está em GET /tasks/{id}/results.
        Tarefas iniciadas pelo dashboard não são consultáveis por aqui e
        respondem 404.
      operationId: publicGetTaskV3
      parameters:
        - name: id
          in: path
          required: true
          schema:
            $schema: https://json-schema.org/draft/2020-12/schema
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  id:
                    type: string
                    format: uuid
                    pattern: >-
                      ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                    description: ID da tarefa.
                    example: 0f9c1b2e-5d3a-4f8b-9c7e-1a2b3c4d5e6f
                  type:
                    type: string
                    enum:
                      - phone-account.update-cost-center
                      - phone-account.update-custom-fields
                      - phone-account.top-up-data
                      - phone-account.cancel
                      - employee.sync
                    description: >-
                      Operação da tarefa, que define o formato de cada item em
                      GET /tasks/{id}/results:
                      `phone-account.update-cost-center` (centro de custo),
                      `phone-account.update-custom-fields` (campos
                      customizados), `phone-account.top-up-data` (recarga de
                      dados), `phone-account.cancel` (cancelamento) ou
                      `employee.sync` (criação ou atualização de colaboradores).
                      Novos valores podem ser adicionados; trate um valor
                      desconhecido sem falhar.
                    example: phone-account.update-cost-center
                  status:
                    type: string
                    enum:
                      - running
                      - succeeded
                      - failed
                      - canceled
                    description: >-
                      Situação da tarefa: `running` enquanto ainda há itens
                      sendo processados, `succeeded` quando a alteração foi
                      aplicada em todos os itens, `failed` quando terminou com
                      ao menos um item com falha, `canceled` quando foi
                      interrompida.
                    example: running
                  totalCount:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                    description: Quantidade de itens incluídos na tarefa.
                    example: 10
                  appliedCount:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                    description: Quantidade de itens em que a alteração foi aplicada.
                    example: 7
                  failedCount:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                    description: Quantidade de itens em que a alteração não foi aplicada.
                    example: 1
                  pendingCount:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                    description: Quantidade de itens que ainda estão sendo processados.
                    example: 2
                  canceledCount:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                    description: >-
                      Quantidade de itens que deixaram de ser processados porque
                      a tarefa foi interrompida.
                    example: 0
                required:
                  - id
                  - type
                  - status
                  - totalCount
                  - appliedCount
                  - failedCount
                  - pendingCount
                  - canceledCount
                additionalProperties: false
        '401':
          description: ''
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  code:
                    type: string
                    enum:
                      - unauthorized
                  message:
                    type: string
                required:
                  - code
                  - message
                additionalProperties: {}
        '403':
          description: ''
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  code:
                    type: string
                    enum:
                      - forbidden
                      - insufficient-scope
                  message:
                    type: string
                required:
                  - code
                  - message
                additionalProperties: {}
        '404':
          description: ''
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  code:
                    type: string
                    enum:
                      - resource-not-found
                  message:
                    type: string
                required:
                  - code
                  - message
                additionalProperties: {}
        '413':
          description: ''
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  code:
                    type: string
                    enum:
                      - payload-too-large
                  message:
                    type: string
                required:
                  - code
                  - message
                additionalProperties: {}
        '422':
          description: ''
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  code:
                    type: string
                    enum:
                      - input-validation-error
                      - unprocessable-entity
                      - company-not-active
                  message:
                    type: string
                  details:
                    type: array
                    items:
                      type: object
                      properties:
                        key:
                          type: string
                        message:
                          type: string
                      required:
                        - key
                        - message
                      additionalProperties: false
                required:
                  - code
                  - message
                additionalProperties: {}
        '429':
          description: ''
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  code:
                    type: string
                    enum:
                      - too-many-attempts
                  message:
                    type: string
                required:
                  - code
                  - message
                additionalProperties: {}
        '500':
          description: ''
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  code:
                    type: string
                    enum:
                      - unknown
                  message:
                    type: string
                required:
                  - code
                  - message
                additionalProperties: {}
      deprecated: false
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: key

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.