Profile

Profile operations

get

List profiles, 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

$withSurveyany ofOptional

Set to true to include demographic survey responses. Set to a survey ID to include responses for a specific survey.

booleanOptional

or

stringOptional

$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

/profile

HTTPcURLJavaScriptPython

GET /profile 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",
    "role": "text",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "metadata": {}
  }
}

post

Create a new profile

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

application/json

rolestringRequired

the role of the user in the organization

organizationstring · uuidRequired

metadataobjectOptional

Responses

201

Created

post

/profile

HTTPcURLJavaScriptPython

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

{
  "role": "text",
  "organization": "123e4567-e89b-12d3-a456-426614174000",
  "metadata": {}
}

201

Created

No content

get

Get profile details

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

Profile ID

Query parameters

$withSurveyany ofOptional

Set to true to include demographic survey responses. Set to a survey ID to include responses for a specific survey.

booleanOptional

or

stringOptional

Responses

200

OK

application/json

404

A service with the specified ID was not found. *

get

/profile/{id}

HTTPcURLJavaScriptPython

GET /profile/{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",
  "role": "text",
  "organization": "123e4567-e89b-12d3-a456-426614174000",
  "metadata": {}
}

patch

Update profile

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

Profile ID

patch

/profile/{id}

HTTPcURLJavaScriptPython

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

patch

Update profile's demographic survey response. Creates a new survey response, if one doesn't exist.

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

Profile ID

patch

/profile/{id}/demographic-survey

HTTPcURLJavaScriptPython

PATCH /profile/{id}/demographic-survey HTTP/1.1
Authorization: Basic username:password
Accept: */*

post

Verifies profile's email address

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

codestringRequired

verification secret provided to the user

Responses

200

OK

application/json

400

Please provide a valid verification secret.

404

Profile not found or already verified.

post

/verify-profile-email

HTTPcURLJavaScriptPython

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

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

patch

Share an existing profile 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

profilestring · uuidRequired

networkstring · uuidRequired

Path parameters

idstringRequired

Profile ID

Responses

200

OK

application/json

404

A profile with the specified ID was not found.

patch

/profile/{id}/share

HTTPcURLJavaScriptPython

PATCH /profile/{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",
  "role": "text",
  "organization": "123e4567-e89b-12d3-a456-426614174000",
  "metadata": {}
}

post

Revoke an shared profile 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

profilestring · uuidRequired

networkstring · uuidRequired

Path parameters

idstringRequired

Profile ID

Responses

200

OK

application/json

404

A profile with the specified ID was not found.

post

/profile/{id}/unshare

HTTPcURLJavaScriptPython

POST /profile/{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",
  "role": "text",
  "organization": "123e4567-e89b-12d3-a456-426614174000",
  "metadata": {}
}