GET
/
v1
/
companies

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

document
string

Um filtro com base no campo document da empresa. O valor deve ser uma string ou uma lista separada por vírgula.

creditPolicy
string

Um filtro com base no campo creditPolicies.id da empresa. O valor deve ser uma string ou uma lista separada por vírgula.

group
string

Um filtro com base no campo group da empresa. O valor deve ser uma string ou uma lista separada por vírgula.

id
string

Um filtro com base no campo id da empresa. O valor deve ser uma string ou uma lista separada por vírgula.

status
enum<string>

Um filtro com base no campo status. O valor deve ser uma string ou uma lista separada por vírgula.

Available options:
active,
inactive
expand
string

Expande as referências.

Pode ser um valor único ou uma lista separada por vírgula (csv) de referências retornadas neste endpoint.

starting_after
string

Um cursor para uso na paginação. starting_after é um ID de objeto que define seu lugar na lista. Por exemplo, se você fizer uma solicitação de lista e receber 100 objetos, terminando com obj_foo, sua chamada subsequente poderá incluir starting_after=obj_foo para buscar a próxima página da lista.

ending_before
string

Um cursor para uso na paginação. starting_after é um ID de objeto que define seu lugar na lista. Por exemplo, se você fizer uma solicitação de lista e receber 100 objetos, terminando com obj_foo, sua chamada subsequente poderá incluir starting_after=obj_foo para buscar a próxima página da lista.

limit
integer
default: 10

Um limite no número de objetos a serem retornados. O limite pode variar entre 1 e 100, e o padrão é 10.

fields
string[]

Uma lista separada por vírgulas de atributos a serem incluídos na resposta. Isso pode ser usado para solicitar campos que normalmente não são retornados em uma resposta padrão.

Esteja ciente de que especificar este parâmetro terá o efeito que nenhum dos campos padrão seja retornado na resposta, a menos que seja explicitamente especificado.

Response

200 - application/json

Uma lista de empresas.

hasMore
boolean

Informa se existem mais itens. Os próximos itens podem ser obtidos informando o ID do último item no startingAfter.

data
object[]

Uma lista de empresas

Exportar parcelasObter empresa