Documents

Uma lista de documentos.

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