API Reference
  1. API Pública Soft CS
  2. Contatos

Listar contatos

get
https://admin.softcs.com.br/api/public/v1/clients//contacts

Retorna uma página countless de contatos. Use limit e offset para paginação e combine os filtros disponíveis para restringir os resultados.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
^[a-f\d]{24}$

ID do cliente Soft CS ao qual o recurso pertence.

Query Params
string
length ≥ 1

Busca textual ampla sobre os principais campos da entidade.

string
length ≥ 1

Nome do registro.

string
length ≥ 1

E-mail do contato ou usuário.

string
length ≥ 1

Telefone do contato.

string
length ≥ 1

Cargo do contato.

string
length ≥ 1

ID externo usado pela integração.

string
^[a-f\d]{24}$

ID do usuário relacionado ao registro.

date-time

Data inicial de criação para filtrar a listagem.

date-time

Data final de criação para filtrar a listagem.

date-time

Data inicial de atualização para filtrar a listagem.

date-time

Data final de atualização para filtrar a listagem.

string
enum

Campo usado para ordenar a listagem.

Allowed:
string
enum

Direção da ordenação. Use asc ou desc.

Allowed:
integer
1 to 200

Quantidade máxima de itens retornados. Máximo permitido: 200.

integer | null
0 to 10000

Posição inicial da página. Máximo permitido: 10000.

Responses

Updated about 2 months ago

Did this page help you?
Language
Credentials
OAuth2
Missing 1 required scope
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago

Did this page help you?