Skip to content
View as Markdown

GET List Email Patterns​

GET
/email-patterns

List saved email block patterns, newest first.

Note the response envelope: patterns carries only data and total, not the full paginator. Page through it with page and per_page and use total to work out how many pages there are.

search matches against the serialised pattern value, so it hits the title, content, category, and description at once. LIKE wildcards in the term are escaped and matched literally.

Required capability: fcrm_read_emails

Enforced by EmailPatternPolicy::verifyRequest(), the policy default for this route group.

Authorizations​

ApplicationPasswords

WordPress Application Passwords — use Basic auth with your WordPress username and an application password in the format: username:application_password

Type
API Key (header: Authorization)

Parameters​

Query Parameters

search

Case-insensitive substring match against the stored pattern value.

Type
string
page

Page number to return.

Type
integer
Default
1
per_page

Rows per page.

Type
integer
Default
15

Responses​

Matching patterns.

application/json
JSON
{
"patterns": {
"data": [
{
"id": 0,
"slug": "string",
"title": "string",
"content": "string",
"category": "string",
"description": "string",
"sync_status": "string",
"created_at": "string",
"updated_at": "string"
}
],
"total": 0
}
}

Playground​

Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI