Get a staff member

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

Personal access token & O auth2

Headers

X-PLANNR-ACCOUNT-UUID string

Path parameters

client_uuid string Required

uuid The UUID of the business client.
uuid integer Required
id string Required

uuid The UUID of the client that is a staff member.

Responses

200 application/json
Hide response attributes Show response 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
  
  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
  
  ownership_percentage integer
  
  inactive_at string
  
  custom_fields string
  
  external_references string

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

curl \
 --request GET 'https://api.plannrcrm.com/api/v1/client/6ff8f7f6-1eb3-3525-be4a-3932c805afed/staff-members/6ff8f7f6-1eb3-3525-be4a-3932c805afed' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"

Response examples (200)

{
  "uuid": "24023fb9-27e8-4e74-b3eb-801edd7642bd",
  "account": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "b8baccca-3965-4202-8647-f04806010501",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2025-06-25T15:10:42+01:00",
    "first_name": "Gareth",
    "updated_at": "2025-06-25T15:10:42+01:00",
    "with_login": true,
    "inactive_at": "2025-06-25",
    "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-06-25T15:10:42+01:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2025-06-25T15:10:42+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-06-25T15:10:42+01:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2025-06-25T15:10:42+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-06-25T15:10:42+01:00",
  "updated_at": "2025-06-25T15:10:42+01:00",
  "payroll_number": "#12345",
  "basic_annual_salary": {
    "amount": 5000000,
    "currency": "GBP",
    "formatted": "£50,000.00"
  }
}