get https://{host}/api_gateway/cortex/v1/neo-config/entity/
This API allows you to retrieve the custom event transformation logics created for an entity for your org.
Note
For detailed information about our APIs and for hands-on testing, refer documentation in API overview and step-by-step guide on making your first API call in Make your first API call .
Prerequisites
- Authentication: Basic/OAuth authentication
- Default access group
Resource Information
| URI | /api_gateway/cortex/v1/neo-config/entity/{entity type} |
| HTTP method | GET |
| Pagination | NA |
| Rate limit | Default |
| Batch support | NA |
API endpoint example
`https://eu.api.capillarytech.com/api_gateway/cortex/v1/neo-config/entity/transaction
Path Parameter
| Parameter | Description |
|---|---|
| entitytype | Entity type. Supported values: Transaction, Customer |
Response Body
{
"data": {
"orgId": 100737,
"entityType": "TRANSACTION",
"transformEndpoint": "/transform/transaction/custom",
"active": true,
"auditInfo": {
"createdOn": "2025-04-23T06:59:56.411+00:00",
"createdBy": 75155282,
"lastUpdatedOn": "2025-04-23T07:06:33.947+00:00",
"lastUpdatedBy": 75155282
}
},
"errors": []
}
Response Parameter
| Parameter | Type | Description |
|---|---|---|
data.orgId | long | The ID of the organization. |
data.entityType | String | The type of entity this configuration applies to (e.g., TRANSACTION). |
data.transformEndpoint | String | API endpoint used to transform the transaction data. |
data.active | Boolean | Indicates whether the configuration is currently active. |
data.auditInfo.createdOn | String | Timestamp when the configuration was created in ISO 8601 format. |
data.auditInfo.createdBy | long | User ID of the person who created the configuration. |
data.auditInfo.lastUpdatedOn | String | Timestamp when the configuration was last updated in ISO 8601 format. |
data.auditInfo.lastUpdatedBy | long | User ID of the person who last updated the configuration. |
errors | Array | List of errors encountered (empty array if no errors). |
Error Codes
| Error code | Description |
|---|---|
| 400 BAD_REQUEST | - The request body is invalid JSON - Required fields are missing - The request body fails validation - Constraint violations occur |
| 401 UNAUTHORIZED | - Authentication is missing or invalid - The auth token is not provided |
| 403 FORBIDDEN | - The authenticated user doesn't have permission to create configurations |
| 500 INTERNAL_SERVER_ERROR | - Unexpected server errors occur - Database operations fail - Other runtime exceptions occur |