Garrigues Signature Manager - Observers Operations

Introduction

This section covers all operations related to managing observers for a document in a signature request.

Operations

Get list of observers

This endpoint retrieves a list of observers associated with a specific document in a signature request.

HTTP Request

GET /api/v1/private/signature-requests/{signatureRequestId}/documents/{documentId}/observers

Example Response

[
  {
    "id": "950fac7e-5284-42ad-8044-3f4632678324",
    "name": "Observer Name",
    "surnames": "Observer Surnames",
    "email": "observer@example.com"
  }
]

Where

Parameter Mandatory Datatype Description
signatureRequestId Yes string (UUID) Unique identifier for the signature request.
documentId Yes string (UUID) Unique identifier for the document.
ids No array of string (UUID) Filter observers by their IDs.
emails No array of string Filter observers by their email addresses.
page No integer Page number for pagination.
size No integer Number of items per page.
sort No array of string Sorting criteria in the format field:order.

Create observer

This endpoint creates an observer for a document in a signature request.

HTTP Request

POST /api/v1/private/signature-requests/{signatureRequestId}/documents/{documentId}/observers

Example Request Body

{
  "name": "Observer Name",
  "surnames": "Observer Surnames",
  "email": "observer@example.com"
}

Where

Parameter Mandatory Datatype Description
signatureRequestId Yes string (UUID) Unique identifier for the signature request.
documentId Yes string (UUID) Unique identifier for the document.
name Yes string Observer name.
surnames No string Observer surnames.
email Yes string (email) Observer email address.

Error: 400 Bad request | 500 Unexpected error

Update observer

This endpoint updates an observer.

HTTP Request

PATCH /api/v1/private/signature-requests/{signatureRequestId}/documents/{documentId}/observers/{observerId}

Example Request Body

{
  "name": "Updated Observer",
  "surnames": "Observer Surnames",
  "email": "observer@example.com"
}

Where

Parameter Mandatory Datatype Description
signatureRequestId Yes string (UUID) Unique identifier for the signature request.
documentId Yes string (UUID) Unique identifier for the document.
observerId Yes string (UUID) Unique identifier for the observer.
name No string Updated observer name.
surnames No string Updated observer surnames.
email No string (email) Updated observer email address.

Error: 400 Bad request | 422 Signature request status should be draft or observer existing in this document | 500 Unexpected error

Delete observer

This endpoint deletes an observer.

HTTP Request

DELETE /api/v1/private/signature-requests/{signatureRequestId}/documents/{documentId}/observers/{observerId}

Error: 400 Bad request | 500 Unexpected error