v1

latestOpenAPI 3.0.0proprietary2026-07-261695971.5 MB
Workflow Session

Generate Workflow Session Links

Generates portal links for all Applicants in a given Workflow Session.

get/workflow_sessions/{workflowSessionId}/links

Path parameters

workflowSessionIdstring uuid required

The unique identifier for a resource.

Example:9a93d3b5-fb3b-4abf-9e70-26315b33506c

Workflow Session Id

Response

OK

Example response

{
  "applicants": [
    {
      "id": "9a93d3b5-fb3b-4abf-9e70-26315b33506c",
      "workflow_session_id": "0ef334d2-7f36-4643-8a2a-4283b4a3e4a4",
      "workflow_session_link_url": "https://portal.yousign.app/workflow_sessions/abc123",
      "workflow_session_link_expires_at": "2024-01-25T22:59:00Z",
      "status": "notified",
      "label": "John Doe",
      "created_at": "2024-01-18T22:59:00Z",
      "updated_at": "2024-01-18T22:59:00Z",
      "type": "natural_person"
    }
  ]
}