Headers

• X-PLANNR-ACCOUNT-UUID string

Path parameters

• client_uuid string Required

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).

Responses

• 200 application/json
  Hide response attribute Show response attribute object

  • data array[object]
    Hide data attributes Show data attributes object

    • uuid string
    • created_at string
    • updated_at string
    • name integer
    • status string
    • participants array[object]
      Hide participants attributes Show participants attributes object

      • uuid string
      • created_at string
      • updated_at string
      • alphatrust_id integer
      • name string
      • status string
    • documents array[object]
      Hide documents attributes Show documents attributes object

      • uuid string
      • created_at string
      • updated_at string
      • alphatrust_id integer
      • name string
      • status string
    • launched_by object
      Hide launched_by attributes Show launched_by attributes object

      • uuid string
      • created_at string
      • updated_at string
      • type string
      • role string
      • first_name string
      • last_name string
      • name string
      • email string
      • firm string
      • primary_phone_number string
      • primary_email string
      • current_time_entry string
      • assigned_adviser string
      • assigned_administrator string
      • assigned_paraplanner string
      • introduced_by string
      • groups string
      • tags string
      • owners string
      • first_contact_date string
      • next_review_date string
      • previous_review_date string
      • anniversary_review_date string
      • with_login boolean
      • has_joint_account boolean
      • can_be_deleted string
      • joint_account_circle string
      • ownership_percentage integer
      • inactive_at string
      • custom_fields string
      • external_references string