Skip to main content
GET
/
api
/
adm
/
transactionTags
Get Transaction Tags
curl --request GET \
  --url https://localhost:44371/api/adm/transactionTags \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "code": 200,
  "errorMessage": null,
  "entries": []
}

​
Description

Queries transaction tags with optional filtering. Tags are labels applied to transactions for classification, filtering, and custom reporting. This endpoint is used to discover which tags are applied to specific transactions, or to find all transactions with a particular tag for batch operations or reporting.

​
Input

  • Query Parameters: model (TransactionTagQueryRequest) — Filtering options including:
    • transactionId (string, optional) — Filter by specific transaction ID.
    • projectId (guid, optional) — Filter by project ID.
    • tagName (string, optional) — Filter by specific tag name.
    • limit (int, optional) — Maximum records to return (default: 20).
    • offset (int, optional) — Number of records to skip for pagination.

​
Output

Returns a TransactionTagQueryResponse containing matching tags or an empty list if none found.

​
Example Request

GET /api/admin/transactionTags?transactionId=TX123456
Authorization: Bearer {token}

​
Example Response

{
  "success": true,
  "code": 200,
  "errorMessage": null,
  "tags": [
    {
      "id": "9ef15c43-a955-6f4h-c7g3-1h6d4f0e3g9c",
      "transactionId": "TX123456",
      "tagName": "fraud-review",
      "appliedDate": "2025-10-27T10:00:00Z",
      "appliedBy": "[email protected]"
    },
    {
      "id": "8de04b32-9944-5e3g-b6f2-0g5c3e9d2f8b",
      "transactionId": "TX123456",
      "tagName": "high-value",
      "appliedDate": "2025-10-27T10:01:00Z",
      "appliedBy": "system"
    }
  ]
}

​
Errors

  • 400 Bad Request — Invalid query parameters or filter values.
  • 401 Unauthorized — Missing or invalid authentication token.
  • 404 Not Found — Specified transaction ID does not exist when filtering by transaction.

​
Notes

  • Empty results return success with an empty tags array.
  • Results include metadata about when and by whom tags were applied.
  • Tag names are case-sensitive.
  • Results are paginated; use limit and offset parameters for large datasets.

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

​
CompanyId
string<guid> | null

The optional identifier of the company whose tags should be returned.

​
CompanyProjectId
string<guid> | null

The optional identifier of the company project whose tags should be returned.

​
Id
string<guid> | null

Optional identifier to filter results by a specific entity.

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

Response

Always returned. Check the success property in the response body to determine if the operation succeeded.

Standard response structure containing operation status and error information. Standard query response containing a collection of matching entities. Represents the response returned when querying for transaction tags.

​
success
boolean

True if the operation completed successfully; false if an error occurred.

Example:

true

​
code
enum<string>

Result code indicating the outcome of the operation.

Available options:
Unknown,
Success,
BadRequest,
Unauthorized,
NotFound,
Error
Example:

200

​
errorMessage
string | null

Human-readable error message when an error occurs.

Example:

null

​
entries
object[] | null

Collection of entities matching the query criteria.

Example:
[]