A collection (or list) of resources.
| Property | Description | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| items |
A collection of resources returned in the current result set.
|
||||||||||||||
| links required read-only |
Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name. |
||||||||||||||
| meta read-only |
Metadata describing the current result set.
|
||||||||||||||
| type |
The type of resource represented. |
The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.
{
"description": "A collection (or list) of resources.",
"properties": {
"items": {
"description": "A collection of resources returned in the current result set.",
"items": {
"description": "A curated automated email group created internally to assist studios in creating their own email automations.\nThese resources can only be read from the API.",
"properties": {
"automations": {
"description": "A collection of automated email messages that should be sent to a\nspecified group of recipients at a configured time.",
"items": {
"$ref": "#/components/schemas/CuratedEmailAutomation"
},
"title": "Email Automations",
"type": "array"
},
"created": {
"$ref": "#/components/schemas/Signature/properties/created"
},
"id": {
"$ref": "#/components/schemas/Id"
},
"links": {
"$ref": "#/components/schemas/Links"
},
"name": {
"description": "The name for this email automation group.",
"example": "My Wedding Automation",
"type": "string"
},
"type": {
"allOf": [
{
"$ref": "#/components/schemas/Type"
},
{
"enum": [
"curated-email-automation-group"
]
}
]
}
},
"required": [
"type",
"name"
],
"title": "Curated Email Automation Group",
"type": "object"
},
"title": "Curated Email Automation Group",
"type": "array"
},
"links": {
"$ref": "#/components/schemas/Links"
},
"meta": {
"description": "Metadata describing the current result set.",
"properties": {
"currentPage": {
"description": "The current page of results returned.",
"type": "integer"
},
"rows": {
"description": "The number of rows returned per page for the current result set.",
"type": "integer"
},
"totalItems": {
"description": "The total number of items in the result set. This may be\naffected by active search/filter parameters.",
"type": "integer"
},
"totalPages": {
"description": "The total number of pages in the result set. This is affected by\nthe `rows` parameter (`totalItems / rows == totalPages`).",
"type": "integer"
}
},
"readOnly": true,
"type": "object"
},
"type": {
"description": "The type of resource represented.",
"enum": [
"curated-email-automation-group-collection"
],
"example": "resource-type",
"title": "Resource Type",
"type": "string"
}
},
"required": [
"type",
"items"
],
"title": "Curated Email Automation Groups",
"type": "object"
}