curl --request GET \ --url 'https://app.output.rocks/api/spa/users?page=1&itemsPerPage=20&order%5Bid%5D=asc&order%5Bemail%5D=asc&order%5Bactive%5D=asc&order%5BcreatedAt%5D=asc&order%5BupdatedAt%5D=asc' \ --header 'X-AUTH-TOKEN: <api-key>'

[ { "id": 123, "email": "user@example.com", "roles": [ "string" ], "invalidRoleValues": [ "string" ], "adminNote": "string", "password": "string", "active": true, "lastLoginDate": "2024-08-23T00:00:00+00:00", "previousLoginDate": "2024-08-23T00:00:00+00:00", "releaseNotesDate": "2024-08-23T00:00:00+00:00", "authCode": "string", "locale": "en", "signature": "string", "sharePointEmail": "user@example.com", "client": {}, "subClient": {}, "createdBy": "user1@company.com", "updatedBy": "user1@company.com", "createdAt": "2024-08-23T00:00:00+00:00", "updatedAt": "2024-08-23T00:00:00+00:00", "userIdentifier": "string", "emailAuthEnabled": true, "emailAuthRecipient": "user@example.com", "emailAuthCode": "user@example.com", "subClientId": 3, "subClientDescription": "Branch Office A", "subClientColor": "#083E5D" } ]

SPA Users

SPA: Retrieves a paginated list of Users

Returns a paginated list of users for the authenticated user's client. Requires ROLE_ADMIN.

GET/api/spa/users

SPA: Retrieves a paginated list of Users

curl --request GET \
  --url 'https://app.output.rocks/api/spa/users?page=1&itemsPerPage=20&order%5Bid%5D=asc&order%5Bemail%5D=asc&order%5Bactive%5D=asc&order%5BcreatedAt%5D=asc&order%5BupdatedAt%5D=asc' \
  --header 'X-AUTH-TOKEN: <api-key>'

200

application/json

[
  {
    "id": 123,
    "email": "user@example.com",
    "roles": [
      "string"
    ],
    "invalidRoleValues": [
      "string"
    ],
    "adminNote": "string",
    "password": "string",
    "active": true,
    "lastLoginDate": "2024-08-23T00:00:00+00:00",
    "previousLoginDate": "2024-08-23T00:00:00+00:00",
    "releaseNotesDate": "2024-08-23T00:00:00+00:00",
    "authCode": "string",
    "locale": "en",
    "signature": "string",
    "sharePointEmail": "user@example.com",
    "client": {},
    "subClient": {},
    "createdBy": "user1@company.com",
    "updatedBy": "user1@company.com",
    "createdAt": "2024-08-23T00:00:00+00:00",
    "updatedAt": "2024-08-23T00:00:00+00:00",
    "userIdentifier": "string",
    "emailAuthEnabled": true,
    "emailAuthRecipient": "user@example.com",
    "emailAuthCode": "user@example.com",
    "subClientId": 3,
    "subClientDescription": "Branch Office A",
    "subClientColor": "#083E5D"
  }
]

Authorizations

X-AUTH-TOKEN

stringheaderrequired

Value for the X-AUTH-TOKEN header parameter.

Query Parameters

page

integerdefault:1

The collection page number

itemsPerPage

integerdefault:20

The number of items per page

pagination

boolean

Enable or disable pagination

string

No description provided.

active

boolean

No description provided.

order[id]

stringdefault:asc

No description provided.

order[email]

stringdefault:asc

No description provided.

order[active]

stringdefault:asc

No description provided.

order[createdAt]

stringdefault:asc

No description provided.

order[updatedAt]

stringdefault:asc

No description provided.

Response

200application/json

User collection

integer

string<email>

roles

string | null[]

invalidRoleValues

string | null[]

adminNote

string | null

password

string

active

boolean

Available options: truefalse

Example: true

lastLoginDate

string<date-time> | null

previousLoginDate

string<date-time> | null

releaseNotesDate

string<date-time> | null

authCode

string | null

locale

string

Example: "en"

signature

string | null

Personal signature image (base64 encoded PNG, without data-URI prefix).

sharePointEmail

string | null

Microsoft 365 account email used for SharePoint document editing when it differs from the application login email.

client

object

subClient

object

createdBy

string

User, created this entry

Example: "user1@company.com"

updatedBy

string

User, updated this entry

Example: "user1@company.com"

createdAt

string<date-time>

UTC date time of entry creation

Example: "2024-08-23T00:00:00+00:00"

updatedAt

string<date-time>

UTC date time of last entry update

Example: "2024-08-23T00:00:00+00:00"

userIdentifier

string

A visual identifier that represents this user.

emailAuthEnabled

boolean

Available options: truefalse

emailAuthRecipient

string

emailAuthCode

string

subClientId

integer

SubClient ID. Provided on instances with enabled sub-client module only.

Example: 3

subClientDescription

string

SubClient description. Provided on instances with enabled sub-client module only.

Example: "Branch Office A"

subClientColor

string

SubClient display colour. Provided on instances with enabled sub-client module only.

Example: "#083E5D"