Obter documentos

GET /v1/data-entities/:entity_name/documents

Retorna todos os documentos.

Request

Path Parameters

entity_name stringrequired

Nome da entidade

Example: motivos_de_cancelamento

Query Parameters

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

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

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

deleted boolean

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

Example: true

Responses

Objeto com data contendo um array de até um limite de documentos, começando após starting_after.

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 itens de documentos.

Array [

id string

Identificador exclusivo para o objeto.

Example: doc_5f92f01728e009f403d8502e

key string

Chave/Nome que será dado ao documento

Example: funcionario_desligado

value object

Valor/Objeto que deve corresponder ao schema da entidade, ao qual o documento está sendo inserido

Example: {}

dataEntity string

Id da entidade, ao qual o documento está relacionado

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