Showcases

/showcases/:showcaseId

Changed on

Get a showcase and its share link.

A sub-page's id returns 404.

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

get/v1/showcases/{showcaseId}

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.

Response

Showcase returned successfully

idstring required

The showcase ID

namestring required
descriptionstring nullable required
createdAtstring date-time required
updatedAtstring date-time required

Changes