Skip to content

API CRUD Operations

CRUD is an acronym that stands for Create, Read, Update, and Delete - the four fundamental operations supported by most RESTful APIs. These operations allow you to manage data for any entity type in the system through a consistent and predictable interface.

Each operation corresponds to a standard HTTP method:

  • Create → POST
  • Read → GET
  • Update → PUT
  • Delete → DELETE

These endpoints form the backbone of API interaction and are available for all defined entities in Mythradon.

Working with Entity Types in the API

You can view the available entity types in the application by navigating to the Entity Manager.

To explore the available attributes for a specific entity type, go to:

Administration → Entity Manager → {Entity Type} → Fields

Click View Details on any field to see its metadata and configuration options.

API Operations Overview

The following RESTful endpoints are supported for working with entity records:

  • List records
  • Read a specific record
  • Create a new record
  • Update an existing record
  • Delete a record

List Records

Endpoint:

GET /{entityType}

Description:

Retrieves a list of records for a given entity type.

Query Parameters:

Parameter Type Description
maxSize int Maximum number of records to return. Maximum value of 200.
offset int Offset for pagination.
where array Filters to apply (see filtering docs).
orderBy string Attribute to sort by.
order string Sort direction: "asc" or "desc".
select string Comma-separated list of attributes to return. If omitted, all attributes are returned. No spaces allowed.

Record List Max Size Limit

In Mythradon, API responses for GET /{entityType} requests are limited to a maximum of 200 records per request. This limit helps ensure consistent performance and reliability across the system.

To retrieve more than 200 records, you can implement a paging strategy using the offset parameter. By making multiple requests and adjusting the offset value, you can iterate through the full result set in manageable chunks.

Example: 

GET /Account?offset=0&maxSize=200
GET /Account?offset=200&maxSize=200

This limit does not restrict access to your data—it simply enforces efficient data retrieval practices.

Record List Max Size Limit

In Mythradon the maximum number of records that can be returned in a single API response when listing records using a GET /{entityType} request is set to 200 records.

This does not prevent the ability to retrieve more records, however you will need to make multiple requests using the offset parameter and implement a paging pattern.

In Mythradon, the maxSize has a maxium value of 200.

This is a system configuration setting that defines the maximum number of records that can be returned in a single API response when listing records using a GET /{entityType} request.

Example Request:

GET /Account?offset=0&maxSize=20

Example Response:

{
  "list": [...], 
  "total": 125
}

Optional Headers:

  • X-No-Total: true – Suppresses the total record count for faster response on large datasets. The maximum record recordListMaxSizeLimit

Read a Record

Endpoint: GET /{entityType}/{id}

Description: Fetches the full details of a single record by its ID.

Example:

GET /Account/5564764442a6d024c

Create a Record

Endpoint: POST /{entityType}

Description: Creates a new record for the specified entity type.

Headers:

  • Content-Type: application/json

Payload: A JSON object with the entity's attribute values.

Example:

POST /Account

Request Body:

{
  "name": "Test",
  "assignedUserId": "1"
}

Optional Headers:

  • X-Skip-Duplicate-Check: true – Prevents the API from returning a 409 Conflict if a potential duplicate is detected.

Update a Record

Endpoint: PUT /{entityType}/{id}

Description: Updates an existing record by ID.

Headers:

  • Content-Type: application/json

Payload: Only include attributes you wish to update.

Example:

PUT /Account/5564764442a6d024c

Request Body:

{
  "assignedUserId": "1"
}

Delete a Record

Endpoint: DELETE /{entityType}/{id}

Description: Deletes the specified record.

Example:

DELETE /Account/5564764442a6d024c

Response:

true

For more advanced search and filtering options, see the Search Parameters Documentation.

See also

API Client Examples: