Sign in

v1

latestOpenAPI 3.0.12026-08-04115177259.2 KB
Contas

Listar

Para autenticar nos endpoints de Gestão de Contas, utilize o Token de Parceiro.<br />O token pode ser gerado na plataforma em Admin > Personalizar > Integração.<br />Envie-o no header Authorization com o schema Bearer.<br />Este token é exclusivo para os endpoints de Gestão de Contas e Parceiros. <br /><br />Listagem paginada de contas.

get/v1/company

Query parameters

SearchableTextstring

Texto para busca

OnlyInactiveboolean

Filtrar apenas contas inativas

Status'SANDBOX' | 'PRODUCTION'

Status da conta

SetupStatus'SUBSCRIPTION_PENDING' | 'SUBSCRIPTION_CREATED' | 'PENDING_CONFIG' | 'COMPLETED' | 'SUBSCRIPTION_ARREARS' | 'SUBSCRIPTION_SUSPENDED' | 'SUBSCRIPTION_CANCELED'

Status de configuração da conta

IncludeDetailsstring[]

Detalhes a serem incluídos na resposta

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

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