List Observers

GET 
/agreements/:agreement_id/observers

Lists all observers for the agreement. The observers are returned in the order they were created.

Request

Path Parameters

agreement_id cuidrequired

GET /agreements/:agreement_id/observers parameter

Responses

200

GET /agreements/:agreement_id/observers 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 observer resource.

resource_type stringrequired

Possible values: [observer]

Data contains the observer resource.

data object[]required
Array [
id cuidrequired
The unique identifier of the observer
resource_type stringrequired
Possible values: [observer]
name stringnullablerequired
The name of the observer. Required if no email is provided.
email stringnullablerequired
The email of the observer. Required if agreement is configured to send emails or if the observer_scope is 'cc'.
observer_scope object required
The scope of the observer. If specified as viewer, they will gain access to the signing room to follow the process. Otherwise, they will only receive the final, signed document.
oneOf
MOD1
string
MOD2
string
agreement cuidrequired
The unique identifier for the agreement this observer belongs to
signing_room_url urlnullablerequired
The URL to the signing room for the observer. Only available after the agreement is not in draft.
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": "observer",
  "data": [
    {
      "id": "cdzpdorii4avtx7gvmiexample",
      "resource_type": "observer",
      "name": "Jane Doe",
      "email": "jane.doe@example.com",
      "observer_scope": "cc",
      "agreement": "coenaybsp9nym2cgbfzexample",
      "signing_room_url": "https://www.zigned.se/sign/cop0ia9liqgukxrzjmpexample/cm2imfnwoclvp5sqn9sexample",
      "created_at": "2024-01-01T00:00:00.000Z",
      "updated_at": "2024-01-01T00:00:00.000Z"
    }
  ]
}

400

GET /agreements/:agreement_id/observers 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...