Entities Data

These endpoints manage CRUD (Create, Read, Update, Delete) operations on entity records, including

Endpoints

Get all the records of an entity

GET /api/v1/entities/{entity}

Parameters:

Name	Type	From	Description	Required
`enriched`	boolean	query	Return more details about the entity	False
`version`	string	query	The version of the application.	True
`limit`	number	query	limit for pagination	False
`page`	number	query	page for pagination	False
`relationFilter`	array[string]	query	Name of the relationship to filter by	False
`relationValue`	array[string]	query	Related value to filter by	False
`sort_direction`	array[string]	query	Direction for sorting. Values: [ ASC, DESC ]	False
`sort_field`	array[string]	query	Field to sort by.	False
`key`	array[string]	query	Field key/name used to filter by field.	False
`operator`	array[string]	query	Operator for field filtering. Values: [lt, gt, eq, ne, lk, lte, gte, isNull, isNotNull]	False
`value`	array[string]	query	Value to filter by with field filtering	False
`condition`	array[string]	query	Condition to chain multiple field filters. Values: [ AND, OR]. Default AND.	False
`domain`	string	header	Domain of the record	True
`entity`	string	path	The name or id of the entity.	True

Response:

{
  "error": false,
  "status": 200,
  "message": "string",
  "errors": [{}],
  "data": [
    {
      "id": 0,
      "dateUpdated": "string",
      "dateCreated": "string",
      "createdBy": "string",
      "updatedBy": "string",
      "domain": "string",
      "securityGroup": "string",
      "data": {
        "entityAttribute": "string",
        "entityAttribute2": "string",
        "entityAttribute3": "string"
      }
    }
  ],
  "pagination": {
    "hasPreviousPage": true,
    "hasNextPage": true,
    "previousPage": 0,
    "nextPage": 0,
    "recordsTotal": 0,
    "currentPage": 0,
    "startIndex": 0,
    "numPages": 0,
    "limit": 0
  }
}

Using Filters:

Key filters: Key filters work by limiting the request to retrun only the queried keys in the key[] array passed on the url. Ej: key[]=Name,Age&operator[]=eq,lk&value[]=Carlos,25&condition[]=OR would return only the keys Name and Age for the specified entity where name matches Carlos or age matches 25.
Sort direction: Sorts the results from the query in either ascending or descending order. Ej: sort_direction[]=ASC&sort_field[]=name will sort all records by their name alphabetically in ascending order.
Relationship filters: Filtering by relationship values is similar to filtering by key. The main difference is that the value that is filtered is the one for the specified relationship. Ej: relationshipFilter[]=77b5b900-7e13-4e18-864a-255fc194481e.related_id_00d4b4b4-d9e3-4a2b-a4e3-209b6f438df9.id&relationshipValue[]=1 will filter all values matching 1 for the specified relationship Something to take into consideration is that relationship have a direction, meaning every relationship will have a left and right entity, and depending on which side of the relationship is being filtered, the query will be different: If filtering by the left entity, the relationValue will be right entity’s id. If filtering by the right entity, the relationValue will be left entity’s related field.

Create a new entity Record

POST /api/v1/entities/{entity}

Parameters:

Name	Type	From	Description	Required
`version`	string	query	The version of the application.	True
`domain`	string	header	Domain of the record	True
`entity`	string	path	The name or id of the entity.	True

Request Body:

{
  "textField": "some text",
  "numericField": 123,
  "booleanField": false,
  "dateField": "2025-10-20T18:57:07.092Z",
  "relation1": [
    {
      "record": {
        "primaryKey1": 1,
        "primaryKey2": "asd"
      },
      "operation": "add"
    }
  ],
  "relation2": [
    {
      "record": {
        "primaryKey1": 1
      },
      "operation": "add"
    },
    {
      "record": {
        "primaryKey1": 1
      },
      "operation": "remove"
    }
  ]
}

Response:

{
  "error": true,
  "status": 0,
  "message": "string",
  "data": {
    "id": 1
  },
  "entityName": "string"
}

Get an entity’s record by id

GET /api/v1/entities/{entity}/{id}

Parameters:

Name	Type	From	Description	Required
`enriched`	boolean	query	Return more details about the application	False
`version`	string	query	The version of the application.	True
`domain`	string	header	Domain of the record	True
`entity`	string	path	The name or id of the entity.	True
`id`	string	path	Id of the record.	True

Response:

{
  "error": false,
  "status": 200,
  "message": "string",
  "errors": [{}],
  "data": [
    {
      "id": 0,
      "dateUpdated": "string",
      "dateCreated": "string",
      "createdBy": "string",
      "updatedBy": "string",
      "domain": "string",
      "securityGroup": "string",
      "data": {
        "entityAttribute": "string",
        "entityAttribute2": "string",
        "entityAttribute3": "string"
      }
    }
  ],
  "pagination": {
    "hasPreviousPage": true,
    "hasNextPage": true,
    "previousPage": 0,
    "nextPage": 0,
    "recordsTotal": 0,
    "currentPage": 0,
    "startIndex": 0,
    "numPages": 0,
    "limit": 0
  }
}

Update an entity’s record

PATCH /api/v1/entities/{entity}

Parameters:

Name	Type	From	Description	Required
`version`	string	query	The version of the application.	True
`domain`	string	header	Domain of the record	True
`entity`	string	path	The name or id of the entity.	True
`filter`	object	query	Filter Entity Records by their property values.	True

Request Body:

{
  "textField": "some text",
  "numericField": 123,
  "booleanField": false,
  "dateField": "2025-10-20T18:57:07.092Z",
  "relation1": [
    {
      "record": {
        "primaryKey1": 1,
        "primaryKey2": "asd"
      },
      "operation": "add"
    }
  ],
  "relation2": [
    {
      "record": {
        "primaryKey1": 1
      },
      "operation": "add"
    },
    {
      "record": {
        "primaryKey1": 1
      },
      "operation": "remove"
    }
  ]
}

Response:

{
  "error": false,
  "status": 200,
  "message": "string",
  "errors": [{}],
  "data": {
    "totalRecordsUpdated": 1
  },
  "pagination": {
    "hasPreviousPage": true,
    "hasNextPage": true,
    "previousPage": 0,
    "nextPage": 0,
    "recordsTotal": 0,
    "currentPage": 0,
    "startIndex": 0,
    "numPages": 0,
    "limit": 0
  }
}

Delete an entity’s record

DELETE /api/v1/entities/{entity}/{id}

Parameters:

Name	Type	From	Description	Required
`version`	string	query	The version of the application.	True
`domain`	string	header	Domain of the record	True
`entity`	string	path	The name or id of the entity.	True
`id`	string	path	Id of the entity record	True

Response:

{
  "error": false,
  "status": 200,
  "message": "string",
  "errors": [{}],
  "data": "string",
  "pagination": {
    "hasPreviousPage": true,
    "hasNextPage": true,
    "previousPage": 0,
    "nextPage": 0,
    "recordsTotal": 0,
    "currentPage": 0,
    "startIndex": 0,
    "numPages": 0,
    "limit": 0
  }
}

Update an entity record’s owner

PUT /api/v1/entities/{entity}/{id}/owner

Parameters:

Name	Type	From	Description	Required
`version`	string	query	The version of the application.	True
`entity`	string	path	The name or id of the entity.	True
`id`	string	path	id of the record	True

Request Body:

{
  "newOwner": 1
}

Response:

{
  "error": false,
  "status": 200,
  "message": "string",
  "errors": [{}],
  "data": [
    {
      "id": 0,
      "dateUpdated": "string",
      "dateCreated": "string",
      "createdBy": "string",
      "updatedBy": "string",
      "domain": "string",
      "securityGroup": "string",
      "data": {
        "entityAttribute": "string",
        "entityAttribute2": "string",
        "entityAttribute3": "string"
      }
    }
  ],
  "pagination": {
    "hasPreviousPage": true,
    "hasNextPage": true,
    "previousPage": 0,
    "nextPage": 0,
    "recordsTotal": 0,
    "currentPage": 0,
    "startIndex": 0,
    "numPages": 0,
    "limit": 0
  }
}