Headers
-
Content-Type
string -
Accept
string -
X-PLANNR-ACCOUNT-UUID
string
Query parameters
-
filter[uuid]
string Filter by a comma separated list of UUIDs.
-
filter[date_from]
string Get signatures launched from a certain date.
-
filter[date_to]
string Get signatures launched to a certain date.
-
filter[status]
string Filter by transaction status. Valid options are [created, pending, complete, email_sent, closed, cancelled, expired, voided, failed].
-
filter[clients]
string Filter by a comma separated list of accounts UUIDs.
-
filter[account_uuids]
string Filter by a comma separated list of accounts UUIDs.
-
filter[circle_uuids]
string Filter by a comma separated list of circle UUIDs.
-
sort
string Field to sort by. Valid fields are [created_at, name]. Negative sign to denote DESC. Defaults to '-created_at'.
-
per_page
integer Number of results to return with pagination (Default 15. Max 500).
GET
/api/v1/document-signing
curl \
--request GET 'https://api.plannrcrm.com/api/v1/document-signing' \
--header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200)
{
"data": [
{
"name": 1000243230,
"uuid": "1a440250-e9d8-46fc-893a-bd9f3a6e8924",
"status": "pending",
"documents": [
{
"name": "Welcome Pack",
"uuid": "cc3c7f08-d3be-4dfe-bf29-a0141bcfb4ce",
"status": "pending",
"created_at": "2025-05-29T16:20:12+01:00",
"updated_at": "2025-05-29T16:20:12+01:00",
"alphatrust_id": 1000455612
}
],
"created_at": "2025-05-29T16:20:12+01:00",
"updated_at": "2025-05-29T16:20:12+01:00",
"launched_by": {
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Gareth Thompson",
"role": "client",
"tags": "App\\Http\\Resources\\TagResource",
"type": "client",
"uuid": "6ecf55a2-6b91-4c9a-8c1d-3d48e4c0be87",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-05-29T16:20:12+01:00",
"first_name": "Gareth",
"updated_at": "2025-05-29T16:20:12+01:00",
"with_login": true,
"inactive_at": "2025-05-29",
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"introduced_by": "App\\Http\\Resources\\AccountResource",
"primary_email": "App\\Http\\Resources\\ContactDetailResource",
"can_be_deleted": "false",
"assigned_adviser": "App\\Http\\Resources\\AccountResource",
"next_review_date": "2025-05-29T16:20:12+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-05-29T16:20:12+01:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"joint_account_circle": "App\\Http\\Resources\\CircleResource",
"ownership_percentage": 100,
"previous_review_date": "2025-05-29T16:20:12+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-05-29T16:20:12+01:00"
},
"participants": [
{
"name": "Gareth Thompson",
"uuid": "7254319e-86de-423a-bac5-98d580e42305",
"status": "pending",
"created_at": "2025-05-29T16:20:12+01:00",
"updated_at": "2025-05-29T16:20:12+01:00",
"alphatrust_id": 1000145124
}
]
}
]
}