v1

latestOpenAPI 3.1.02026-08-066378446.6 KB
Document Operations

List parties

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

Lists a document's parties.

See the Managing parties guide for information on working with parties.

get/documents/{document}/parties

Path parameters

documentstring required

The document UUID

Response

Array of DocumentPartyResource

Example response

{
  "data": [
    {
      "uuid": "595703a2-b7f6-4772-a4b7-ab2f9fac3a9f",
      "ref_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "reference": "Employer",
      "entity_name": "Demo Inc.",
      "address": "1 Oxford Road\nHenley Bridge\nHB1 1PQ",
      "signatories": [
        {
          "uuid": "76b8e0ad-e9cd-4c21-98b1-cd0003423ec2",
          "first_name": "Emily",
          "last_name": "Miller",
          "email": "miller@example.com",
          "mobile_phone": "+447951123456",
          "title": "Sales Manager",
          "profile_photo_url": "https://ui-avatars.com/api/?name=EM"
        }
      ]
    }
  ]
}