v1

latestOpenAPI 3.1.02026-08-066378446.6 KB

Document Operations

List document users

<small>Requires an API token with the Document Reader role.</small>

Lists a document's document users - everyone who has access to the document, each with their access level (role). Users who are also signatories appear here with is_signatory set to true; their signing details are available via the List signatories endpoint.

get/documents/{document}/users

Path parameters

documentstring required

The document UUID

Query parameters

role'owner' | 'collaborator' | 'viewer'

The representation of a document user's access level in the external API. Internally the access level is held in the document user's roles (where a plain viewer simply has no role); the external API always exposes it as one of these three values.

Only return document users with this role

Response

Array of DocumentUserResource

Example response

{
  "data": [
    {
      "uuid": "76b8e0ad-e9cd-4c21-98b1-cd0003423ec2",
      "first_name": "Emily",
      "last_name": "Miller",
      "email": "miller@example.com",
      "title": "Sales Manager",
      "party_uuid": "595703a2-b7f6-4772-a4b7-ab2f9fac3a9f",
      "personal_link": {
        "uuid": "5cbe6ed1-49a9-40dc-a1c4-9e5a3c9a08f0",
        "url": "https:app.fynk.com/share/5cbe6ed1-49a9-40dc-a1c4-9e5a3c9a08f0?token=...",
        "expires_at": "2026-10-19T12:00:00Z",
        "message": "Hi Emily, please review the updated contract."
      }
    }
  ]
}