Respostas

Cabeçalho Content-Type

Todas as respostas são retornadas no formato JSON. Especificamos isso enviando o cabeçalho Content-Type.

Códigos de status

Abaixo está uma tabela contendo descrições dos vários códigos de status que atualmente suportamos em relação a vários recursos.

Código de resposta	Descrição
200	OK
201	Recurso criado
202	Aceito
400	Solicitação inválida
401	Não autorizado
404	Recurso não encontrado
406	Não aceitável
422	Entidade não processável
429	Muitas solicitações
500	Erro interno do servidor

Paginação

Quando uma solicitação é feita com uma consulta de paginação, os metadados são incluídos na resposta para permitir uma fácil travessia da página anterior, atual, primeira e última do conjunto de dados.

{
    "data": [
        // Response data
    ],
    "meta": {
        "total_pages": 100,
        "total_rows": 2000,
        "order": "DESC",
        "order_by": "resource_field",
        "limit": 20,
        "offset": 0,
        "next_key": ""
    }
}