Skip to main content

List all document recipients

Returns a list of your document recipients. The recipients are returned sorted by creation date, with the most recently created recipients appearing first.

Parameters​

No parameters.

Returns​

Return a paginated response that contains an array of up to the specified limit of recipients.

get
/api/documents/{id}/recipients
curl https://{workspace}.documocu.com/api/documents/{id}/recipients \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer {API_KEY}'
Response
{
  "data": [
    {
      "address": null,
      "city": null,
      "color": "#83f793",
      "contact": "con_itw5atndlebaj0wguoerhbpn",
      "country": null,
      "created_at": "2024-05-14T08:36:49+00:00",
      "email": "[email protected]",
      "first_name": "Brielle",
      "full_name": "Brielle Turner",
      "id": "1e3b4f50-10ba-3c60-83db-69ab768b8e53",
      "is_signer": false,
      "job_title": null,
      "last_name": "Turner",
      "organization": null,
      "passcode": null,
      "phone_number": null,
      "postal_code": null,
      "role": "Sender",
      "sent_at": null,
      "signed_at": null,
      "state": null,
      "updated_at": "2024-05-14T08:36:49+00:00",
      "viewed_at": null
    }
  ],
  "links": {
    "first": "https://{workspace}.documocu.com/api/documents/{id}/recipients?page=1",
    "last": "https://{workspace}.documocu.com/api/documents/{id}/recipients?page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "url": null,
        "label": "« Previous",
        "active": false
      },
      {
        "url": "https://{workspace}.documocu.com/api/documents/{id}/recipients?page=1",
        "label": "1",
        "active": true
      },
      {
        "url": null,
        "label": "Next »",
        "active": false
      }
    ],
    "path": "https://{workspace}.documocu.com/api/documents/{id}/recipients",
    "per_page": 20,
    "to": 1,
    "total": 1
  }
}