Get all signature transactions

GET /api/v1/document-signing

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 transactions which have these client on. Comma separated list of client 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).

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
    • data array[object]

      Additional properties are allowed.
GET /api/v1/document-signing 
curl \
 -X GET https://api.plannrcrm.com/api/v1/document-signing \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -H "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200) 
{
  "data": [
    {
      "name": 1000243230,
      "uuid": "e601746d-786b-4277-b0ae-c0f0dc79ff18",
      "status": "pending",
      "documents": [
        {
          "name": "Welcome Pack",
          "uuid": "f5db6bfd-6167-4d33-bbe5-d9ad43f3d5bc",
          "status": "pending",
          "created_at": "2024-11-20T13:24:02+00:00",
          "updated_at": "2024-11-20T13:24:02+00:00",
          "alphatrust_id": 1000455612
        }
      ],
      "created_at": "2024-11-20T13:24:02+00:00",
      "updated_at": "2024-11-20T13:24:02+00:00",
      "launched_by": {
        "firm": "App\\Http\\Resources\\FirmResource",
        "name": "Gareth Thompson",
        "role": "client",
        "tags": "App\\Http\\Resources\\TagResource",
        "type": "client",
        "uuid": "2888b544-a61b-43b1-8241-425ec414f134",
        "email": "gareth@codepotato.co.uk",
        "groups": "App\\Http\\Resources\\GroupResource",
        "owners": "App\\Http\\Resources\\AccountResource",
        "last_name": "Thompson",
        "created_at": "2024-11-20T13:24:02+00:00",
        "first_name": "Gareth",
        "updated_at": "2024-11-20T13:24:02+00:00",
        "with_login": true,
        "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": "2024-11-20T13:24:02+00:00",
        "has_joint_account": true,
        "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
        "first_contact_date": "2024-11-20T13:24:02+00:00",
        "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
        "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
        "previous_review_date": "2024-11-20T13:24:02+00:00",
        "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
        "assigned_administrator": "App\\Http\\Resources\\AccountResource",
        "anniversary_review_date": "2024-11-20T13:24:02+00:00"
      },
      "participants": [
        {
          "name": "Gareth Thompson",
          "uuid": "a9f5beaf-2ca7-4aed-ac7c-95a400df3572",
          "status": "pending",
          "created_at": "2024-11-20T13:24:02+00:00",
          "updated_at": "2024-11-20T13:24:02+00:00",
          "alphatrust_id": 1000145124
        }
      ]
    }
  ]
}