Users | Product Docs

List users (admin)

get

/users

Authorizations

Query parameters

pageintegerOptionalDefault: 1

Responses

200

List

application/json

get

/users

GET /v1/users HTTP/1.1
Host: api.haloproject.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

List

[
  {
    "id": "text",
    "email": "text",
    "created_at": "2025-10-26T00:18:15.947Z",
    "consent": true
  }
]

Create a user (consented data subject)

post

/users

Authorizations

Body

emailstring · emailRequired

consentbooleanRequired

Consent to data processing

Responses

201

Created

application/json

post

/users

POST /v1/users HTTP/1.1
Host: api.haloproject.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 97

{
  "email": "[email protected]",
  "consent": true,
  "profile": {
    "age": 1,
    "gender": "text",
    "handedness": "text"
  }
}

201

Created

{
  "id": "text",
  "email": "text",
  "created_at": "2025-10-26T00:18:15.947Z",
  "consent": true
}

Get user

get

/users/{userId}

Authorizations

Path parameters

userIdstringRequired

Responses

200

User

application/json

get

/users/{userId}

GET /v1/users/{userId} HTTP/1.1
Host: api.haloproject.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

User

{
  "id": "text",
  "email": "text",
  "created_at": "2025-10-26T00:18:15.947Z",
  "consent": true
}