Listar contatos

Este endpoint retorna todos os contatos cadastrados.

GET /Contact

Este endpoint retorna todos os contatos cadastrados.

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——

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/Contact?EnabledFilter={EnabledFilter}&Name={Name}' \
  --header 'X-API-Key: YOUR_USER_API_KEY'

Respostas

StatusDescriçãoCorpo da resposta
200Sucesso ao retornar os contatosapplication/json · array<ContactDto>

Exemplo de resposta (200):

[
  {
    "id": 0,
    "firstName": "string",
    "lastName": "string",
    "fullName": "string",
    "linkedInUrl": "string",
    "title": "string",
    "companyName": "string",
    "accountId": 0,
    "preferredUserId": 0,
    "enabled": true,
    "externalId": "string",
    "primaryEmail": "string",
    "primaryPhone": "string"
  }
]

Modelos de dados

ContactDto
PropriedadeTipoObrigatórioDescriçãoRestrições
idinteger · int32Não——
firstNamestringNão—aceita null
lastNamestringNão—aceita null
fullNamestringNão—aceita null
linkedInUrlstringNão—aceita null
titlestringNão—aceita null
companyNamestringNão—aceita null
accountIdinteger · int32Não——
preferredUserIdinteger · int32Não——
enabledbooleanNão——
externalIdstringNão—aceita null
primaryEmailstringNão—aceita null
primaryPhonestringNão—aceita null
EnabledFilter

0 = All; 1 = Enabled; 2 = Disabled

integer