List canvases

get

https://{organization}.my.pitcher.com/api/v1/canvases/

Retrieves a list of canvases.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

access_type

string

enum

public - Public
restricted - Restricted
personal - Personal

Allowed:

access_type__in

array of strings

Multiple values may be separated by commas.

access_type__in

account__id

string

account__name

string

account__name__endswith

string

account__name__icontains

string

account__name__iexact

string

account__name__startswith

string

created_at

date-time

created_at__gt

date-time

created_at__gte

date-time

created_at__lt

date-time

created_at__lte

date-time

created_at__range

array of date-times

Multiple values may be separated by commas.

created_at__range

created_by__id

integer

created_by__id__in

array of integers

Multiple values may be separated by commas.

created_by__id__in

created_by__name

string

created_by__name__endswith

string

created_by__name__icontains

string

created_by__name__startswith

string

expires_at

date-time

expires_at__gt

date-time

expires_at__gte

date-time

expires_at__isnull

boolean

expires_at__lt

date-time

expires_at__lte

date-time

expires_at__range

array of date-times

Multiple values may be separated by commas.

expires_at__range

fields

string

Fields to return.

string

id__in

array of strings

Multiple values may be separated by commas.

id__in

include_expired

boolean

Include expired canvases.

instance_id

string

required

Filter by instance_id.

is_block

boolean

is_default

boolean

is_draft

boolean

is_editable

boolean

is_section

boolean

is_template

boolean

metadata

object

Dynamic filter for metadata field. Ex: {"metadatasynceddaterange": "2023-11-29T13:19:00,2023-11-29T13:20:00"}

modified_at

date-time

modified_at__gt

date-time

modified_at__gte

date-time

modified_at__lt

date-time

modified_at__lte

date-time

modified_at__range

array of date-times

Multiple values may be separated by commas.

modified_at__range

modified_by__id

integer

modified_by__id__in

array of integers

Multiple values may be separated by commas.

modified_by__id__in

modified_by__name

string

modified_by__name__endswith

string

modified_by__name__icontains

string

modified_by__name__startswith

string

name

string

name__endswith

string

name__icontains

string

name__iexact

string

name__startswith

string

ordering

string

Which field to use when ordering the results.

owned_by__id

integer

owned_by__id__in

array of integers

Multiple values may be separated by commas.

owned_by__id__in

owned_by__name

string

owned_by__name__endswith

string

owned_by__name__icontains

string

owned_by__name__startswith

string

page

integer

A page number within the paginated result set.

page_size

integer

Number of results to return per page.

string

A search term.

start_at

date-time

start_at__gt

date-time

start_at__gte

date-time

start_at__lt

date-time

start_at__lte

date-time

start_at__range

array of date-times

Multiple values may be separated by commas.

start_at__range

sync

boolean

Include extra fields for the results.

tags__in

array of strings

Multiple values may be separated by commas.

tags__in

tags__not_in

array of strings

Exclude canvases that have any of the specified tags.

tags__not_in

template__id

string

template__id__in

array of strings

Multiple values may be separated by commas.

template__id__in

template__name

string

template__name__endswith

string

template__name__icontains

string

template__name__iexact

string

template__name__startswith

string

Response

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200