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

Listar clientes

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

Retorna uma página countless de clientes. Use limit e offset para paginação e combine os filtros disponíveis para restringir os resultados. Para campos adicionais do cliente, envie filtros no formato additionalFields.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
length ≥ 1

Busca textual ampla sobre os principais campos da entidade.

string
length ≥ 1

Nome do registro.

string

Status atual do registro.

string

Pulso de saúde do cliente.

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

ID do usuário relacionado ao registro.

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

ID do ISM responsável pelo cliente.

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.

number | null
0 to 100

Valor mínimo de health score para filtrar clientes.

number | null
0 to 100

Valor máximo de health score para filtrar clientes.

number | null
≥ 0

MRR mínimo para filtrar clientes.

number | null
≥ 0

MRR máximo para filtrar clientes.

boolean | null

Filtra clientes que possuem ou não health score.

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.

string

Filtro dinâmico por campo adicional do cliente. Use a chave persistida em additionalFields, por exemplo additionalFields.segment=enterprise. Para campos de seleção múltipla envie valores separados por vírgula, como additionalFields.tags=vip,onboarding.

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?