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
​
workspaceId
string
required
​
cursor
string
​
segmentFilter
string[]
​
limit
number
​
direction
Available options:
after
​
userIds
string[]

Unique identifier for the user. Should be the id of the user in your system. Only applicable to logged in users.

​
userPropertyFilter
object[]

Response

200
application/json
Default Response
​
users
object[]
required
​
userCount
number
required
​
previousCursor
string
​
nextCursor
string