get_entries
Retrieve entries from a specified content type with advanced filtering, sorting, and pagination options. Include related data, global field schemas, and metadata for comprehensive content management.
Instructions
Retrieves entries for a specified content type, with extensive options for filtering, sorting, pagination, and including related data.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| asc | No | Sort entries in ascending order by the specified field UID | |
| content_type_uid | Yes | Content type UID to fetch entries from | |
| desc | No | Sort entries in descending order by the specified field UID | |
| except | No | Exclude specified top-level fields from the response | |
| include_count | No | Include total count of entries | |
| include_global_field_schema | No | Include global field schema | |
| include_metadata | No | Include metadata in the response | |
| include_owner | No | Include owner information in the response | |
| include_publish_details | No | Include publish details in the response | |
| include_reference | No | References to include | |
| include_reference_content_type_uid | No | Include content type UIDs in references | |
| include_schema | No | Include content type schema | |
| limit | No | Number of entries to return (max 100) | |
| locale | No | Locale code (e.g., 'en-us') | |
| only | No | Include only specified top-level fields in the response | |
| query | No | Query in JSON format to filter entries | |
| skip | No | Number of entries to skip (for pagination) |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"asc": {
"description": "Sort entries in ascending order by the specified field UID",
"type": "string"
},
"content_type_uid": {
"description": "Content type UID to fetch entries from",
"type": "string"
},
"desc": {
"description": "Sort entries in descending order by the specified field UID",
"type": "string"
},
"except": {
"description": "Exclude specified top-level fields from the response",
"items": {
"type": "string"
},
"type": "array"
},
"include_count": {
"default": false,
"description": "Include total count of entries",
"type": "boolean"
},
"include_global_field_schema": {
"default": false,
"description": "Include global field schema",
"type": "boolean"
},
"include_metadata": {
"default": false,
"description": "Include metadata in the response",
"type": "boolean"
},
"include_owner": {
"default": false,
"description": "Include owner information in the response",
"type": "boolean"
},
"include_publish_details": {
"default": false,
"description": "Include publish details in the response",
"type": "boolean"
},
"include_reference": {
"description": "References to include",
"items": {
"type": "string"
},
"type": "array"
},
"include_reference_content_type_uid": {
"default": false,
"description": "Include content type UIDs in references",
"type": "boolean"
},
"include_schema": {
"default": false,
"description": "Include content type schema",
"type": "boolean"
},
"limit": {
"default": 100,
"description": "Number of entries to return (max 100)",
"type": "number"
},
"locale": {
"description": "Locale code (e.g., 'en-us')",
"type": "string"
},
"only": {
"description": "Include only specified top-level fields in the response",
"items": {
"type": "string"
},
"type": "array"
},
"query": {
"description": "Query in JSON format to filter entries",
"type": "string"
},
"skip": {
"default": 0,
"description": "Number of entries to skip (for pagination)",
"type": "number"
}
},
"required": [
"content_type_uid"
],
"type": "object"
}