API Reference

Get all available products

get
https://Contact sales to enable your sandbox/products

If you have configured and launched multiple products within Canopy, retrieve information related to all of your configured products at once.

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

The maximum number of products to be returned. Defaults to 10.

string

Pass the value from the paging response body in your previous request. If not provided, the zero-indexed starting point will be used. Either starting_after or ending_before may be provided, but not both.

string

Pass the value from the paging response body in your previous request. If not provided, the zero-indexed starting point will be used. Either starting_after or ending_before may be provided, but not both.

boolean

Retireve only products that are a template

string

Comma-separated list of statuses of the products to filter by (no whitespaces). Allowed values: ACTIVE, DEACTIVATED

string

Comma-separated list of the product types to filter by (no whitespaces)

string

Searches by product_name and product_id. Based on the input search parameter, the top responses from our API search, up to or less than the provided limit will be returned.

Responses

401

Unauthorized.

403

Forbidden.

404

Unable to get products

429

Too many requests.

default

Unexpected Error.

Updated about 1 year 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 about 1 year ago