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 account UUIDs.

• filter[group_uuids] string

  Filter by a comma separated list of group UUIDs.

• filter[name] string

  Filter by the circle name.

• include string

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

• sort string

  Field to sort by. Valid fields are [name, created_at, updated_at]. Negative sign to denote DESC. Defaults to 'name'.

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

    • name string

      The Circle name

    • photo_url string

      URL for initial avatar image

    • bg_colour string

      Hex colour background for avatar

    • accounts array[object]

      Accounts belonging to the circle

      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
      • custom_fields string
      • external_references string
    • groups array[object]

      Groups the circle belongs to

      Hide groups attributes Show groups attributes object

      • uuid string
      • name string
      • slug string
      • participants_count string
      • participants object
        Hide participants attributes Show participants attributes object

        • uuid object
          Hide uuid attributes Show uuid attributes object

          • example string
          • description string
        • role object
          Hide role attributes Show role attributes object

          • example string
          • description string
        • first_name object
          Hide first_name attributes Show first_name attributes object

          • example string
          • description string
        • last_name object
          Hide last_name attributes Show last_name attributes object

          • example string
          • description string
        • name object
          Hide name attributes Show name attributes object

          • example string
          • description string
        • email object
          Hide email attributes Show email attributes object

          • example string
          • description string
      • created_at string
      • updated_at string
    • joint_account_uuid string

      uuid of joint account where circle created from joint account

    • login_access_level string

      The access level in context of an account. Note this field is only returned when using the accounts API. Available values: read and write

    • external_references array[object]

      The external references that have been added to the client.

      Hide external_references attributes Show external_references attributes object

      • uuid string
      • created_at string
      • updated_at string
      • third_party string
      • reference string