Skip to main content
GET
/
api
/
resources
/
{schemaDefinitionNameOrId}
List Resources
curl --request GET \
  --url https://api.embedreach.com/api/resources/{schemaDefinitionNameOrId}
{
  "success": true,
  "message": "<string>",
  "data": {
    "results": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "schema_definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "schemaDefinitionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "platform_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "platformId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "businessId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "resource_external_id": "<string>",
        "resourceExternalId": "<string>",
        "created_at": "<string>",
        "createdAt": "<string>",
        "updated_at": "<string>",
        "updatedAt": "<string>",
        "data": {}
      }
    ],
    "pagination": {
      "hasNextPage": true,
      "cursor": "<string>",
      "total": 123
    },
    "included": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "schema_definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "schemaDefinitionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "platform_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "platformId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "businessId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "resource_external_id": "<string>",
        "resourceExternalId": "<string>",
        "created_at": "<string>",
        "createdAt": "<string>",
        "updated_at": "<string>",
        "updatedAt": "<string>",
        "data": {}
      }
    ]
  }
}

Headers

​
reach-tenant-id
string

If using a platform scoped JWT, you can pass in a header to impersonate a specific tenant to impersonate the request as.

Path Parameters

​
schemaDefinitionNameOrId
string
required

The name or id of the schema definition to filter the resources by

Query Parameters

​
include
string

Comma-separated list of reference ($ref) fields to include in the response. (Supports nested references with dot notation)

​
filters
object

Map of field names to values to filter the resources by. Can be in the format ?filters[field_name]=value&filters[other_field_name]=value2

​
cursor
string

Cursor for pagination. Use the cursor from the previous response to get the next page.

​
limit
number | null
default:100

Number of items to return per page. Default is 100, maximum is 1000.

​
includeCounts
enum<string>
default:true

Whether to include total count in pagination response. Default is true. DEPRECATION NOTICE: The default will change to false in a future release for performance reasons. If you rely on pagination.total, explicitly set includeCounts=true.

Available options:
true,
false

Response

Status 200 response

​
success
boolean
required
​
message
string
​
data
object