LogoSignature Service
REST APISigning room users

List all signing room users

GET
/admin/api/v3/organizations/{organizationId}/rooms/{signingRoomId}/signatories

Authorization

basicAuth
AuthorizationBasic <token>

In: header

Path Parameters

organizationId*string
signingRoomId*string

Query Parameters

searchQuery?string

Search query to filter users by firstname, lastname or email

page?integer

Zero-based page index (0..N)

Formatint32
Default0
size?integer

The size of the page to be returned

Formatint32
Default2000
sortBy?string

Sort By

Default"lastname"

Value in

  • "firstname"
  • "lastname"
  • "email"
signingRoomPermissions?string

Signing Room permissions. If not provided all entries (including users with a pending invitation) are returned

Value in

  • "SIGNATORY"
  • "ASSISTANT"
  • "MANAGER"
sortDirection?string

Sort direction

Default"ASC"

Value in

  • "ASC"
  • "DESC"
Manager?boolean
Deprecated

Grant manager permissions to the signing room

Response Body

application/json

curl -X GET "https://example.com/admin/api/v3/organizations/string/rooms/string/signatories"
{  "content": [    {      "displayName": "string",      "email": "string",      "firstname": "string",      "id": "string",      "lastname": "string",      "locale": "string",      "manager": true,      "phoneNumber": "string",      "signatoryAttributes": [        {          "displayName": "string",          "key": "string",          "required": true,          "value": "string"        }      ],      "signingRoomPermission": "SIGNATORY",      "username": "string"    }  ],  "empty": true,  "first": true,  "last": true,  "number": 0,  "numberOfElements": 0,  "pageable": {    "offset": 0,    "pageNumber": 0,    "pageSize": 0,    "paged": true,    "sort": {      "empty": true,      "sorted": true,      "unsorted": true    },    "unpaged": true  },  "size": 0,  "sort": {    "empty": true,    "sorted": true,    "unsorted": true  },  "totalElements": 0,  "totalPages": 0}