Lista os anexos de um ticket

GET

/v1/tickets/{ticketId}/attachments

Shell / cURL

curl --request GET \
  --url 'https://public-api.mspdesk.com.br/v1/tickets/1/attachments?filter%5Bid%5D%5Bin%5D=1%2C2%2C3&limit=25&sort=-id&fields=id%2CfileName%2CcontentType&expand=customer%2Cagent' \
  --header 'Authorization: Bearer <token>'

Escopo exigido: tickets:read. Paginação por cursor opaco (?cursor=), nunca por página/offset — use nextCursor da resposta anterior. A ordenação padrão é id crescente.

A lista é a da aba Anexos: ficam de fora os dois tipos de imagem que existem por causa do texto e não como arquivo — a que o remetente do e-mail declarou embutida (inline, tipicamente assinatura ou papel de carta) e a que o agente colou no editor da descrição (linkedToDescription). As duas seguem visíveis onde foram postas, no corpo. Por isso os dois campos saem sempre false aqui, e nenhum dos dois é filtro: um filtro que só pode casar um valor não filtra nada.

Anexo de nota e de apontamento continuam na lista: são arquivo de verdade, só que anexados em outro momento do ticket. Use filter[noteId][isNull]=true e filter[appointmentId][isNull]=true para ficar só com os anexos soltos.

sort= aceita só id e fileName. createdAt e updatedAt são filtro e não ordenação: são colunas novas, nulas no que foi registrado antes desta API, e um valor nulo não serve de chave de paginação estável.

fileName é o nome de exibição do arquivo, o mesmo que a tela mostra — a ordenação e o filter[fileName][contains] valem sobre ele, não sobre a chave interna de armazenamento.

Autorizações

bearer

Parâmetros

Parâmetros de caminho

ticketId

required

integer format: int64

ID do ticket

Exemplo

Parâmetros de consulta

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[noteId][eq]

integer format: int64

Filtra por noteId igual ao valor informado.

filter[noteId][isNull]

boolean

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

filter[appointmentId][eq]

integer format: int64

Filtra por appointmentId igual ao valor informado.

filter[appointmentId][isNull]

boolean

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

filter[fileName][contains]

string

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

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[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.

limit

integer format: int32

default: 25 >= 1 <= 100

Itens por página. 1 a 100; padrão 25.

cursor

string

Cursor opaco da próxima página, devolvido em nextCursor da resposta anterior. Omita na primeira página.

sort

string

Campo de ordenação: fileName, id (padrão id). Prefixe com - para descendente (ex.: sort=-id); sempre desempatado por id na mesma direção.

Exemplo

-id

fields

string

Campos de primeiro nível a retornar, separados por vírgula (id sempre volta): id, fileName, contentType, size, noteId, appointmentId, linkedToDescription, inline, createdAt, updatedAt.

Exemplo

id,fileName,contentType

expand

string

Objetos a acrescentar à resposta, separados por vírgula, até 3 por requisição: . Sem o escopo exigido de algum item pedido: 403 insufficient_scope.

Exemplo

customer,agent

Respostas

200

Página de anexos

application/json

object

data

Array<object>

Arquivo anexado a um ticket.

object

appointmentId

Apontamento a que o anexo está preso. Nulo num anexo solto da aba.

integer format: int64

nullable

contentType

Tipo de mídia declarado no envio.

string

nullable

createdAt

Instante de criação do registro. Nulo em anexo anterior a esta API.

string format: date-time

nullable

fileName

Nome do arquivo como a tela o mostra.

string

nullable

Identificador do anexo.

integer format: int64

inline

O arquivo é uma imagem que o remetente do e-mail declarou embutida no corpo (assinatura, papel de carta). Sempre false no que a listagem devolve.

boolean

nullable

linkedToDescription

O arquivo é uma imagem colada no editor da descrição do ticket. Sempre false no que a listagem devolve.

boolean

nullable

noteId

Nota a que o anexo está preso. Nulo num anexo solto da aba.

integer format: int64

nullable

size

Tamanho em bytes.

integer format: int64

nullable

updatedAt

Instante da última alteração do registro. Nulo em anexo anterior a esta API que nunca foi alterado desde então.

string format: date-time

nullable

nextCursor

Cursor opaco da próxima página; null quando não há mais páginas.

string

nullable

Exemplo

{
  "data": [
    {
      "appointmentId": null,
      "contentType": "application/pdf",
      "createdAt": "2026-01-10T14:04:00Z",
      "fileName": "log-impressora.pdf",
      "id": 912,
      "inline": false,
      "linkedToDescription": false,
      "noteId": 1204,
      "size": 184320,
      "updatedAt": "2026-01-10T14:04:00Z"
    }
  ],
  "nextCursor": "eyJpZCI6MTA0Mn0"
}

Cabeçalhos

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

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

application/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

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

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

application/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

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)

application/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

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

404

Recurso inexistente, de outra empresa, ou rota inexistente

application/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

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

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

application/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

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

Erro interno inesperado

application/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

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