Authentication

The WorkPulse API uses API keys to authenticate requests. You can view and manage your API keys in the WorkPulse Dashboard.

Header Format
Authorization: Bearer YOUR_API_KEY

Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.

List all Users

Returns a list of users within your organization. The users are returned sorted by creation date, with the most recent users appearing first.

GET/v1/users

Query Parameters

limitoptional

A limit on the number of objects to be returned. Default is 20.

integer
roleoptional

Filter by user role (admin, manager, developer).

string
Request Example

curl -X GET \

  "https://api.workpulse.com/v1/users" \

  -H "Authorization: Bearer YOUR_API_KEY" \

  -H "Content-Type: application/json"

Response Body

{

"object": "list",

"data": [

{

"id": "usr_9a2b3c4d5e",

"name": "Alex Rivera",

"role": "admin"

},

...

]

}