POST
/
list_users
curl --request POST \
  --url https://api.carbon.ai/list_users \
  --header 'Content-Type: application/json' \
  --header 'authorization: <api-key>' \
  --data '{
  "pagination": {
    "limit": 10,
    "offset": 0,
    "starting_id": 0
  },
  "filters": {},
  "order_by": "created_at",
  "order_dir": "desc",
  "include_count": false
}'
{
  "users": [
    {
      "id": 123,
      "organization_id": 123,
      "organization_supplied_user_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "deleted_at": "2023-11-07T05:31:56Z",
      "enabled_features": {},
      "custom_limits": {},
      "auto_sync_enabled_sources": []
    }
  ],
  "count": 123
}

Authorizations

authorization
string
header
required

Bearer <token>, corresponds to API keys.

Body

application/json
pagination
object
filters
object
order_by
enum<string>
Available options:
created_at,
updated_at
order_dir
enum<string>
Available options:
asc,
desc
include_count
boolean
default:
false

Response

200
application/json
Successful Response
users
object[]
required
count
integer | null