Staff API

Manage workspace staff members and their permissions using the Staff API endpoints.

---

Endpoints

1. List/Search Staff

GET /v1/staffs

• Description: Retrieve a list of staff members with optional filtering and search.
• Authentication: Requires x-api-key header.

Query Parameters:

Name	In	Type	Required	Description
workspaceId	query	string	No	Filter by workspace ID
limit	query	string	No	Max number of results
page	query	string	No	Page number for pagination
searchText	query	string	No	Free text search
x-api-key	header	string	Yes	API authentication key

Response: [200 OK] - Array of Staff

---

2. Get Staff by ID

GET /v1/staffs/{staffId}

• Description: Retrieve a staff member by their unique ID.
• Authentication: Requires x-api-key header.

Path Parameters:

Name	In	Type	Required	Description
staffId	path	string	Yes	Staff unique ID
x-api-key	header	string	Yes	API authentication key

Response: [200 OK] - Staff

---

Schemas

Staff Schema

{
  "id": "string",
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "countryCode": "string",
  "phone": "string",
  "active": true,
  "workspaces": ["string"]
}

Staffs Schema

[
  { /* Staff object */ }
]