Listar operadores

Retorna todos os operadores.

Os itens são retornados e ordenados por data de criação, com os itens mais recentes primeiro.

Authorizations

Authorization

string

header

required

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

Query Parameters

username

string

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

email

string

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

document

string

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

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.

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.

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

Um objeto com uma propriedade `data` que contém um array de itens começando após o item `starting_after`. Cada entrada no array é um objeto `Operator` separado. Se não houver mais itens, o array estará vazio. Essa solicitação nunca deve retornar um erro.

Uma lista de operadores.

hasMore

boolean

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

Example:

true

data

object[]

Uma lista de operadores

Este objeto representa um operador.

Show child attributes

data.id

string

Identificador exclusivo para o objeto.

Example:

"oprt_5f92f01728e009f403d8502e"

data.document

string

O documento do operador sem pontuação.

data.name

string

O nome completo do operador ou o nome da empresa.

data.email

string

O endereço de e-mail do operador.

data.username

string

Nome de usuário para login. Pode ser qualquer valor único.

data.permissions

object

Show child attributes

data.permissions.url

string

Example:

"/v1/permissions?operator=oprt_62d9889bd3985729e5a048ef&starting_after=perm_62d9889bd3985729e5a048ef"

data.permissions.hasMore

boolean

data.permissions.data

object[]

Este objeto representa uma permissão de um operador.

Show child attributes

data.permissions.data.company

string

required

O ID da companhia que o operador tem permissão para acessar. Para as roles do tipo financial, backoffice, backoffice_financial e administrator company pode assumir o valor * que representa todas as companhias.

Example:

"comp_62d9889bd3985729e5a048ef"

data.permissions.data.roles

enum<string>[]

required

Permissão do operador

Available options:

approver,

financial,

administrator,

backoffice,

backoffice_financial

data.permissions.data.id

string

Identificador exclusivo para o objeto.

Example:

"perm_62d9889bd3985729e5a048ef"

data.permissions.data.createdAt

string

Data de criação do objeto

Example:

"2023-08-25T22:38:41.134Z"

data.permissions.data.updatedAt

string

Data de alteração do objeto

Example:

"2023-08-25T22:38:41.134Z"

data.permissions.data.deleted

boolean

default:false

Identifica se o objeto foi excluído. Se verdadeiro, o objeto foi excluído.

Example:

false

data.metadata

object

Conjunto de pares de valores-chave que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado.

data.createdAt

string

Data de criação do objeto

Example:

"2023-08-25T22:38:41.134Z"

data.updatedAt

string

Data de alteração do objeto

Example:

"2023-08-25T22:38:41.134Z"

data.deleted

boolean

default:false

Identifica se o objeto foi excluído. Se verdadeiro, o objeto foi excluído.

Example:

false