Skip to main content
GET
/
users
List all users
curl --request GET \
  --url http://localhost:3001/portal-api/users \
  --header 'Authorization: <api-key>'
[
  {
    "Active": true,
    "Email": "admin@acme.com",
    "First": "John",
    "Last": "Doe",
    "OrganisationID": 1,
    "Role": "consumer-team-member",
    "Provider": "password",
    "ID": 1
  }
]

Authorizations

​
Authorization
string
header
required

Query Parameters

​
limit
integer

Maximum number of records to return for this request. Overrides the row count only, not the page offset (which is always based on per_page), so use per_page for pagination rather than combining limit with page. Defaults to the per_page value.

​
per_page
integer
default:20

Items per page. Defaults to the resource-specific page count if configured, otherwise 20

​
page
integer
default:1

Page number. Defaults to 1 when omitted

Response

200 - application/json

OK

​
Active
boolean

Defines if this user is active and can login to the portal

Example:

true

​
Email
string

Email of a user

Example:

"admin@acme.com"

​
First
string

First name of a user

Example:

"John"

​
Last
string

Last name of a user

Example:

"Doe"

​
OrganisationID
integer

ID of an organisation where this user belongs to. For admin users it is always equal to 0

Example:

1

​
Role
string

Role of a user in their organisation

Example:

"consumer-team-member"

​
Provider
string

Type of identity provider for this user, e.g. password, github, etc.

Example:

"password"

​
ID
integer

UID of a user

Example:

1