Listar

get

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

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

Listagem paginada de contas.

Query Params

SearchableText

string

Texto para busca

OnlyInactive

boolean

Filtrar apenas contas inativas

Status

string

enum

Status da conta

Allowed:

SetupStatus

string

enum

Status de configuração da conta

Allowed:

IncludeDetails

array of strings

Detalhes a serem incluídos na resposta

IncludeDetails

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

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

500Server Error