Listar

get

https://api.chatbotv4.sincorp.com.br/core/v1/contact

Listagem paginada de contatos. Para resultados mais específicos, utilize o endpoint /filter.

Query Params

IncludeDetails

array of strings

Detalhes que devem ser incluídos na resposta.

IncludeDetails

Allowed:

Status

string

enum

Defaults to ACTIVE

Status dos contatos a serem listados. Caso não informado, o valor padrão é ACTIVE.

Allowed:

CreatedAt.Before

date-time

Limite superior de busca, sempre em fuso horário UTM.

CreatedAt.After

date-time

Limite inferior de busca, sempre em fuso horário UTM.

UpdatedAt.Before

date-time

Limite superior de busca, sempre em fuso horário UTM.

UpdatedAt.After

date-time

Limite inferior de busca, sempre em fuso horário UTM.

PageNumber

int32

0 to 2147483647

Defaults to 1

Número da página a ser obtida.

PageSize

int32

1 to 100

Defaults to 15

Tamanho da página a ser obtida.

OrderBy

string

Nome do campo para ser utilizado como pivô da ordenação.

OrderDirection

string

enum

Determina se a ordenação deve ser crescente ou decrescente.

Allowed:

Responses

200Success