v1
latestOpenAPI 3.0.12026-08-04115177259.2 KBContatos
Listar
Listagem paginada de contatos. Para resultados mais específicos, utilize o endpoint /filter.
get/v1/contact
Query parameters
IncludeDetailsstring[]
Detalhes que devem ser incluídos na resposta.
Status'ACTIVE' | 'ARCHIVED' | 'BLOCKED'
Status dos contatos a serem listados. Caso não informado, o valor padrão é ACTIVE.
CreatedAt.Beforestring date-time
Limite superior de busca, sempre em fuso horário UTM.
CreatedAt.Afterstring date-time
Limite inferior de busca, sempre em fuso horário UTM.
UpdatedAt.Beforestring date-time
Limite superior de busca, sempre em fuso horário UTM.
UpdatedAt.Afterstring date-time
Limite inferior de busca, sempre em fuso horário UTM.
PageNumberinteger
Número da página a ser obtida.
PageSizeinteger
Tamanho da página a ser obtida.
OrderBystring
Nome do campo para ser utilizado como pivô da ordenação.
OrderDirection'ASCENDING' | 'DESCENDING'
Determina se a ordenação deve ser crescente ou decrescente.
Response
Success