Listar contas

Este endpoint retorna todas as contas cadastradas.

GET /Account

Este endpoint retorna todas as contas cadastradas.

Autenticação

Autenticação obrigatória. Envie sua chave de API de usuário no header X-API-Key.

Parâmetros

NomeLocalTipoObrigatórioDescriçãoRestrições
EnabledFilterqueryEnabledFilterNão0 = All; 1 = Enabled; 2 = Disabled—
NamequerystringNão——
CustomerTenantIdqueryinteger · int32Não——

Corpo da requisição

Esta operação não recebe corpo de requisição.

Exemplo de requisição

curl --request GET \
  --url 'https://api.zild.ai/Account?EnabledFilter={EnabledFilter}&Name={Name}&CustomerTenantId={CustomerTenantId}' \
  --header 'X-API-Key: YOUR_USER_API_KEY'

Respostas

StatusDescriçãoCorpo da resposta
200Sucesso ao retornar as contasapplication/json · array<AccountDto>

Exemplo de resposta (200):

[
  {
    "id": 0,
    "name": "string",
    "legalName": "string",
    "site": "string",
    "linkedInUrl": "string",
    "email": "string",
    "taxId": "string",
    "enabled": true,
    "customerTenantId": 0
  }
]

Modelos de dados

AccountDto
PropriedadeTipoObrigatórioDescriçãoRestrições
idinteger · int32Não——
namestringNão—aceita null
legalNamestringNão—aceita null
sitestringNão—aceita null
linkedInUrlstringNão—aceita null
emailstringNão—aceita null
taxIdstringNão—aceita null
enabledbooleanNão——
customerTenantIdinteger · int32Não——
EnabledFilter

0 = All; 1 = Enabled; 2 = Disabled

integer