Skip to main content
GET
/
v1
/
users
List users
curl --request GET \
  --url https://api.folk.app/v1/users \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "items": [
      {
        "id": "usr_bc984b3f-0386-434d-82d7-a91eb6badd71",
        "fullName": "John Doe",
        "email": "john.doe@example.com"
      }
    ],
    "pagination": {
      "nextLink": "https://api.folk.app/v1/users?limit=20&cursor=eyJvZmZzZXQiOjIwfQ%3D%3D"
    }
  }
}

Authorizations

​
Authorization
string
header
required

API key for authentication

Query Parameters

​
limit
integer
default:20

The number of items to return.

Required range: 1 <= x <= 100
​
cursor
string

A cursor for pagination across multiple pages of results. Don’t include this parameter on the first call. Use the pagination.nextLink value returned in a previous response to request subsequent results.

Maximum length: 128

Response

A paginated list of users in the workspace. The data.items field contains the list of users, and the data.pagination.nextLink field contains a link to the next page of results, if available.

​
data
object
required
Example:
{
  "items": [
    {
      "id": "usr_bc984b3f-0386-434d-82d7-a91eb6badd71",
      "fullName": "John Doe",
      "email": "john.doe@example.com"
    }
  ],
  "pagination": {
    "nextLink": "https://api.folk.app/v1/users?limit=20&cursor=eyJvZmZzZXQiOjIwfQ%3D%3D"
  }
}
​
deprecations
string[]
Example:
["This field is deprecated"]