CanvasesList canvases
Canvases

List canvases

Retrieve a paginated list of canvases.

curl -X GET "https://api.mythic-analytics.com/api/v1/canvases?status=draft&search=example_string&limit=42&offset=42" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "success": true,
  "data": [
    {
      "id": "cvs_5kN2mPqR",
      "name": "User Journey Flow",
      "description": "example_string",
      "status": "draft",
      "settings": {},
      "current_version": "ver_2nK8mPqR",
      "created_at": "2024-04-20T08:00:00.000Z",
      "updated_at": "2024-06-12T14:20:00.000Z"
    }
  ],
  "count": 8
}
GET
/canvases
GET
Security Scheme
Bearer Tokenstring
Required

Admin API key as bearer token. Format: Bearer YOUR_ADMIN_KEY

Admin API key as bearer token. Format: Bearer YOUR_ADMIN_KEY
query
statusstring

Filter by canvas status (draft, published).

Options: draft, published
query
limitinteger

Maximum results per page. Default 50, max 500.

Max: 500
query
offsetinteger

Number of results to skip. Default 0.

Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. Admin API key as bearer token. Format: Bearer YOUR_ADMIN_KEY

Query Parameters

statusstring

Filter by canvas status (draft, published).

Allowed values:draftpublished
limitinteger

Maximum results per page. Default 50, max 500.

offsetinteger

Number of results to skip. Default 0.

Responses

successboolean
dataarray
countinteger