Pular para o conteúdo
MSP Desk para desenvolvedores

Lista as tags da empresa da chave

GET
/v1/tags
Code sample: Shell / cURL
curl --request GET \
  --url 'https://public-api.mspdesk.com.br/v1/tags?limit=25&sort=-name&fields=id%2Cname%2Ccolor&filter%5Bid%5D%5Bin%5D=1%2C2%2C3&filter%5Bname%5D%5Bcontains%5D=suporte&filter%5Bcolor%5D%5Beq%5D=GRAY&filter%5Bcolor%5D%5Bin%5D=RED%2CBLUE' \
  --header 'Authorization: Bearer <token>'

Escopo exigido: settings:read. Paginação por cursor opaco (?cursor=), nunca por página/offset — use nextCursor da resposta anterior. Filtros: id (eq, in), name (eq, contains), color (eq, in), createdAt/updatedAt (gte, lte), como filter[name][contains]=suporte. Ordenação (sort=): name, id — padrão id; prefixe com - para descendente (ex.: sort=-name), sempre desempatado por id na mesma direção. fields= seleciona colunas de primeiro nível da resposta (id sempre volta). Sem expand.

Autorizações

Seção intitulada “Authorizations”

Parâmetros

Seção intitulada “Parameters”

Parâmetros de consulta

Seção intitulada “Query Parameters”
cursor
string

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

limit
integer
default: 25 >= 1 <= 100

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

sort
string

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

Exemplo
-name
fields
string

Campos de primeiro nível a retornar, separados por vírgula (id sempre volta).

Exemplo
id,name,color
filter[id][eq]
integer format: int64

Filtra por id igual ao valor informado.

filter[id][in]
string

Filtra por id entre os valores informados, separados por vírgula.

Exemplo
1,2,3
filter[name][eq]
string

Filtra por name igual ao valor informado.

filter[name][contains]
string

Filtra por name contendo o texto informado.

Exemplo
suporte
filter[color][eq]
string
Allowed values: GRAY RED ORANGE YELLOW GREEN BLUE INDIGO PURPLE PINK

Filtra por color igual ao valor informado.

filter[color][in]
string

Filtra por color entre os valores informados, separados por vírgula.

Exemplo
RED,BLUE
filter[createdAt][gte]
string format: date-time

Filtra por createdAt maior ou igual à data/hora informada (ISO 8601).

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

Filtra por createdAt menor ou igual à data/hora informada (ISO 8601).

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

Filtra por updatedAt maior ou igual à data/hora informada (ISO 8601).

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

Filtra por updatedAt menor ou igual à data/hora informada (ISO 8601).

Respostas

Seção intitulada “Responses”

200

Seção intitulada “200”

Página de tags

Media typeapplication/json
object
data
Array<object>
object
color
string
nullable
Allowed values: GRAY RED ORANGE YELLOW GREEN BLUE INDIGO PURPLE PINK
createdAt
string format: date-time
nullable
id
integer format: int64
name
string
nullable
updatedAt
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": [
    {
      "color": "RED",
      "createdAt": "2026-01-10T15:00:00Z",
      "id": 1,
      "name": "urgente",
      "updatedAt": "2026-01-10T15:00:00Z"
    }
  ],
  "nextCursor": null
}

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”

invalid_query: limit/sort/filter/fields/cursor 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”

invalid_api_key: chave 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”

insufficient_scope: a chave não tem settings:read

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