GuidesChangelogAPI Reference
API Reference

/api/v5/post/

get
https://percolate.com/api/v5/post/

List posts.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
Defaults to owned

Filter objects owned by the scope itself and/or shared from other scopes ^(owned|shared)$.

string

A CSV of unique post IDs to filter by.

string
enum

Includes related items in the response (Preview).

string

A CSV of scope IDs to filter by.

boolean
Defaults to false

Look inside any child scopes in addition to the supplied ones.

string

Keyword values to search for on post titles.

string
enum

Apply this to any method that supports sorting.

Allowed:
string
enum

Control order direction.

Allowed:
date-time

Filter by live_at date (inclusive).

date-time

Filter by live_at date (exclusive).

date-time

Filter by updated_at date (inclusive).

date-time

Filter by updated_at date (exclusive).

integer

Limit the number of paginated results.

integer

A 0-based offset to adjust the pagination window.

{metadataSearch}
object

This is a dynamic query parameter name, used to filter endpoint response by its metadata field. The {schemaFieldId} template represents the schema id and field name concatenated together by a dot (.). In effect, it expands to the sub-template {schema-id}.{schema-field-name}. The {schema-id} template is the UID of a schema. The {schema-field-name} template is a path separated by the forward slash (/) (to allow for representation of nested objects).
The value of the query parameter is a CSV of strings appropriate for the given metadata field.
Valid options are:
metadata.{schemaFieldId}: string
 has_metadata.{schemaFieldId}: true - Filter by the existence of a metadata field.
metadata.{schemaFieldId}.from: string (date) - Filter by a metadata date field (inclusive)
 metadata.{schemaFieldId}.to: string (date) - Filter by a metadata date field (exclusive).

See the examples for each valid option:
metadata.schema:1.live_date_range
 has_metadata.schema:1.live_date_range
metadata.schema:1.live_date_range/from
 metadata.schema:1.live_date_range/to

string

Filter posts with given production workflow progress status. Use 'no_status' to filter posts that are on production workflow but does not have due date.

string

A CSV of resource IDs to filter by.

date

Filter posts with production workflow ending at or after this date.

date

Filter posts with production workflow starting at or before this date.

string

A CSV of unique channel IDs to filter by.

string

A CSV of unique link IDs to filter by.

string

A CSV of unique user IDs to filter by.

string

A CSV of unique platform IDs to filter by.

string

A CSV of unique term IDs to filter by.

string

Keyword values to search for on posts.

string

A CSV of campaign/brief IDs to filter by, "no_origin" as a value returns posts without campaigns

string

A CSV of user IDs to filter posts that are assigned to those users.

string

Get posts in the hierarchy of these campaigns.

string

A CSV of unique asset IDs to filter by.

string

A CSV of user IDs to filter by users that are part of approval workflows (pending or complete).

string
enum
Defaults to owned

Filter posts owned by the scope itself vs. shared from other scopes.

Allowed:
string

Filter posts if they are unassigned, assigned or both.

string
enum

Filter by statuses. The wildcard .* is supported for operations such as "all queued statuses queued.*"

string

A CSV of user IDs to exclude items that are approved by user.

date

Filter posts with production workflow ending at or after this date.

date

Filter posts with production workflow starting at or before this date

boolean

DEPRECATED - Filter posts to only those that are or are not interactions with external content. Defaults to being unspecified and including both interactions and non-interactions. 🔥 This is provisional/unstable, only for use by Percolate frontend, may be removed in the future!

string

DEPRECATED - A CSV of interaction IDs to filter posts that have interaction with external contents. This implies is_interaction=true.

Responses

Retry-After header

Updated over 2 years ago

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated over 2 years ago