Get all staff members

GET /api/v1/client/{client_uuid}/staff-members

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]

      Additional properties are allowed.
GET /api/v1/client/{client_uuid}/staff-members 
curl \
 -X GET https://api.plannrcrm.com/api/v1/client/client_uuid/staff-members \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -H "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200) 
{
  "data": [
    {
      "uuid": "7d5136fe-745b-4af9-8a3b-f44a481d1203",
      "account": {
        "firm": "App\\Http\\Resources\\FirmResource",
        "name": "Gareth Thompson",
        "role": "client",
        "tags": "App\\Http\\Resources\\TagResource",
        "type": "client",
        "uuid": "a8536d70-f534-4792-abed-6acd4605f989",
        "email": "gareth@codepotato.co.uk",
        "groups": "App\\Http\\Resources\\GroupResource",
        "owners": "App\\Http\\Resources\\AccountResource",
        "last_name": "Thompson",
        "created_at": "2024-12-03T16:50:31+00:00",
        "first_name": "Gareth",
        "updated_at": "2024-12-03T16:50:31+00:00",
        "with_login": true,
        "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
        "introduced_by": "App\\Http\\Resources\\AccountResource",
        "primary_email": "App\\Http\\Resources\\ContactDetailResource",
        "can_be_deleted": "false",
        "assigned_adviser": "App\\Http\\Resources\\AccountResource",
        "next_review_date": "2024-12-03T16:50:31+00:00",
        "has_joint_account": true,
        "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
        "first_contact_date": "2024-12-03T16:50:31+00:00",
        "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
        "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
        "previous_review_date": "2024-12-03T16:50:31+00:00",
        "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
        "assigned_administrator": "App\\Http\\Resources\\AccountResource",
        "anniversary_review_date": "2024-12-03T16:50:31+00:00"
      },
      "left_at": "2025-01-15T00:00:00+00:00",
      "hired_at": "2018-01-15T00:00:00+00:00",
      "job_title": "Chief Coffee Maker",
      "created_at": "2024-12-03T16:50:31+00:00",
      "updated_at": "2024-12-03T16:50:31+00:00",
      "payroll_number": "#12345",
      "basic_annual_salary": {
        "amount": 5000000,
        "currency": "GBP",
        "formatted": "£50,000.00"
      }
    }
  ]
}