Skip to content

Lista os empregadores

Request

Lista todos empregadores ativos da conta. Pode ser filtrado por CNPJ e/ou CPF, útil para localizar empregadores criados na TiqueTaque que ainda não possuem external_id.

Security
BasicAuth
Query
cnpjstring^[0-9A-Z]{12}\d{2}$

Filtra empregadores pelo CNPJ, sem máscara. Aceita o formato numérico ou alfanumérico (12 caracteres alfanuméricos maiúsculos seguidos de 2 dígitos verificadores). Se enviado junto com cpf, retorna os empregadores que casam com qualquer um dos dois (OR).

Example:cnpj=23467093000164
cpfstring^\d{11}$

Filtra empregadores pelo CPF, apenas números, sem máscara. Se enviado junto com cnpj, retorna os empregadores que casam com qualquer um dos dois (OR).

Example:cpf=01234567890
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 \
  -u '<username>:<password>' \
  'https://api-docs.tiquetaque.app/_mock/openapi/payment-sources?cnpj=23467093000164&cpf=01234567890&max_results=25&page=1'

Responses

Lista de usuários.

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