Users

List users

GET
Gets a list of users

Query parameters

emailstringOptional
Email of guest to return

Response

This endpoint returns an object
data
list of objects
Configurations for the user
GET
$curl -G https://api.x.flatfile.com/v1/users \
> -H "Authorization: Bearer <token>" \
> --data-urlencode email=john.smith@example.com
Response
1{
2 "data": [
3 {
4 "accountId": "us_acc_YOUR_ID",
5 "createdAt": "2023-10-30T16:59:45.735Z",
6 "email": "john.smith@example.com",
7 "id": "us_usr_YOUR_ID",
8 "idp": "FRONTEGG",
9 "metadata": {},
10 "name": "john.smith",
11 "updatedAt": "2023-10-30T16:59:45.735Z",
12 "dashboard": 2,
13 "idpRef": "ab1cf38e-e617-4547-b37d-376a7ac9e554",
14 "lastSeenAt": "2023-10-30T16:59:45.735Z"
15 }
16 ]
17}