User

User operations

get

List users, subject to attribute search criteria.

Authorizations

AuthorizationstringRequired

A registered Nexus211 app can use Basic Auth method to authenticate itself. The username is the app's Client ID and the password is Client Secret.

Query parameters

$limitnumberOptional

The number of records to be returned.

Default: 100

$skipnumberOptional

The number of records to be skipped for pagination.

Default: 0

$orderstringOptional

The order of the records. The result can be sorted by multiple attributes separated by a comma (,). Examples; name name asc name desc name,createdAt desc

$withstringOptional

Load related entities as objects.

attrib_namestringOptional

Filter records by attributes. The result can be filtered by any attribute of the entity. All request parameters not starting with $ are automatically used as a filter condition.

Extended filtering options are also available. See the table below.
Filter parameters that do not belong to the entity are silently ignored.
ISO-8601 formats are accepted for the date fields. The timezone will be set to UTC if not provided.
The separator for in and notin modifiers is the pipe character (|). Pipe characters can be escaped with a backslash in front of it.
Concat Like is to search for a string in two or more fields. It is only supported for JSON fields.

Description	GET Request Example
Exact Match	`name=john`
Not Equals (Exact Match)	`name:ne=john`
Is Null	`name=null`
Is Not Null	`name:ne=null`
Greater Than	`age:gt=5`, `birth:gt=1977-10-22T22:04:00`
Greater Than or Equal To	`age:gte=5`, `birth:gte=1977-10-22T22:04:00`
Less Than	`age:lt=3`, `birth:lt=2000-01-01T00:00:00`
Less Than or Equal To	`age:lte=3`, `birth:lte=2000-01-01T00:00:00`
Between	`age:bt=3,5`, `birth:bt=1977-10-22T22:04:00,2000-01-01T00:00:00`
In	status:in=value 1\|value 2\|value 3
Not In	status:notin=value 1\|value 2\|value 3
Like	`name:like=%john%`
Not Like	`name:notlike=%john%`
Concat Like(Only for JSON fields)	`firstName,lastName:concatlike=full name`

Responses

200

application/json

get

/user

GET /user HTTP/1.1
Authorization: Basic username:password
Accept: */*

200

{
  "__meta": {
    "total": 1,
    "perPage": 1,
    "currentLength": 1,
    "prevUrl": 1,
    "nextUrl": 1
  },
  "data": [
    {
      "firstName": "text",
      "lastName": "text",
      "email": "[email protected]",
      "password": "password",
      "access": "text",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "created_at": "2026-02-14",
      "updated_at": "2026-02-14"
    }
  ]
}

post

Create a new user

Authorizations

AuthorizationstringRequired

A registered Nexus211 app can use Basic Auth method to authenticate itself. The username is the app's Client ID and the password is Client Secret.

Body

firstNamestringRequired

lastNamestringRequired

emailstring · emailRequired

passwordstring · passwordRequired

accessstringRequired

Access level for the user (one of 'user', 'betatester', 'clientadmin', 'systemadmin', 'developer')

Responses

201

Created

No content

post

/user

POST /user HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 101

{
  "firstName": "text",
  "lastName": "text",
  "email": "[email protected]",
  "password": "password",
  "access": "text"
}

201

Created

No content

get

Read a user by ID

Authorizations

AuthorizationstringRequired

A registered Nexus211 app can use Basic Auth method to authenticate itself. The username is the app's Client ID and the password is Client Secret.

Path parameters

idstringRequired

Unique ID of the user to get

Responses

200

application/json

404

A user with the specified ID was not found.

get

/user/{id}

GET /user/{id} HTTP/1.1
Authorization: Basic username:password
Accept: */*

{
  "firstName": "text",
  "lastName": "text",
  "email": "[email protected]",
  "password": "password",
  "access": "text",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2026-02-14",
  "updated_at": "2026-02-14"
}

patch

Update an existing user

Authorizations

AuthorizationstringRequired

A registered Nexus211 app can use Basic Auth method to authenticate itself. The username is the app's Client ID and the password is Client Secret.

body

firstNamestringOptional

lastNamestringOptional

emailstringOptional

currentPasswordstringOptional

required when updating password

passwordstringOptional

Path parameters

idstringRequired

Unique ID of the user to update

Responses

200

application/json

404

A user with the specified ID was not found.

patch

/user/{id}

PATCH /user/{id} HTTP/1.1
Authorization: Basic username:password
Accept: */*

{
  "firstName": "text",
  "lastName": "text",
  "email": "[email protected]",
  "password": "password",
  "access": "text",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2026-02-14",
  "updated_at": "2026-02-14"
}

post

Authenticate a user given a set of credentials

Authorizations

AuthorizationstringRequired

A registered Nexus211 app can use Basic Auth method to authenticate itself. The username is the app's Client ID and the password is Client Secret.

body

emailstringRequired

email address of the user

passwordstringRequired

raw (user-supplied) password

Responses

200

application/json

401

Incorrect password for user

404

User with provided email address not found.

post

/user/authenticate

POST /user/authenticate HTTP/1.1
Authorization: Basic username:password
Accept: */*

{
  "firstName": "text",
  "lastName": "text",
  "email": "[email protected]",
  "password": "password",
  "access": "text",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2026-02-14",
  "updated_at": "2026-02-14"
}

post

Verifies user's email address

Authorizations

AuthorizationstringRequired

A registered Nexus211 app can use Basic Auth method to authenticate itself. The username is the app's Client ID and the password is Client Secret.

body

codestringRequired

verification secret provided to the user

Responses

200

application/json

400

Please provide a valid verification secret.

404

User not found or already verified.

post

/verify-email

POST /verify-email HTTP/1.1
Authorization: Basic username:password
Accept: */*

{
  "firstName": "text",
  "lastName": "text",
  "email": "[email protected]",
  "password": "password",
  "access": "text",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2026-02-14",
  "updated_at": "2026-02-14"
}

post

Sends a password reset link to the e-mail address

Authorizations

AuthorizationstringRequired

A registered Nexus211 app can use Basic Auth method to authenticate itself. The username is the app's Client ID and the password is Client Secret.

body

emailstringRequired

user's email address

Responses

200

E-mail sent

post

/password/reset/email

POST /password/reset/email HTTP/1.1
Authorization: Basic username:password
Accept: */*

200

E-mail sent

No content

post

Sends a password reset link to the e-mail address

Authorizations

AuthorizationstringRequired

A registered Nexus211 app can use Basic Auth method to authenticate itself. The username is the app's Client ID and the password is Client Secret.

body

emailstringRequired

user's email address

passwordstringRequired

new password for the user

tokenstringRequired

password reset token

Responses

200

E-mail sent

post

/password/reset

POST /password/reset HTTP/1.1
Authorization: Basic username:password
Accept: */*

200

E-mail sent

No content

PreviousTransaction NextModels

Last updated 9 days ago