Skip to main content
GET
/
users
List users
curl --request GET \
  --url https://api.heffl.com/api/v1/users \
  --header 'x-api-key: <api-key>'
{
  "items": [
    {
      "id": "<string>",
      "firstName": "<string>",
      "email": "<string>",
      "role": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "lastName": "<string>",
      "jobTitle": "<string>"
    }
  ],
  "hasMore": true,
  "nextCursor": "<string>"
}

Authorizations

​
x-api-key
string
header
required

API key for authentication. Get yours at app.heffl.com/settings/developers

Query Parameters

​
cursor
string

Cursor for pagination. Pass the previous response nextCursor value to fetch the next page.

​
limit
number
default:20

Number of items to return (max 100)

Required range: 1 <= x <= 100
​
search
string
default:""

Search by first name, last name, or email

​
active
boolean

Filter by active team membership status

Response

200 - application/json

OK

​
items
object[]
required
​
hasMore
boolean
required

Whether additional results are available

​
nextCursor
string | null

Cursor to fetch the next page. Null if there are no more results.