Get All

GET /api/labels

Http bearer

Get all labels

Query parameters

page integer

Default value is 1.
perPage integer

Maximum value is 250. Default value is 100.
search string | null
sortBy string | null

Default value is name.

Responses

200 application/json

Successful Response
Hide response attributes Show response attributes object
- items array[object] Required
  
  Hide items attributes Show items attributes object
  
  name string Required
  
  Minimum length is 1, maximum length is 50.
  
  bgColor string Required
  
  Maximum length is 20.
  
  id string Required
  
  resourceType string Required
  
  createdAt string(date-time) Required
- total integer Required
- page integer Required
- perPage integer Required
- totalPages integer Required
- hasNextPage boolean Required
422 application/json

Validation Error
Hide response attribute Show response attribute object
- detail array[object]
  
  Hide detail attributes Show detail attributes object
  
  loc array[string | integer] Required
  
  msg string Required
  
  type string Required

GET /api/labels

curl \
 -X GET https://metropolitanabogota.org/api/labels \
 -H "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "items": [
    {
      "name": "string",
      "bgColor": "string",
      "id": "string",
      "resourceType": "string",
      "createdAt": "2024-05-04T09:42:00+00:00"
    }
  ],
  "total": 42,
  "page": 42,
  "perPage": 42,
  "totalPages": 42,
  "hasNextPage": true
}

Response examples (422)

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}