Single Page Operations

/api/v1/{spaceName}/data/{typeModel}/{model}/{id}

This endpoint is used for operations on a specific object within a collection or page.

URL Parameters

NameExampleDescription
id5f8d43e1a8c7f31d8c1b7b3aID of the entity in the collection or page. In the admin panel URL: front/{spaceName}/collections/books/{id}

Retrieve an Object

Retrieves information about a specific object by its ID.

Request Example:

GET /api/v1/main/data/collections/books/5f8d43e1a8c7f31d8c1b7b3a

Optional query parameters: selectFields (comma-separated field projection) and populate (relation fields to expand) work here too.

Update an Existing Object

Updates information for a specific object.

Request Example:

PUT /api/v1/main/data/collections/books/5f8d43e1a8c7f31d8c1b7b3a

The request body depends on the schema of the collection/page being updated. The structure is dynamic based on the collection's or page's fields.

Delete an Existing Object

Moves a specific object to the trash (soft delete). It stays recoverable for the retention period defined by your plan, after which it is removed permanently — or immediately if your plan's retention is 0.

Request Example:

DELETE /api/v1/main/data/collections/books/5f8d43e1a8c7f31d8c1b7b3a

No additional query parameters required.

On this page