Get a staff member

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

Path parameters

  • client_uuid string Required

    uuid The UUID of the business client.

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

    • payroll_number string

      The payroll number of the staff member.

    • account object

      Client account in Plannr.
GET /api/v1/client/{client_uuid}/staff-members/{id} 
curl \
 -X GET https://api.plannrcrm.com/api/v1/client/client_uuid/staff-members/id \
 -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) 
{
  "uuid": "1b89f25e-cde6-4c3f-8a4b-7deea62d7ecc",
  "account": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "e08b2d6c-4917-4f26-a643-16c88c809a8a",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2024-10-16T11:10:14+01:00",
    "first_name": "Gareth",
    "updated_at": "2024-10-16T11:10:14+01: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-10-16T11:10:14+01:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2024-10-16T11:10:14+01:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "previous_review_date": "2024-10-16T11:10:14+01:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2024-10-16T11:10:14+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": "2024-10-16T11:10:14+01:00",
  "updated_at": "2024-10-16T11:10:14+01:00",
  "payroll_number": "#12345",
  "basic_annual_salary": {
    "amount": 5000000,
    "currency": "GBP",
    "formatted": "£50,000.00"
  }
}