ReadMe_ContractEventsResponse

Lista de eventos de um contrato

contractIdstring

Identificador do contrato

Exemplo ct-a1b2c3d4

events object[]

Lista de eventos do contrato

Lista [

eventIdstring

Identificador do evento

Exemplo evt-001

eventTypestring

Tipo do evento

Exemplo CONTRACT_CREATED

descriptionstring

Descrição do evento

Exemplo Contrato criado com sucesso

createdAtstring<date-time>

Data/hora do evento

Exemplo 2025-07-01T17:45:00Z

]

pagination object

Metadados de paginação baseada em cursor

currentItemstring

ID do item atual (primeiro da página)

Exemplo fe2cc560-036c-44cd-90e8-294d5a74cebc

limitinteger<int32>

Número de itens por página

Exemplo 30

nextItemstringaceita valor nulo

ID do próximo item (cursor para a próxima página)

Exemplo 22222222-2222-4222-8222-222222222222

totalItemsinteger<int64>

Total de itens disponíveis

Exemplo 150

links object[]

Links de navegação da API

Lista [

relstring

Relação do link com o recurso atual

Exemplo self

methodstring

Método HTTP do link

Exemplo GET

hrefstring

Caminho relativo do recurso

Exemplo /api/v2/companies

descriptionstring

Explicação em português do que este link permite fazer

Exemplo Cadastre a empresa para o cliente

]

ReadMe_ContractEventsResponse

{
  "contractId": "ct-a1b2c3d4",
  "events": [
    {
      "eventId": "evt-001",
      "eventType": "CONTRACT_CREATED",
      "description": "Contrato criado com sucesso",
      "createdAt": "2025-07-01T17:45:00Z"
    }
  ],
  "pagination": {
    "currentItem": "fe2cc560-036c-44cd-90e8-294d5a74cebc",
    "limit": 30,
    "nextItem": "22222222-2222-4222-8222-222222222222",
    "totalItems": 150
  },
  "links": [
    {
      "rel": "self",
      "method": "GET",
      "href": "/api/v2/companies",
      "description": "Cadastre a empresa para o cliente"
    }
  ]
}