Skip to content

Contas

Operações sobre as contas criadas pelo parceiro.

Operations

Lista as contas criadas pelo parceiro

Request

Retorna a listagem paginada das contas vinculadas ao parceiro identificado pelo token da requisição, ordenadas da mais recente para a mais antiga. Cada conta é retornada com o nome, e-mail financeiro e CNPJ do empregador, o número de funcionários ativos, o número de funcionários contratados na assinatura e o número de reconhecimentos faciais contratados na assinatura ativa.

A listagem nunca retorna o token de acesso das contas à API pública TiqueTaque; ele pode ser obtido através do endpoint GET /partner-accounts/{account_id}, mediante a chave secreta da conta.

Security
BearerAuth
Query
max_resultsinteger(MaxResultsParamModel)

Tamanho da página de resultados paginados.

Default:25
pageinteger(PageParamModel)

Número da página de resultados a retornar

Default:1
curl -i -X GET \
  'https://partner-api-docs.tiquetaque.com/_mock/openapi/partner-accounts?max_results=25&page=1' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Lista de contas do parceiro.

Bodyapplication/json
_itemsArray of objects(PartnerAccountModel)
_metaobject(MetaModel)
Response
{
  "_items": [
    { … }
  ],
  "_links": {
    "parent": { … },
    "self": { … },
    "next": { … },
    "last": { … }
  },
  "_meta": {
    "max_results": 0,
    "page": 0,
    "total": 0
  }
}