Referral

Referral operations

get

Retrieve a list of referrals(subject to attribute search criteria)

Authorizations

BasicOAuth

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

OK

application/json

get

/referral

HTTPcURLJavaScriptPython

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

200

OK

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

post

Create a new referral

Authorizations

BasicOAuth

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

resourcestringRequired

transactionstringRequired

Body

application/json

objectOptional

Responses

201

Created

post

/referral

HTTPcURLJavaScriptPython

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

{}

201

Created

No content

get

Get a referral by ID

Authorizations

BasicOAuth

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 a referral

Responses

200

OK

application/json

404

A referral with the specified ID was not found.

get

/referral/{id}

HTTPcURLJavaScriptPython

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

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2026-02-14",
  "updated_at": "2026-02-14"
}

delete

Undo a referral

Authorizations

BasicOAuth

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.

Responses

204

The referral is deleted successfully.

delete

/referral/{id}

HTTPcURLJavaScriptPython

DELETE /referral/{id} HTTP/1.1
Authorization: Basic username:password
Accept: */*

204

The referral is deleted successfully.

No content

post

Share an existing referral with a network

Authorizations

BasicOAuth

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

referralstring · uuidRequired

networkstring · uuidRequired

Path parameters

idstringRequired

Referral ID

Responses

200

OK

application/json

404

A referral with the specified ID was not found.

post

/referral/{id}/share

HTTPcURLJavaScriptPython

POST /referral/{id}/share HTTP/1.1
Authorization: Basic username:password
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2026-02-14",
  "updated_at": "2026-02-14"
}

post

Revoke a shared referral from a network

Authorizations

BasicOAuth

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

referralstring · uuidRequired

networkstring · uuidRequired

Path parameters

idstringRequired

Referral ID

Responses

200

OK

application/json

404

A referral with the specified ID was not found.

post

/referral/{id}/unshare

HTTPcURLJavaScriptPython

POST /referral/{id}/unshare HTTP/1.1
Authorization: Basic username:password
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2026-02-14",
  "updated_at": "2026-02-14"
}