List employees
GET /v1/employees
Returns the employees in your workspace, one page at a time, sorted by name. The list includes terminated employees. It does not include deleted employees.
Requires a workspace API-client key with the employees:read scope.
Example request
Section titled “Example request”This example reads the first page of up to 25 employees. It does not change any records.
curl --request GET 'https://api.feedbackpulse.com/v1/employees?page=1&per_page=25' \ --header "Authorization: Bearer $FEEDBACKPULSE_API_KEY" \ --header 'Accept: application/json'Example response
Section titled “Example response”HTTP 200 OK
{ "data": [ { "id": "emp_01J9EXAMPLE", "name": "Alex Example", "email": "alex@example.com", "job_title": "Product Designer", "department": null, "employee_number": null, "type": "full-time", "employment_status": "active", "account_status": "not-invited", "access_status": "enabled", "is_manager": false, "hire_date": null, "termination_date": null, "created_at": "2026-11-02T09:00:00+00:00", "updated_at": "2026-11-02T09:00:00+00:00", "manager": null } ], "links": { "first": "https://api.feedbackpulse.com/v1/employees?page=1", "last": "https://api.feedbackpulse.com/v1/employees?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "from": 1, "last_page": 1, "path": "https://api.feedbackpulse.com/v1/employees", "per_page": 25, "to": 1, "total": 1 }}Request
Section titled “Request”Send the parameters in the query string. To read every employee, keep the same per_page and increase page by 1 until page equals meta.last_page.
Headers
Section titled “Headers”| Header | Required | Description |
|---|---|---|
Authorization |
Yes | Bearer API-client key with employees:read. |
Query parameters
Section titled “Query parameters”| Parameter | Type | Required | Description |
|---|---|---|---|
page |
integer | No | Page number to return, starting at 1. Default: 1. |
per_page |
integer | No | Number of employees per page. Range: 1–100. Default: 25. |
Response
Section titled “Response”A 200 response contains up to per_page employees in data. meta.total counts the employees on all pages. Use an employee id as the manager_id when you create an employee.
| Field | Type | Required | Description |
|---|---|---|---|
data |
array | Yes | |
data[].id |
string | Yes | Canonical public employee identifier, for example emp_01H.... |
data[].name |
string | Yes | |
data[].email |
string | Yes | Format: email. |
data[].job_title |
string or null | No | |
data[].department |
string or null | No | |
data[].employee_number |
string or null | No | |
data[].type |
string or null | No | |
data[].employment_status |
string | Yes | Values: active, terminated. |
data[].account_status |
string or null | Yes | Null means activation history is unknown for a legacy terminated employee. Values: not-invited, invited, active, null. |
data[].access_status |
string | Yes | Values: enabled, disabled. |
data[].is_manager |
boolean | Yes | |
data[].hire_date |
string or null | No | Format: date. |
data[].termination_date |
string or null | No | Format: date. |
data[].created_at |
string | Yes | Format: date-time. |
data[].updated_at |
string | Yes | Format: date-time. |
data[].manager |
object or null | No | |
data[].manager.id |
string | No | Canonical public employee identifier, for example emp_01H.... |
data[].manager.name |
string | No | |
meta |
object | Yes | |
meta.current_page |
integer | No | |
meta.from |
integer or null | No | |
meta.last_page |
integer | No | |
meta.path |
string | No | |
meta.per_page |
integer | No | |
meta.to |
integer or null | No | |
meta.total |
integer | No | |
links |
object | No |
Status codes
Section titled “Status codes”| HTTP status | Meaning |
|---|---|
200 |
Paginated employee list |
401 |
Missing or invalid bearer token |
403 |
Authenticated but lacking the required API client scope |
429 |
Rate limit exceeded |
See API errors and rate limits or download the OpenAPI contract.