Headers

• X-PLANNR-ACCOUNT-UUID string

Path parameters

• client_uuid string Required

Query parameters

• include string

  Comma separated list of relationships to include in the response. Valid relationships are [accounts, shared_owner].

• filter[uuid] string

  Filter by a comma separated list of UUIDs.

• sort string

  Field to sort by. Valid fields are [created_at, updated_at, first_name, last_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

      The UUID of the resource.

    • created_at string

      The timestamp of when the resource was created.

    • updated_at string

      The timestamp of when the resource was updated.

    • first_name string

      The first name of the dependant.

    • last_name string

      The last name of the dependant.

    • name string

      The full name of the dependant. If known_as has been provided, the first name will be replaced with the known_as.

    • known_as string

      An optional nickname for the dependant.

    • relationship string

      The relationship of the dependant.

    • date_of_birth string

      The date of birth of the dependant.

    • is_financially_dependant boolean

      Denotes if the dependant is financially dependant on the client.

    • notes string

      Optional notes for the dependant.

    • accounts object

      Accounts that own this dependant.

      Hide accounts attributes Show accounts attributes object

      • uuid string
      • created_at string
      • updated_at string
      • type string
      • role string
      • first_name string
      • last_name string
      • name string
      • email string
      • photo_url string
      • external_references string
    • shared_owner_type string

      @deprecated Denotes if the dependant is shared across the client or belongs to one of the owners of the client. (Only applicable for joint/business/trust clients)

    • shared_owner object

      @deprecated The owner of the dependant. Only provided if the shared_owner_type is "individual".

      Hide shared_owner attributes Show shared_owner attributes object

      • uuid string
      • created_at string
      • updated_at string
      • type string
      • role string
      • first_name string
      • last_name string
      • name string
      • email string
      • photo_url 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
      • business_unit string
      • groups string
      • tags string
      • owners string
      • first_contact_date string
      • next_review_date string
      • previous_review_date string
      • anniversary_review_date string
      • terms_of_business_at string
      • client_agreement_at string
      • with_login boolean
      • has_joint_account boolean
      • can_be_deleted string
      • joint_account_circle string
      • circles string
      • ownership_percentage integer
      • inactive_at string
      • last_interaction_at string
      • referral_code string
      • permissions object
        Hide permissions attributes Show permissions attributes object

        • firm:read array[string]
        • network:read array[string]
      • custom_fields string
      • external_references string