v2

latestOpenAPI 3.0.12026-07-262352981007.0 KB

Staff

Search firm staff members

Retrieves a paginated list of staff members (filtered based on search parameters provided) in the firm associated with the authenticated client.

get/staff

Query parameters

Offsetinteger

Limitinteger

Searchstring[]

Available fields: email, name

Fieldsstring

Available fields: rate

Response

When request is successful. Returns a paged collection of 'Staff' objects.

idstring nullable

hrefstring nullable

relationstring nullable

methodstring nullable

offsetinteger nullable

limitinteger nullable

sizeinteger

Example response

{
  "value": [
    {
      "id": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
      "versionId": "750eb5c5-ac0b-7d11-4997-e0ce9d8896c8",
      "title": "Mr",
      "firstName": "John",
      "lastName": "Smith",
      "initials": "JS",
      "phone": {
        "areaCode": "555",
        "number": "1234567"
      },
      "cell": {
        "areaCode": "555",
        "number": "1234567"
      },
      "email": "john.smith@brown.com",
      "role": "Bookkeeper",
      "rate": 150,
      "avatar": "https://example-avatar-url.com/image",
      "enabled": true,
      "userId": "14b5dd57-3681-420e-a483-4823424eef45",
      "colorFill": "#797d85",
      "colorStroke": "#64666a",
      "licenceNumbers": [
        {
          "state": "IL"
        }
      ]
    }
  ]
}