Skip to main content
GET
Retrieves the collection of UserOption resources.

Authorizations

Api-Token
string
header
required

Server-to-server authentication. Generate a token in the admin UI at Settings → Developers → API Access. Send the raw token in the Api-Token header — there is no Bearer prefix.

Tokens can be marked read-only at creation time, in which case the API rejects any non-GET request with 403 Forbidden.

Query Parameters

page
integer
default:1

The collection page number

itemsPerPage
integer
default:30

The number of items per page

Required range: 0 <= x <= 100
pagination
boolean

Enable or disable pagination

Response

200 - application/json

UserOption collection

id
integer
read-only
user
string<iri-reference>
Example:

"/api/v1/users/1"

createdAt
string<date-time>
read-only
updatedAt
string<date-time>
read-only
age
boolean | null
default:false
name
boolean | null
default:false
email
boolean | null
default:false
phone
boolean | null
default:false
social
boolean | null
default:false
image
boolean | null
default:false
town
boolean | null
default:false
profession
boolean | null
default:false
profile
boolean | null
default:false
hasSeenProfileCompletionCelebration
boolean | null
default:false