Transaction

Transaction operations

get

List transactions

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

/transaction

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

200

{
  "__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 transaction

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

subjectstring · uuidRequired

Profile id

agentstring · uuidOptional

Agent id

startedAtstring · date-timeOptional

Start time

surveyResponsestring · uuidOptional

Link a survey response to the transaction

Responses

201

Created

post

/transaction

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

{
  "subject": "123e4567-e89b-12d3-a456-426614174000",
  "agent": "123e4567-e89b-12d3-a456-426614174000",
  "startedAt": "2026-02-14T19:45:07.761Z",
  "surveyResponse": "123e4567-e89b-12d3-a456-426614174000"
}

201

Created

No content

get

Get a transaction 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 transaction to get

Responses

200

application/json

404

A transaction with the specified ID was not found.

get

/transaction/{id}

GET /transaction/{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"
}

patch

Update a transaction

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.

Header parameters

if-unmodified-sincestringOptional

last update time to make sure request data is not outdated and does not overwrite any data

Body

metadataobjectOptional

Arbitrary structured information

Responses

200

Updated

No content

patch

/transaction/{id}

PATCH /transaction/{id} HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "metadata": {}
}

200

Updated

No content

get

List transaction events

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

/transaction-event

GET /transaction-event HTTP/1.1
Authorization: Basic username:password
Accept: */*

200

{
  "__meta": {
    "total": 1,
    "perPage": 1,
    "currentLength": 1,
    "prevUrl": 1,
    "nextUrl": 1
  },
  "data": {
    "transaction": "123e4567-e89b-12d3-a456-426614174000",
    "agent": "123e4567-e89b-12d3-a456-426614174000",
    "action": "text",
    "elementType": "text",
    "elementId": "123e4567-e89b-12d3-a456-426614174000",
    "metadata": {},
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "created_at": "2026-02-14",
    "updated_at": "2026-02-14"
  }
}

post

Create a new transaction event

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

transactionstring · uuidRequired

The id of the transaction.

agentstring · uuidOptional

The profile id of the agent.

actionstringOptional

A definitive action name for the transaction event.

elementTypestringOptional

A Nexus211 entity that's associated with this event. Can be 'survey', 'referral', etc.

elementIdstring · uuidOptional

The identifier of the entity associated with this event

metadataobjectOptional

Arbitrary structured information about the event

Responses

201

Created

post

/transaction-event

POST /transaction-event HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 203

{
  "transaction": "123e4567-e89b-12d3-a456-426614174000",
  "agent": "123e4567-e89b-12d3-a456-426614174000",
  "action": "text",
  "elementType": "text",
  "elementId": "123e4567-e89b-12d3-a456-426614174000",
  "metadata": {}
}

201

Created

No content

post

Close a transaction

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.

Responses

200

Successfully closed

No content

404

Transaction not found or belongs to another organization

post

/transaction/{id}/close

POST /transaction/{id}/close HTTP/1.1
Authorization: Basic username:password
Accept: */*

No content

post

Reopens a transaction

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.

Responses

200

Successfully reopened

No content

404

Transaction not found or belongs to another organization

422

Transaction is not closed

post

/transaction/{id}/reopen

POST /transaction/{id}/reopen HTTP/1.1
Authorization: Basic username:password
Accept: */*

No content

PreviousSurvey NextUser

Last updated 9 days ago