List Agreement Events

GET 
/agreements/:agreement_id/events

Lists all events for the agreement (excluding specific events related to participants). The events are returned in ascending order by creation date. Events are read only.

Request

Path Parameters

agreement_id cuidrequired

GET /agreements/:agreement_id/events parameter

Responses

200

GET /agreements/:agreement_id/events Successful response

application/json

Schema

Schema

version stringrequired

Possible values: [1.0]

The version of the response schema

result_type stringrequired

Possible values: [list]

A non-paginated list of the agreement event resource.

resource_type stringrequired

Possible values: [agreement_event]

Data contains the agreement event resource.

data object[]required
Array [
id cuidrequired
The unique identifier of the agreement event
resource_type stringrequired
Possible values: [agreement_event]
agreement cuidrequired
The unique identifier of the agreement which this event belongs to
title stringrequired
Possible values: non-empty
The title of the agreement event
description stringrequired
Possible values: non-empty
The description of the agreement event
created_at stringrequired
UTC datetime ISO string
updated_at stringrequired
UTC datetime ISO string
]

Example (from schema)

{
  "version": "1.0",
  "result_type": "list",
  "resource_type": "agreement_event",
  "data": [
    {
      "id": "ccgepaxz5fyoks3ilmkexample",
      "resource_type": "agreement_event",
      "agreement": "cwn3kw0qrbzqwpkhowzexample",
      "title": "Completed validation of participants",
      "description": "Completed validation of all participants",
      "created_at": "2024-01-01T00:00:00.000Z",
      "updated_at": "2024-01-01T00:00:00.000Z"
    }
  ]
}

400

GET /agreements/:agreement_id/events Error response

application/json

Schema

Schema

status stringrequired

Possible values: [error]

error objectrequired
code int64required
Possible values: >= 400 and <= 599
message stringrequired
request_id uuidrequired

Example (from schema)

{
  "status": "error",
  "error": {
    "code": 0,
    "message": "string",
    "request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }
}

Loading...