Skip to main content
GET
/
{organizationId}
/
users
Get users
curl --request GET \
  --url https://app.formbricks.com/api/v2/organizations/{organizationId}/users \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "id": "<string>",
      "createdAt": "2021-01-01T00:00:00.000Z",
      "updatedAt": "2021-01-01T00:00:00.000Z",
      "lastLoginAt": "2021-01-01T00:00:00.000Z",
      "isActive": true,
      "name": "John Doe",
      "email": "example@example.com",
      "role": "member",
      "teams": [
        "team1",
        "team2"
      ]
    }
  ],
  "meta": {
    "total": 123,
    "limit": 123,
    "offset": 123
  }
}

Authorizations

​
x-api-key
string
header
required

Use your Formbricks x-api-key to authenticate.

Path Parameters

​
organizationId
string
required

The ID of the organization

Query Parameters

​
limit
number
default:50

Number of items to return

Required range: 1 <= x <= 250
​
skip
number
default:0

Number of items to skip

Required range: x >= 0
​
sortBy
enum<string>
default:createdAt

Sort by field

Available options:
createdAt,
updatedAt
​
order
enum<string>
default:desc

Sort order

Available options:
asc,
desc
​
startDate
string

Start date

​
endDate
string

End date

​
filterDateField
enum<string>
default:createdAt

Date field to filter by

Available options:
createdAt,
updatedAt
​
id
string
​
email
string

Response

200 - application/json

Users retrieved successfully.

​
data
object[]
​
meta
object