AIair
Showcases

/showcases

Changed on

List the showcases you can see, each with its share link.

If your role can view every showcase in the workspace, all of them are listed. Otherwise only the showcases you own are listed.

A showcase's sub-pages are not listed separately. A showcase deleted in the Air app is not listed, and every route that takes its id, including the showcaseId filter on GET /v1/assets and GET /v1/boards, returns 404 for it.

Requires the showcases.read and share_links.read OAuth scopes.

get/v1/showcases

Request

  • Base URL
    api.air.inc (relative, and the document’s source URL is not known)
  • Auth
    • API key in header x-api-key and API key in header x-air-workspace-id
    • or HTTP bearer and API key in header x-air-workspace-id
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Query parameters

searchstring

Only return showcases whose name contains this text

status'active' | 'inactive' | 'expired'

Filter by the state of the showcase's share link. active: the link is enabled. inactive: the link is disabled. expired: the link's expiration date has passed.

limitinteger

The max number of showcases to return. Defaults to 12. Values above 200 are treated as 200.

cursorstring

Cursor to the next page of showcases

Response

Showcases listed successfully

totalinteger

Changes