Documents

Document roles

GET
/v1/workspaces/{workspace_id}/document-roles

The roles the workspace’s documents name (Client signer, Employee, its own), the keys PATCH /envelopes/{id} matches recipients by. Hidden ones are left out.

Authorization

bearer
headerAuthorizationBearer <token>

An access token from /v1/auth/token, or a personal token: opaque, beginning s2a_.

Path Parameters

workspace_id*string

wsp_…, from GET /v1/me

Lengthlength <= 40

Response Body

The roles the workspace’s documents name, the hidden ones left out

application/json
  1. response

The roles the workspace’s documents name, the hidden ones left out

data*array<>
curl -X GET 'https://api.sign2approve.com/v1/workspaces/string/document-roles'
{  "data": [    {      "key": "client_signer",      "name": "Client signer",      "description": "Signs for a client.",      "starter": true,      "group": "clients",      "in_use": true    }  ]}