Skip to content

List staff members

Request

Retrieve a paginated list of staff members for the account. Supports filtering by location, status, and practitioner status.

Security
PartnerApiKey and PartnerOAuth
Path
accountIdinteger, (int64)required

Account identifier

Query
locationIdinteger, (int64)

Filter by location ID

isPractitionerboolean

Filter by practitioner status. True returns only practitioners, false returns only non-practitioners.

statusstring(?i)ACTIVE|INACTIVE|PENDING

Filter by status (case-insensitive)

firstNamestring

Filter by first name (case-insensitive contains)

lastNamestring

Filter by last name (case-insensitive contains)

emailstring

Filter by email (case-insensitive contains)

cursorstring

Pagination cursor from previous response

limitinteger, (int32), [ 1 .. 1000 ]

Number of results per page (max 1000)

Default:20
Example:limit=20
curl -i -X GET \
  'https://api-docs.lobbie.com/_mock/openapi/partner/v2/account/{accountId}/staff?locationId=0&isPractitioner=true&status=string&firstName=string&lastName=string&email=string&cursor=string&limit=20' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Staff members retrieved successfully

Bodyapplication/json
nextCursorstring

Opaque cursor for fetching the next page. Null if no more results.

staffArray of objects(StaffDTO)

List of staff members in this page

Response
{
  "nextCursor": "string",
  "staff": [
    { … }
  ]
}