Get all staff members
Headers
-
Content-Type
string -
Accept
string -
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).
GET
/api/v1/client/{client_uuid}/staff-members
curl \
--request GET 'https://api.plannrcrm.com/api/v1/client/client_uuid/staff-members' \
--header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200)
{
"data": [
{
"uuid": "21430999-d0df-43a5-bf54-c438a060d4b3",
"account": {
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Gareth Thompson",
"role": "client",
"tags": "App\\Http\\Resources\\TagResource",
"type": "client",
"uuid": "1a07d3ce-fa4f-461b-b94e-d6dbad9e10c6",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-05-02T17:25:15+01:00",
"first_name": "Gareth",
"updated_at": "2025-05-02T17:25:15+01:00",
"with_login": true,
"inactive_at": "2025-05-02",
"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": "2025-05-02T17:25:15+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-05-02T17:25:15+01:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"joint_account_circle": "App\\Http\\Resources\\CircleResource",
"ownership_percentage": 100,
"previous_review_date": "2025-05-02T17:25:15+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-05-02T17:25:15+01: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": "2025-05-02T17:25:15+01:00",
"updated_at": "2025-05-02T17:25:15+01:00",
"payroll_number": "#12345",
"basic_annual_salary": {
"amount": 5000000,
"currency": "GBP",
"formatted": "£50,000.00"
}
}
]
}