GuidesChangelogAPI Reference
API Reference

/api/v5/intake_request/

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

Get a list of intake_requests.

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

A CSV of unique intake_request IDs to filter by.

integer

Limit the number of paginated results.

integer

A 0-based offset to adjust the pagination window.

string
enum

Order by the specified attribute.

Allowed:
string
enum

Control order direction.

Allowed:
date-time

Filter by due_at date (inclusive).

date-time

Filter by due_at date (exclusive).

boolean
Defaults to false

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

{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

A CSV of scope IDs to filter by.

string
enum

Includes related items in the response.

Allowed:
string
enum

A CSV of statuses to filter by (open, rejected, in_progress, completed).

Allowed:
string

A CSV of user IDs to filter requestors by (^user:\d+$).

string | null

A CSV of user IDs to filter assignees by (^user:\d+$).

string

A CSV of response IDs to filter responses by (^post:\d+|campaign:\d+$).

string

A CSV of campaign IDs to filter source campaigns by (^campaign:\d+$).

boolean
Defaults to false

Look inside any campaigns of imc tree in addition to the supplied ones.

boolean
Defaults to false

Extend the requests to include IRs from posts related to the campaigns

string

A CSV of keywords to filter source campaigns

Responses

Retry-After header

500

Internal server error

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