API Reference
POST /api/admin/users/
API Reference
- POSTPOST /api/public/apps/identify
- POSTPOST /api/public/apps/track
- POSTPOST /api/public/apps/page
- POSTPOST /api/public/apps/screen
- POSTPOST /api/public/apps/batch
- POSTPOST /api/public/webhooks/segment
- GETGET /api/admin/content/templates
- PUTPUT /api/admin/content/templates
- DELDELETE /api/admin/content/templates
- GETGET /api/admin/segments/
- PUTPUT /api/admin/segments/
- DELDELETE /api/admin/segments/
- GETGET /api/admin/user-properties/
- PUTPUT /api/admin/user-properties/
- DELDELETE /api/admin/user-properties/
- GETGET /api/admin/journeys/
- PUTPUT /api/admin/journeys/
- DELDELETE /api/admin/journeys/
- PUTPUT /api/public/subscription-management/user-subscriptions
- GETGet /api/admin/users/subscriptions
- POSTPOST /api/admin/users/
- DELDELETE /api/admin/users/
- GETGET /api/admin/events/
- POSTPOST /api/admin/broadcasts/execute
- PUTPUT /api-l/admin/workspaces/child
- DELDELETE /api-l/admin/workspaces
- GETGET /api-l/admin/workspaces/
- POSTPOST /api-l/sessions/
API Reference
POST /api/admin/users/
Get list of users
POST
/
api
/
admin
/
users
curl --request POST \
--url http://localhost:3001/api/admin/users/ \
--header 'Content-Type: application/json' \
--data '{
"cursor": "<string>",
"segmentFilter": [
"<string>"
],
"limit": 123,
"direction": "after",
"userIds": [
"1043"
],
"userPropertyFilter": [
{
"id": "<string>",
"values": [
"<string>"
]
}
],
"workspaceId": "<string>"
}'
{
"users": [
{
"id": "<string>",
"properties": {},
"segments": [
{
"id": "<string>",
"name": "<string>"
}
]
}
],
"previousCursor": "<string>",
"nextCursor": "<string>",
"userCount": 123
}
Body
application/json
Available options:
after
Response
200
application/json
Default Response
curl --request POST \
--url http://localhost:3001/api/admin/users/ \
--header 'Content-Type: application/json' \
--data '{
"cursor": "<string>",
"segmentFilter": [
"<string>"
],
"limit": 123,
"direction": "after",
"userIds": [
"1043"
],
"userPropertyFilter": [
{
"id": "<string>",
"values": [
"<string>"
]
}
],
"workspaceId": "<string>"
}'
{
"users": [
{
"id": "<string>",
"properties": {},
"segments": [
{
"id": "<string>",
"name": "<string>"
}
]
}
],
"previousCursor": "<string>",
"nextCursor": "<string>",
"userCount": 123
}