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[name] string

  Filter staff members by name. This is a partial match against first_name, last_name, and entity_name together.

• filter[active] string

  Filter active staff members. Use "true" to only show active staff members and "false" to only show inactive staff members.

• sort string

  Field to sort by. Valid fields are [created_at, updated_at, hired_at, left_at, first_name, last_name]. Negative sign to denote DESC. Defaults to 'first_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.

    • hired_at string

      Date (y-m-d) of when the staff member was hired.

    • left_at string

      Date (y-m-d) of when the staff member left.

    • job_title string

      The job title of the staff member.

    • basic_annual_salary object

      The basic annual salary of the staff member. Must be in pennies, for example: £50,000 would be 5000000.

      Hide basic_annual_salary attributes Show basic_annual_salary attributes object

      • amount integer
      • currency string
      • formatted string
    • payroll_number string

      The payroll number of the staff member.

    • account object

      Client account in Plannr.

      Hide account attributes Show account 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