v1

latestOpenAPI 3.0.12026-08-04115177259.2 KB
Carteiras

Listar contatos

Listagem de contatos associados a uma carteira.

get/v1/portfolio/{id}/contact

Path parameters

idstring uuid required

Id da carteira.

Query parameters

CreatedAt.Beforestring date-time
CreatedAt.Afterstring date-time
CreatedAt.ApplyCompanyTimezoneboolean
CreatedAt.IsNullboolean
UpdatedAt.Beforestring date-time
UpdatedAt.Afterstring date-time
UpdatedAt.ApplyCompanyTimezoneboolean
UpdatedAt.IsNullboolean
ContactIdsstring[]
Pageinteger
PageSizeinteger
OrderBystring
OrderByDescstring
TimestampFieldstring
TimestampFilterstring date-time
NextPageTokenstring
Type'Undefined' | 'PageNumber' | 'Timestamp' | 'Token'
SkipCountboolean

Response

Success

pageNumberinteger

Número da página a ser obtida.

pageSizeinteger

Tamanho da página a ser obtida.

orderBystring nullable

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

orderDirection'ASCENDING' | 'DESCENDING' nullable

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

totalItemsinteger
totalPagesinteger
hasMorePagesboolean