Response Format

API responses are in JSON format.
In endpoints where the result is a single object, it will be returned directly in the body of the response. For example:

GET /api/v2/jobs/123
Host: api.gupy.io
Authorization: Bearer 1c3ce6b8251d91c1112aa11d1ef2daa1

{
  "id": 36,
  "code": null,
  "name": "Estágio em Desenvolvimento de Software ",
  "roleName": "Programador",
	….
}

In listing endpoints the data will be in the results property:

GET /api/v1/jobs
Host: api.gupy.io
Authorization: Bearer 1c3ce6b8251d91c1112aa11d1ef2daa1
 
{
  "results": [
    {
      "id": 1,
      "name": "Estágio em Desenvolvimento de Software ",
      ....
    },
    {
      "id": 2,
      "name": "Estágio em Marketing e Vendas ",
      ….
    }
  ],
  "nextPageToken": "abc123"
}