Skip to main content
GET
/
v1
/
users
List organization users
curl --request GET \
  --url https://api.example.com/v1/users \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "organizationMembershipId": "987e6543-e21b-45d3-b678-426614174001",
      "email": "john.doe@example.com",
      "role": "MEMBER",
      "status": "ACTIVE",
      "firstName": "John",
      "lastName": "Doe"
    }
  ],
  "total": 100,
  "page": 1,
  "limit": 10,
  "totalPages": 10
}

Authorizations

​
Authorization
string
header
required

Enter your API Key (sk_live_xxx or sk_test_xxx)

Query Parameters

​
page
number
default:1

Page number (1-indexed)

Required range: x >= 1
Example:

1

​
limit
number
default:50

Number of items per page

Required range: 1 <= x <= 100
Example:

50

Response

Paginated list of users

​
data
object[]
required

Array of users

​
total
number
required
Example:

100

​
page
number
required
Example:

1

​
limit
number
required
Example:

10

​
totalPages
number
required
Example:

10