Listar atividades

🔽
GET urlServidor/v1/activities

Obs: A palavra urlServidor deve ser substituída pela url do servidor.

Parâmetros da Requisição

Nome	Tipo	Obrigatório	Descrição
`integration-key`	string	Sim	Chave de integração.
`x-token`	string	Sim	Token utilizado para autenticação. Pode ser encontrado no portal da API.
`Authorization`	Auth Type Bearer Token	Sim	Inserir o Bearer Token, gerado na rota Auth

Exemplo de header da requisição

curl--request GET \
--location '{{urlServidor}/v1/activities' \
--header 'integration-key: your_integration_key' \
--header 'x-token: your_x_token' \
--header 'Authorization: Bearer {{bearer_token}}' \

Parâmetros de Query

Key	Tipo	Obrigatório	Descrição
filters	string	Não	JSON com filtros aplicáveis. Campos filtráveis: id,name,code
search	string	Não	Valor utilizado para busca textual em múltiplos campos.
perPage	number	Não	Limitado ao máximo de 100 por página.
page	number	Não	Página atual.
sorters	string	Não	JSON com lista de ordenadores. Campos ordenáveis: id,name,code,created_at,updated_at

Exemplo de Response de sucesso.

{
    "total": 3,
    "page": 1,
    "perPage": 20,
    "lastPage": 1,
    "data": [
        {
            "id": 685,
            "name": "Administração pública em geral",
            "code": "9311",
            "createdAt": "2025-01-16T04:37:36.000Z",
            "updatedAt": "2025-01-16T04:37:36.000Z"
        },
        {
            "id": 684,
            "name": "Outras atividades de ensino não especificadas anteriormente",
            "code": "8241",
            "createdAt": "2025-01-16T04:37:36.000Z",
            "updatedAt": "2025-01-16T04:37:36.000Z"
        },
        {
            "id": 683,
            "name": "Segurança e ordem pública",
            "code": "9223",
            "createdAt": "2025-01-16T04:37:36.000Z",
            "updatedAt": "2025-01-16T04:37:36.000Z"
        }
      ]
}

Descrição dos Campos do Response

Nome	Tipo	Descrição
`total`	number	Quantidade total de boletos encontrados.
`page`	number	Página atual da listagem.
`perPage`	number	Quantidade de registros por página.
`lastPage`	number	Número da última página disponível.
`data`	array	Lista com os registros de atividades econômicas.
Data
`id`	string	Identificador único da atividade econômica na base da Paytime.
`name`	string	Nome da atividade (ex: Comércio varejista, Prestação de serviços etc.).
`code`	string	Código da atividade para cadastro do tipo Individual.
`created_at`	string	Data de criação do registro.
`updated_at`	string	Data da última atualização do registro.

Para mais informações, consulte a documentação oficial da Paytime.

Códigos de Resposta

Consulte a página com os status: Status de respostas

Para mais detalhes sobre os parâmetros e funcionamento da API, acesse a documentação oficial da Paytime.