Headers

• X-PLANNR-ACCOUNT-UUID string

Path parameters

• account_uuid string Required

Query parameters

• include string

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

• filter[uuid] string

  Filter by a comma separated list of UUIDs.

• filter[type] string

  Comma separated list of types to filter by. Valid filters are [email, phone_number].

• sort string

  Field to sort by. Valid fields are [created_at, updated_at, type, name, value]. 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 attributes Show response 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.

  • type string

    Contact detail type

  • name string

    Contact detail description

  • value string

    Contact detail value

  • phone_number_meta object

    If the type is a phone number, this additional field will be displayed giving you information about the phone number.

    Hide phone_number_meta attributes Show phone_number_meta attributes object

    • country string
    • formatted string
  • accounts object

    Accounts that own contact detail

    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
    • 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
    • circles string
    • ownership_percentage integer
    • inactive_at string
    • last_interaction_at string
    • referral_code string
    • custom_fields string
    • external_references string