Skip to main content
GET
/
content
/
v2
/
content-models
/
{modelInternalName}
/
records
Search & Filter Content Model Records
curl --request GET \
  --url https://apis.experro.app/content/v2/content-models/{modelInternalName}/records \
  --header 'Authorization: Bearer <token>' \
  --header 'x-environment-id: <x-environment-id>' \
  --header 'x-tenant-id: <x-tenant-id>' \
  --header 'x-workspace-id: <x-workspace-id>'
{
  "Status": "success",
  "Data": {
    "records": [
      {
        "id": "<string>",
        "version_no": 123,
        "page_slug": "<string>",
        "page_title": "<string>",
        "version_name": "<string>",
        "seo": [
          {
            "id": "<string>"
          }
        ],
        "thumbnail_image": [
          "<string>"
        ],
        "content_model_name": "<string>",
        "current_version_id": "<string>",
        "title": "<string>",
        "version_id": "<string>",
        "record_data_language": "<string>",
        "categories": [
          "<string>"
        ]
      }
    ],
    "_meta_": {
      "tenant_id": "<string>",
      "workspace_id": "<string>",
      "env_type": "<string>",
      "store_hash": "<string>",
      "content_model_id": "<string>",
      "_fields_": {}
    },
    "total_rows": 123,
    "limit": 123,
    "offset": 123
  }
}
Before calling this endpoint, make sure you’ve generated an API token and picked the correct domain. See Authentication & Base URLs.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-tenant-id
string
required

Identifier for the tenant. Ensures data isolation per tenant.

​
x-workspace-id
string
required

Workspace identifier within the tenant. Scopes resources to a specific workspace.

​
x-environment-id
string
required

Unique identifier of the target environment. Used to scope the API call to a specific deployment environment.

Example:

"PRODUCTION-15a0f8c2-a5e8-4e40-ae74-cb1389d22f45-w49jkngj"

Path Parameters

​
modelInternalName
string
required

Unique internal identifier of the content model (e.g. blogPost).

Query Parameters

​
fields
string
required

Comma-separated list of fields to include in the response

​
locale
string
required

Specifies the language or region for the response data

​
sort_order
string

Direction to order results: asc (ascending) or desc (descending).

​
sort_by
string

Field name by which to sort results (e.g. created_at).

​
limit
integer

Maximum number of items to return.

​
offset
integer

Skips the specified number of results from the beginning.

​
include_fields_meta
boolean

Flag to include meta details of the specified fields. When true, returns metadata for each requested field.

​
parent_filter
string

Filter applied to the parent fields. Pass array of strings in value for multiple filter results.

​
child_filter
string

Filter applied to the child components of a record. Pass array of strings in value for multiple filter results. Include component name to identify the required data.

​
filter_operator
enum<string>

Defines the logical connection (AND/OR) between the parent and child filters. Defaults to ‘AND’.

Available options:
AND,
OR
​
field_type
enum<string>

Indicates whether the field is a parent or child type. Defaults to ‘parent’.

Available options:
parent,
child
​
relation_field
string

Specifies the name of the related field used for joining models.

​
relation_field_data_to_query
string

Comma-separated fields to include for related models in the result.

​
status
enum<string>

Lifecycle state ('PUBLISHED'/'DRAFT') of records to retrieve. Defaults to PUBLISHED.

Available options:
PUBLISHED,
DRAFT

Response

Paginated list of records matching the query.

​
Status
string

Indicates overall request outcome.

Example:

"success"

​
Data
object