API Reference

Filtrar

post
https://api.wts.chat/core/v1/contact/filter

Filtragem paginada de contatos.

Body Params

Parâmetros para filtragem dos contatos. Os filtros são aditivos.

int32
0 to 2147483647
Defaults to 1

Número da página a ser obtida.

int32
1 to 100
Defaults to 15

Tamanho da página a ser obtida.

string | null

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

string | null
enum

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

Allowed:
createdAt
object
updatedAt
object
includeDetails
array of strings | null

Detalhes que devem ser incluídos na resposta.

includeDetails
string | null
enum
Defaults to ACTIVE

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

Allowed:
string | null

Filtro textual. A busca é realizada nos atributos textuais relevantes do contato.

string | null

Filtro por nome.

string | null

Filtro por número de telefone.

string | null

Filtro por email.

string | null

Filtro por nome de usuário do Instagram.

tagIds
array of uuids | null

Filtro por etiquetas usando IDs.

tagIds
tagNames
array of strings | null

Filtro por etiquetas usando nomes.

tagNames
string | null
enum

Filtro por origem.

Allowed:
customFields
object | null

Filtro por valores de campos personalizados.

metadata
object | null

Filtro por metadados.

Headers
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

Updated almost 2 years ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated almost 2 years ago