Skip to main content
GET
/
api
/
v1
/
accounts
/
{account_id}
/
users
Get all users in account
curl --request GET \
  --url http://localhost:9001/api/v1/accounts/{account_id}/users \
  --header 'Authorization: Bearer <token>'
{
  "users": [
    {
      "id": "<string>",
      "email": "jsmith@example.com",
      "name": "<string>",
      "profile_pic_url": "<string>",
      "status": "ACTIVE",
      "is_verified": true,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "authentication_type": "google-oauth2",
      "authentication_partner": "AUTH0",
      "authentication_partner_id": "<string>"
    }
  ],
  "total": 5,
  "message": "Users retrieved successfully"
}

Authorizations

Authorization
string
header
required

JWT token from Auth0

Path Parameters

account_id
string
required

Account's external ID (format: acct-xxx-v1)

Example:

"acct-xyz789-v1"

Response

Users retrieved successfully

users
object[]
total
integer

Total number of users

Example:

5

message
string
Example:

"Users retrieved successfully"