Pular para o conteúdo
MSP Desk para desenvolvedores

Conta os tickets da empresa da chave

GET
/v1/tickets/count
Code sample: Shell / cURL
curl --request GET \
  --url 'https://public-api.mspdesk.com.br/v1/tickets/count?filter%5Bid%5D%5Bin%5D=1%2C2%2C3&filter%5Bcode%5D%5Bin%5D=1%2C2%2C3&filter%5Bpriority%5D%5Beq%5D=PLANNED&filter%5Bpriority%5D%5Bin%5D=PLANNED%2CLOW%2CMEDIUM%2CHIGH%2CCRITICAL&filter%5Bpriority%5D%5Bnin%5D=PLANNED%2CLOW%2CMEDIUM%2CHIGH%2CCRITICAL&filter%5Bstatus%5D%5Beq%5D=TO_DO&filter%5Bstatus%5D%5Bin%5D=TO_DO%2CIN_PROGRESS%2CPENDING%2CCOMPLETED%2CCLOSED%2CDELETED&filter%5Bstatus%5D%5Bnin%5D=TO_DO%2CIN_PROGRESS%2CPENDING%2CCOMPLETED%2CCLOSED%2CDELETED&filter%5Borigin%5D%5Beq%5D=EMAIL&filter%5Borigin%5D%5Bin%5D=EMAIL%2CRMM%2CMSP_TALKS%2CINTERNAL%2CPORTAL%2CEXTERNAL_FORM%2CAPI&filter%5Borigin%5D%5Bnin%5D=EMAIL%2CRMM%2CMSP_TALKS%2CINTERNAL%2CPORTAL%2CEXTERNAL_FORM%2CAPI&filter%5BserviceType%5D%5Beq%5D=INTERNAL&filter%5BserviceType%5D%5Bin%5D=INTERNAL%2CEXTERNAL&filter%5BserviceType%5D%5Bnin%5D=INTERNAL%2CEXTERNAL&filter%5BcustomerId%5D%5Bin%5D=1%2C2%2C3&filter%5BcustomerId%5D%5Bnin%5D=1%2C2%2C3&filter%5BbusinessUnitId%5D%5Bin%5D=1%2C2%2C3&filter%5BbusinessUnitId%5D%5Bnin%5D=1%2C2%2C3&filter%5BserviceCatalogId%5D%5Bin%5D=1%2C2%2C3&filter%5BserviceCatalogId%5D%5Bnin%5D=1%2C2%2C3&filter%5BcategoryId%5D%5Bin%5D=1%2C2%2C3&filter%5BcategoryId%5D%5Bnin%5D=1%2C2%2C3&filter%5BsubcategoryId%5D%5Bin%5D=1%2C2%2C3&filter%5BsubcategoryId%5D%5Bnin%5D=1%2C2%2C3&filter%5BagentId%5D%5Bin%5D=1%2C2%2C3&filter%5BagentId%5D%5Bnin%5D=1%2C2%2C3&filter%5BserviceGroupId%5D%5Bin%5D=1%2C2%2C3&filter%5BserviceGroupId%5D%5Bnin%5D=1%2C2%2C3&filter%5BcontactId%5D%5Bin%5D=1%2C2%2C3&filter%5BcontactId%5D%5Bnin%5D=1%2C2%2C3&filter%5BticketTypeId%5D%5Bin%5D=1%2C2%2C3&filter%5BticketTypeId%5D%5Bnin%5D=1%2C2%2C3&filter%5BtagId%5D%5Bin%5D=1%2C2%2C3&filter%5BtagId%5D%5Bnin%5D=1%2C2%2C3&filter%5BslaResponseStatus%5D%5Beq%5D=WITHOUT&filter%5BslaResponseStatus%5D%5Bin%5D=WITHOUT%2CWITHIN%2CAPPROACHING_BREACH%2CBREACHED%2CFULLFILLED%2CPAUSED&filter%5BslaSolutionStatus%5D%5Beq%5D=WITHOUT&filter%5BslaSolutionStatus%5D%5Bin%5D=WITHOUT%2CWITHIN%2CAPPROACHING_BREACH%2CBREACHED%2CFULLFILLED%2CPAUSED&filter%5BslaStatusAny%5D%5Beq%5D=WITHOUT&filter%5BslaStatusAny%5D%5Bin%5D=WITHOUT%2CWITHIN%2CAPPROACHING_BREACH%2CBREACHED%2CFULLFILLED%2CPAUSED&filter%5BstageId%5D%5Bin%5D=1%2C2%2C3&filter%5BworkflowId%5D%5Bin%5D=1%2C2%2C3' \
  --header 'Authorization: Bearer <token>'

Escopo exigido: tickets:read. Aceita só filter[campo][operador], com os mesmos filtros da listagem (inclusive filter[customFields.<id>][..]); qualquer outro parâmetro é 400 invalid_query. Consome o limite de uso normal, não um limite à parte.

Tickets cujo lastActivityAt ainda não foi preenchido são contados normalmente quando a contagem não filtra por esse campo, mas ficam de fora de uma listagem ordenada ou filtrada por lastActivityAt — por isso as duas podem divergir por alguns instantes.

Autorizações

Seção intitulada “Authorizations”

Parâmetros

Seção intitulada “Parameters”

Parâmetros de consulta

Seção intitulada “Query Parameters”
filter[id][eq]
integer format: int64

Filtra por id igual ao valor informado.

filter[id][in]
string
Exemplo
1,2,3

Filtra por id igual a um dos valores informados, separados por vírgula (até 100).

filter[code][eq]
integer format: int64

Filtra por code igual ao valor informado.

filter[code][in]
string
Exemplo
1,2,3

Filtra por code igual a um dos valores informados, separados por vírgula (até 100).

filter[subject][contains]
string

Filtra por subject contendo o texto informado (sem diferenciar maiúsculas de minúsculas, conforme a colação do banco).

filter[priority][eq]
string
Allowed values: PLANNED LOW MEDIUM HIGH CRITICAL

Filtra por priority igual ao valor informado.

filter[priority][in]
string
Exemplo
PLANNED,LOW,MEDIUM,HIGH,CRITICAL

Filtra por priority igual a um dos valores informados, separados por vírgula (até 100).

filter[priority][nin]
string
Exemplo
PLANNED,LOW,MEDIUM,HIGH,CRITICAL

Filtra por priority diferente de todos os valores informados, separados por vírgula (até 100; inclui registros sem valor).

filter[status][eq]
string
Allowed values: TO_DO IN_PROGRESS PENDING COMPLETED CLOSED DELETED

Filtra por status igual ao valor informado.

filter[status][in]
string
Exemplo
TO_DO,IN_PROGRESS,PENDING,COMPLETED,CLOSED,DELETED

Filtra por status igual a um dos valores informados, separados por vírgula (até 100).

filter[status][nin]
string
Exemplo
TO_DO,IN_PROGRESS,PENDING,COMPLETED,CLOSED,DELETED

Filtra por status diferente de todos os valores informados, separados por vírgula (até 100; inclui registros sem valor).

filter[origin][eq]
string
Allowed values: EMAIL RMM MSP_TALKS INTERNAL PORTAL EXTERNAL_FORM API

Filtra por origin igual ao valor informado.

filter[origin][in]
string
Exemplo
EMAIL,RMM,MSP_TALKS,INTERNAL,PORTAL,EXTERNAL_FORM,API

Filtra por origin igual a um dos valores informados, separados por vírgula (até 100).

filter[origin][nin]
string
Exemplo
EMAIL,RMM,MSP_TALKS,INTERNAL,PORTAL,EXTERNAL_FORM,API

Filtra por origin diferente de todos os valores informados, separados por vírgula (até 100; inclui registros sem valor).

filter[serviceType][eq]
string
Allowed values: INTERNAL EXTERNAL

Filtra por serviceType igual ao valor informado.

filter[serviceType][in]
string
Exemplo
INTERNAL,EXTERNAL

Filtra por serviceType igual a um dos valores informados, separados por vírgula (até 100).

filter[serviceType][nin]
string
Exemplo
INTERNAL,EXTERNAL

Filtra por serviceType diferente de todos os valores informados, separados por vírgula (até 100; inclui registros sem valor).

filter[customerId][eq]
integer format: int64

Filtra por customerId igual ao valor informado.

filter[customerId][in]
string
Exemplo
1,2,3

Filtra por customerId igual a um dos valores informados, separados por vírgula (até 100).

filter[customerId][nin]
string
Exemplo
1,2,3

Filtra por customerId diferente de todos os valores informados, separados por vírgula (até 100; inclui registros sem valor).

filter[customerId][isNull]
boolean

Filtra por customerId ter ou não valor: true sem valor; false com valor.

filter[businessUnitId][eq]
integer format: int64

Filtra por businessUnitId igual ao valor informado.

filter[businessUnitId][in]
string
Exemplo
1,2,3

Filtra por businessUnitId igual a um dos valores informados, separados por vírgula (até 100).

filter[businessUnitId][nin]
string
Exemplo
1,2,3

Filtra por businessUnitId diferente de todos os valores informados, separados por vírgula (até 100; inclui registros sem valor).

filter[businessUnitId][isNull]
boolean

Filtra por businessUnitId ter ou não valor: true sem valor; false com valor.

filter[serviceCatalogId][eq]
integer format: int64

Filtra por serviceCatalogId igual ao valor informado.

filter[serviceCatalogId][in]
string
Exemplo
1,2,3

Filtra por serviceCatalogId igual a um dos valores informados, separados por vírgula (até 100).

filter[serviceCatalogId][nin]
string
Exemplo
1,2,3

Filtra por serviceCatalogId diferente de todos os valores informados, separados por vírgula (até 100; inclui registros sem valor).

filter[serviceCatalogId][isNull]
boolean

Filtra por serviceCatalogId ter ou não valor: true sem valor; false com valor.

filter[categoryId][eq]
integer format: int64

Filtra por categoryId igual ao valor informado.

filter[categoryId][in]
string
Exemplo
1,2,3

Filtra por categoryId igual a um dos valores informados, separados por vírgula (até 100).

filter[categoryId][nin]
string
Exemplo
1,2,3

Filtra por categoryId diferente de todos os valores informados, separados por vírgula (até 100; inclui registros sem valor).

filter[categoryId][isNull]
boolean

Filtra por categoryId ter ou não valor: true sem valor; false com valor.

filter[subcategoryId][eq]
integer format: int64

Filtra por subcategoryId igual ao valor informado.

filter[subcategoryId][in]
string
Exemplo
1,2,3

Filtra por subcategoryId igual a um dos valores informados, separados por vírgula (até 100).

filter[subcategoryId][nin]
string
Exemplo
1,2,3

Filtra por subcategoryId diferente de todos os valores informados, separados por vírgula (até 100; inclui registros sem valor).

filter[subcategoryId][isNull]
boolean

Filtra por subcategoryId ter ou não valor: true sem valor; false com valor.

filter[agentId][eq]
integer format: int64

Filtra por agentId igual ao valor informado.

filter[agentId][in]
string
Exemplo
1,2,3

Filtra por agentId igual a um dos valores informados, separados por vírgula (até 100).

filter[agentId][nin]
string
Exemplo
1,2,3

Filtra por agentId diferente de todos os valores informados, separados por vírgula (até 100; inclui registros sem valor).

filter[agentId][isNull]
boolean

Filtra por agentId ter ou não valor: true sem valor; false com valor.

filter[serviceGroupId][eq]
integer format: int64

Filtra por serviceGroupId igual ao valor informado.

filter[serviceGroupId][in]
string
Exemplo
1,2,3

Filtra por serviceGroupId igual a um dos valores informados, separados por vírgula (até 100).

filter[serviceGroupId][nin]
string
Exemplo
1,2,3

Filtra por serviceGroupId diferente de todos os valores informados, separados por vírgula (até 100; inclui registros sem valor).

filter[serviceGroupId][isNull]
boolean

Filtra por serviceGroupId ter ou não valor: true sem valor; false com valor.

filter[contactId][eq]
integer format: int64

Filtra por contactId igual ao valor informado.

filter[contactId][in]
string
Exemplo
1,2,3

Filtra por contactId igual a um dos valores informados, separados por vírgula (até 100).

filter[contactId][nin]
string
Exemplo
1,2,3

Filtra por contactId diferente de todos os valores informados, separados por vírgula (até 100; inclui registros sem valor).

filter[contactId][isNull]
boolean

Filtra por contactId ter ou não valor: true sem valor; false com valor.

filter[ticketTypeId][eq]
integer format: int64

Filtra por ticketTypeId igual ao valor informado.

filter[ticketTypeId][in]
string
Exemplo
1,2,3

Filtra por ticketTypeId igual a um dos valores informados, separados por vírgula (até 100).

filter[ticketTypeId][nin]
string
Exemplo
1,2,3

Filtra por ticketTypeId diferente de todos os valores informados, separados por vírgula (até 100; inclui registros sem valor).

filter[ticketTypeId][isNull]
boolean

Filtra por ticketTypeId ter ou não valor: true sem valor; false com valor.

filter[tagId][eq]
integer format: int64

Filtra por tagId igual ao valor informado.

filter[tagId][in]
string
Exemplo
1,2,3

Filtra por tagId igual a um dos valores informados, separados por vírgula (até 100).

filter[tagId][nin]
string
Exemplo
1,2,3

Filtra por tagId diferente de todos os valores informados, separados por vírgula (até 100; inclui registros sem valor).

filter[tagId][isNull]
boolean

Filtra por tagId ter ou não valor: true sem valor; false com valor.

filter[slaResponseStatus][eq]
string
Allowed values: WITHOUT WITHIN APPROACHING_BREACH BREACHED FULLFILLED PAUSED

Filtra por slaResponseStatus igual ao valor informado.

filter[slaResponseStatus][in]
string
Exemplo
WITHOUT,WITHIN,APPROACHING_BREACH,BREACHED,FULLFILLED,PAUSED

Filtra por slaResponseStatus igual a um dos valores informados, separados por vírgula (até 100).

filter[slaSolutionStatus][eq]
string
Allowed values: WITHOUT WITHIN APPROACHING_BREACH BREACHED FULLFILLED PAUSED

Filtra por slaSolutionStatus igual ao valor informado.

filter[slaSolutionStatus][in]
string
Exemplo
WITHOUT,WITHIN,APPROACHING_BREACH,BREACHED,FULLFILLED,PAUSED

Filtra por slaSolutionStatus igual a um dos valores informados, separados por vírgula (até 100).

filter[slaStatusAny][eq]
string
Allowed values: WITHOUT WITHIN APPROACHING_BREACH BREACHED FULLFILLED PAUSED

Filtra por slaStatusAny igual ao valor informado.

filter[slaStatusAny][in]
string
Exemplo
WITHOUT,WITHIN,APPROACHING_BREACH,BREACHED,FULLFILLED,PAUSED

Filtra por slaStatusAny igual a um dos valores informados, separados por vírgula (até 100).

filter[createdById][eq]
integer format: int64

Filtra por createdById igual ao valor informado.

filter[followerId][eq]
integer format: int64

Filtra por followerId igual ao valor informado.

filter[answered][eq]
boolean

Filtra por answered igual ao valor informado.

filter[deleted][eq]
boolean

Filtra por deleted igual ao valor informado.

filter[createdAt][gte]
string format: date-time

Filtra por createdAt maior ou igual ao valor informado.

filter[createdAt][lte]
string format: date-time

Filtra por createdAt menor ou igual ao valor informado.

filter[solvedAt][gte]
string format: date-time

Filtra por solvedAt maior ou igual ao valor informado.

filter[solvedAt][lte]
string format: date-time

Filtra por solvedAt menor ou igual ao valor informado.

filter[updatedAt][gte]
string format: date-time

Filtra por updatedAt maior ou igual ao valor informado.

filter[updatedAt][lte]
string format: date-time

Filtra por updatedAt menor ou igual ao valor informado.

filter[lastActivityAt][gte]
string format: date-time

Filtra por lastActivityAt maior ou igual ao valor informado.

filter[lastActivityAt][lte]
string format: date-time

Filtra por lastActivityAt menor ou igual ao valor informado.

filter[stageId][eq]
integer format: int64

Filtra por stageId igual ao valor informado.

filter[stageId][in]
string
Exemplo
1,2,3

Filtra por stageId igual a um dos valores informados, separados por vírgula (até 100).

filter[stageId][isNull]
boolean

Filtra por stageId ter ou não valor: true sem valor; false com valor.

filter[workflowId][eq]
integer format: int64

Filtra por workflowId igual ao valor informado.

filter[workflowId][in]
string
Exemplo
1,2,3

Filtra por workflowId igual a um dos valores informados, separados por vírgula (até 100).

filter[workflowId][isNull]
boolean

Filtra por workflowId ter ou não valor: true sem valor; false com valor.

Respostas

Seção intitulada “Responses”

200

Seção intitulada “200”

Quantidade de tickets

Media typeapplication/json
object
count
integer format: int64
Exemplo
{
  "count": 0
}

Cabeçalhos

Seção intitulada “Headers”
RateLimit-Limit
integer format: int32

Capacidade do balde mais restritivo consumido nesta requisição

RateLimit-Remaining
integer format: int32

Requisições restantes nesse balde

RateLimit-Reset
integer format: int32

Segundos até o balde encher de novo

400

Seção intitulada “400”

Requisição malformada ou parâmetros de consulta inválidos

Media typeapplication/problem+json

Erro no formato RFC 9457 (application/problem+json).

object
code
required

Código estável do erro, para tratamento programático.

string
detail
required

Explicação legível deste erro específico.

string
errors

Erros de campo — presente quando a falha vem de validação de campo.

Array<object>
object
code

Código estável do erro de campo.

string
Allowed values: required too_long too_short invalid_value invalid_format unknown_field unsupported_operator unsupported_field out_of_range not_found inactive inconsistent_reference not_applicable
field

Campo com erro, em notação de ponto/colchete. Ausente quando o erro não é de um campo específico.

string
nullable
message

Mensagem traduzida no locale da requisição.

string
layer

Presente só no 429

string
Allowed values: ip company key operation concurrency
operation

Presente só quando layer=operation

string
Allowed values: report pdf upload
requestId

Identificador da requisição — informe-o ao suporte ao reportar um erro.

string
requiredScope

Presente só no 403 insufficient_scope

string
status
required

Status HTTP da resposta.

integer format: int32
title
required

Título curto e legível do erro.

string
type
required

URI que identifica o tipo do erro.

string
Exemplo
{
  "code": "not_found",
  "detail": "O recurso solicitado não foi encontrado.",
  "errors": [
    {
      "code": "required"
    }
  ],
  "layer": "ip",
  "operation": "report",
  "requestId": "7f3a9c2e-4b1d-4f7a-9e0c-2b8d6a1f3c55",
  "status": 404,
  "title": "Recurso não encontrado",
  "type": "https://developers.mspdesk.com.br/erros/#not_found"
}

Cabeçalhos

Seção intitulada “Headers”
RateLimit-Limit
integer format: int32

Capacidade do balde mais restritivo consumido nesta requisição

RateLimit-Remaining
integer format: int32

Requisições restantes nesse balde

RateLimit-Reset
integer format: int32

Segundos até o balde encher de novo

401

Seção intitulada “401”

Chave de API ausente, inválida, revogada ou expirada

Media typeapplication/problem+json

Erro no formato RFC 9457 (application/problem+json).

object
code
required

Código estável do erro, para tratamento programático.

string
detail
required

Explicação legível deste erro específico.

string
errors

Erros de campo — presente quando a falha vem de validação de campo.

Array<object>
object
code

Código estável do erro de campo.

string
Allowed values: required too_long too_short invalid_value invalid_format unknown_field unsupported_operator unsupported_field out_of_range not_found inactive inconsistent_reference not_applicable
field

Campo com erro, em notação de ponto/colchete. Ausente quando o erro não é de um campo específico.

string
nullable
message

Mensagem traduzida no locale da requisição.

string
layer

Presente só no 429

string
Allowed values: ip company key operation concurrency
operation

Presente só quando layer=operation

string
Allowed values: report pdf upload
requestId

Identificador da requisição — informe-o ao suporte ao reportar um erro.

string
requiredScope

Presente só no 403 insufficient_scope

string
status
required

Status HTTP da resposta.

integer format: int32
title
required

Título curto e legível do erro.

string
type
required

URI que identifica o tipo do erro.

string
Exemplo
{
  "code": "not_found",
  "detail": "O recurso solicitado não foi encontrado.",
  "errors": [
    {
      "code": "required"
    }
  ],
  "layer": "ip",
  "operation": "report",
  "requestId": "7f3a9c2e-4b1d-4f7a-9e0c-2b8d6a1f3c55",
  "status": 404,
  "title": "Recurso não encontrado",
  "type": "https://developers.mspdesk.com.br/erros/#not_found"
}

403

Seção intitulada “403”

Acesso negado: empresa inativa (account_inactive), API pública desabilitada para a empresa (public_api_disabled), escopo liberado só com a API pública (scope_requires_public_api) ou escopo insuficiente (insufficient_scope)

Media typeapplication/problem+json

Erro no formato RFC 9457 (application/problem+json).

object
code
required

Código estável do erro, para tratamento programático.

string
detail
required

Explicação legível deste erro específico.

string
errors

Erros de campo — presente quando a falha vem de validação de campo.

Array<object>
object
code

Código estável do erro de campo.

string
Allowed values: required too_long too_short invalid_value invalid_format unknown_field unsupported_operator unsupported_field out_of_range not_found inactive inconsistent_reference not_applicable
field

Campo com erro, em notação de ponto/colchete. Ausente quando o erro não é de um campo específico.

string
nullable
message

Mensagem traduzida no locale da requisição.

string
layer

Presente só no 429

string
Allowed values: ip company key operation concurrency
operation

Presente só quando layer=operation

string
Allowed values: report pdf upload
requestId

Identificador da requisição — informe-o ao suporte ao reportar um erro.

string
requiredScope

Presente só no 403 insufficient_scope

string
status
required

Status HTTP da resposta.

integer format: int32
title
required

Título curto e legível do erro.

string
type
required

URI que identifica o tipo do erro.

string
Exemplo
{
  "code": "not_found",
  "detail": "O recurso solicitado não foi encontrado.",
  "errors": [
    {
      "code": "required"
    }
  ],
  "layer": "ip",
  "operation": "report",
  "requestId": "7f3a9c2e-4b1d-4f7a-9e0c-2b8d6a1f3c55",
  "status": 404,
  "title": "Recurso não encontrado",
  "type": "https://developers.mspdesk.com.br/erros/#not_found"
}

Cabeçalhos

Seção intitulada “Headers”
RateLimit-Limit
integer format: int32

Capacidade do balde mais restritivo consumido nesta requisição

RateLimit-Remaining
integer format: int32

Requisições restantes nesse balde

RateLimit-Reset
integer format: int32

Segundos até o balde encher de novo

429

Seção intitulada “429”

Limite de uso atingido (rate_limited); o campo layer indica a camada: ip, company, key, operation ou concurrency

Media typeapplication/problem+json

Erro no formato RFC 9457 (application/problem+json).

object
code
required

Código estável do erro, para tratamento programático.

string
detail
required

Explicação legível deste erro específico.

string
errors

Erros de campo — presente quando a falha vem de validação de campo.

Array<object>
object
code

Código estável do erro de campo.

string
Allowed values: required too_long too_short invalid_value invalid_format unknown_field unsupported_operator unsupported_field out_of_range not_found inactive inconsistent_reference not_applicable
field

Campo com erro, em notação de ponto/colchete. Ausente quando o erro não é de um campo específico.

string
nullable
message

Mensagem traduzida no locale da requisição.

string
layer

Presente só no 429

string
Allowed values: ip company key operation concurrency
operation

Presente só quando layer=operation

string
Allowed values: report pdf upload
requestId

Identificador da requisição — informe-o ao suporte ao reportar um erro.

string
requiredScope

Presente só no 403 insufficient_scope

string
status
required

Status HTTP da resposta.

integer format: int32
title
required

Título curto e legível do erro.

string
type
required

URI que identifica o tipo do erro.

string
Exemplo
{
  "code": "not_found",
  "detail": "O recurso solicitado não foi encontrado.",
  "errors": [
    {
      "code": "required"
    }
  ],
  "layer": "ip",
  "operation": "report",
  "requestId": "7f3a9c2e-4b1d-4f7a-9e0c-2b8d6a1f3c55",
  "status": 404,
  "title": "Recurso não encontrado",
  "type": "https://developers.mspdesk.com.br/erros/#not_found"
}

Cabeçalhos

Seção intitulada “Headers”
RateLimit-Limit
integer format: int32

Capacidade do balde mais restritivo consumido nesta requisição

RateLimit-Remaining
integer format: int32

Requisições restantes nesse balde

RateLimit-Reset
integer format: int32

Segundos até o balde encher de novo

Retry-After
integer format: int32

Segundos até poder repetir

500

Seção intitulada “500”

Erro interno inesperado

Media typeapplication/problem+json

Erro no formato RFC 9457 (application/problem+json).

object
code
required

Código estável do erro, para tratamento programático.

string
detail
required

Explicação legível deste erro específico.

string
errors

Erros de campo — presente quando a falha vem de validação de campo.

Array<object>
object
code

Código estável do erro de campo.

string
Allowed values: required too_long too_short invalid_value invalid_format unknown_field unsupported_operator unsupported_field out_of_range not_found inactive inconsistent_reference not_applicable
field

Campo com erro, em notação de ponto/colchete. Ausente quando o erro não é de um campo específico.

string
nullable
message

Mensagem traduzida no locale da requisição.

string
layer

Presente só no 429

string
Allowed values: ip company key operation concurrency
operation

Presente só quando layer=operation

string
Allowed values: report pdf upload
requestId

Identificador da requisição — informe-o ao suporte ao reportar um erro.

string
requiredScope

Presente só no 403 insufficient_scope

string
status
required

Status HTTP da resposta.

integer format: int32
title
required

Título curto e legível do erro.

string
type
required

URI que identifica o tipo do erro.

string
Exemplo
{
  "code": "not_found",
  "detail": "O recurso solicitado não foi encontrado.",
  "errors": [
    {
      "code": "required"
    }
  ],
  "layer": "ip",
  "operation": "report",
  "requestId": "7f3a9c2e-4b1d-4f7a-9e0c-2b8d6a1f3c55",
  "status": 404,
  "title": "Recurso não encontrado",
  "type": "https://developers.mspdesk.com.br/erros/#not_found"
}

Cabeçalhos

Seção intitulada “Headers”
RateLimit-Limit
integer format: int32

Capacidade do balde mais restritivo consumido nesta requisição

RateLimit-Remaining
integer format: int32

Requisições restantes nesse balde

RateLimit-Reset
integer format: int32

Segundos até o balde encher de novo