Listar operadores

GET /v1/operators

Retorna todos os operadores, ordenados por data de criação, com os mais recentes primeiro.

Request

Query Parameters

username string

Filtra pelo campo username do operador. O valor deve ser uma string ou uma lista separada por vírgula.

Examples:

single
list

Valor único

Example: joao

Lista

Example: joao,maria

role string

Filtra por roles das permissões do operador. Use uma string ou lista separada por vírgula.

Examples:

single
list

Valor único

Example: approver

Lista

Example: approver,administrator

company string

Um filtro com base no campo company das permissões do operador.

Example: comp_630cb0ee859b8093501ef6ab

email string

Filtra por email do operador. Use uma string ou lista separada por vírgula.

Examples:

single
list

Valor único

Example: [email protected]

Lista

Example: [email protected],[email protected]

name string

Filtra por name do operador usando uma string, permitindo busca parcial.

Examples:

ByFullName
ByPartialName

Buscar operador pelo nome completo.

Example: John Doe

Buscar operador pelo nome parcial.

Example: John

document string

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

Examples:

single
list

Valor único

Example: 1245678900

Lista

Example: 01245678900,70975818082

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.

Example: obj_5f92f01728e009f403d8502e

ending_before string

Example: obj_5f92f01728e009f403d8502e

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.

Example: data.loan

limit integer

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

Default value: 10

Example: 10

fields string

Permite especificar quais campos devem ser incluídos ou excluídos na resposta. Utilize o nome do campo para incluí-lo, ou prefixe o nome com um sinal de menos (-) para excluí-lo. Pode ser um valor único ou uma lista separada por vírgula(csv). Funciona para campos expandidos.

Esteja ciente de que especificar um campo para inclusão, terá o efeito que nenhum dos campos padrão seja retornado na resposta, a menos que seja explicitamente especificado.

Importante: Não é permitido combinar inclusões e exclusões na mesma requisição. Uma tentativa de fazê-lo resultará em um erro.

Examples:

inclusao
exclusao

Retorna apenas os campos `id` e `createdAt`.

Example: id,createdAt

Retorna todos os campos, exceto `id`.

Example: -id

deleted boolean

Um filtro com base no campo deleted. O valor deve ser um booleano.

Example: true

Responses

Retorna um objeto com a propriedade data, contendo um array de objetos Operator a partir de starting_after. Se não houver mais itens, o array será vazio.

application/json

Schema
Example (from schema)

Schema

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

Array [

id string

Identificador exclusivo para o objeto.

Example: oprt_5f92f01728e009f403d8502e

document string

O documento do operador sem pontuação.

name string

O nome completo do operador ou o nome da empresa.

email string

O endereço de e-mail do operador.

username string

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

permissions

object

url uri

Example: /v1/permissions?operator=oprt_62d9889bd3985729e5a048ef&starting_after=perm_62d9889bd3985729e5a048ef

hasMore boolean

data

object[]

Array [

id string

Identificador exclusivo para o objeto.

Example: perm_62d9889bd3985729e5a048ef

company stringrequired

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

Example: comp_62d9889bd3985729e5a048ef

roles string[]required

Possible values: [approver, financial, administrator, backoffice, backoffice_financial, backoffice_automation]

createdAt date-time

Data de criação do objeto

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

updatedAt date-time

Data de alteração do objeto

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

deleted boolean

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

Default value: false

Example: false

createdBy

object

clientId string

Identificador do cliente que criou a assinatura.

Example: client_identifier

externalClientId string

Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição. Populado pelo campo enviado no header base39-external-client-id.

app string

Nome da aplicação que criou a assinatura.

Example: backoffice

updatedBy

object

clientId string

Identificador do cliente que criou a assinatura.

Example: client_identifier

externalClientId string

Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição. Populado pelo campo enviado no header base39-external-client-id.

app string

Nome da aplicação que criou a assinatura.

Example: backoffice

]

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.

createdAt date-time

Data de criação do objeto

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

updatedAt date-time

Data de alteração do objeto

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

deleted boolean

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

Default value: false

Example: false

createdBy

object

clientId string

Identificador do cliente que criou a assinatura.

Example: client_identifier

externalClientId string

Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição. Populado pelo campo enviado no header base39-external-client-id.

app string

Nome da aplicação que criou a assinatura.

Example: backoffice

updatedBy

object

clientId string

Identificador do cliente que criou a assinatura.

Example: client_identifier

externalClientId string

Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição. Populado pelo campo enviado no header base39-external-client-id.

app string

Nome da aplicação que criou a assinatura.

Example: backoffice

]

{
  "hasMore": true,
  "data": [
    {
      "id": "oprt_5f92f01728e009f403d8502e",
      "document": "string",
      "name": "string",
      "email": "string",
      "username": "string",
      "permissions": {
        "url": "/v1/permissions?operator=oprt_62d9889bd3985729e5a048ef&starting_after=perm_62d9889bd3985729e5a048ef",
        "hasMore": true,
        "data": [
          {
            "id": "perm_62d9889bd3985729e5a048ef",
            "company": "comp_62d9889bd3985729e5a048ef",
            "roles": [
              "approver"
            ],
            "createdAt": "2023-08-25T22:38:41.134Z",
            "updatedAt": "2023-08-25T22:38:41.134Z",
            "deleted": false,
            "createdBy": {
              "clientId": "client_identifier",
              "externalClientId": "string",
              "app": "backoffice"
            },
            "updatedBy": {
              "clientId": "client_identifier",
              "externalClientId": "string",
              "app": "backoffice"
            }
          }
        ]
      },
      "metadata": {},
      "createdAt": "2023-08-25T22:38:41.134Z",
      "updatedAt": "2023-08-25T22:38:41.134Z",
      "deleted": false,
      "createdBy": {
        "clientId": "client_identifier",
        "externalClientId": "string",
        "app": "backoffice"
      },
      "updatedBy": {
        "clientId": "client_identifier",
        "externalClientId": "string",
        "app": "backoffice"
      }
    }
  ]
}

Listar operadores

/v1/operators

Request​

Query Parameters

Responses​

Request

Responses