Headers

• X-PLANNR-ACCOUNT-UUID string

Query parameters

• filter[uuid] string

  Filter by a comma separated list of UUIDs.

• filter[account_uuids] string

  Filter by a comma separated list of UUIDs.

• filter[circle_uuids] 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].

• filter[value] string

  Comma separated list of partial values to filter by.

• include string

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

• sort string

  Field to sort by. Valid fields are [created_at, updated_at, 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 attribute Show response attribute object

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

    • uuid string
    • created_at string
    • updated_at string
    • type string
    • name string
    • value string
    • phone_number_meta object
      Hide phone_number_meta attributes Show phone_number_meta attributes object

      • country string
      • formatted string
    • accounts object
      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
    • primary_accounts object
      Hide primary_accounts attributes Show primary_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