API - Corsair

Every beamer.api.* operation is listed below with parameter shapes and return types from the plugin Zod schemas.

New to Corsair? See API access, authentication, and error handling.

Posts

get

posts.get Get Beamer posts Risk: read

await corsair.beamer.api.posts.get({});

Input

Name	Type	Required	Description
`page`	`number \| string`	No	—
`maxResults`	`number \| string`	No	—

Output: object[]

Output full type

{
  id: number | string,
  date?: string,
  dueDate?: string,
  published?: boolean | true | false,
  pinned?: boolean | true | false,
  showInWidget?: boolean | true | false,
  showInStandalone?: boolean | true | false,
  category?: string,
  boostedAnnouncement?: string,
  translations?: {
    title?: string,
    content?: string,
    contentHtml?: string,
    language?: string,
    category?: string,
    linkUrl?: string | string[],
    linkText?: string | string[],
    images?: string[]
  }[],
  filter?: string,
  filterUrl?: string,
  autoOpen?: boolean | true | false,
  editionDate?: string,
  feedbackEnabled?: boolean | true | false,
  reactionsEnabled?: boolean | true | false,
  views?: number | string,
  uniqueViews?: number | string,
  clicks?: number | string,
  feedbacks?: number | string,
  positiveReactions?: number | string,
  neutralReactions?: number | string,
  negativeReactions?: number | string
}[]