API

Every certifier.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.

Attributes

list

attributes.list List attribute definitions available for credentials, with pagination. Risk: read

await corsair.certifier.api.attributes.list({});

Input

Name	Type	Required	Description
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`pagination`	`object`	No	—

data full type

{
  id?: string,
  tag?: string,
  name?: string,
  type?: string
}[]

pagination full type

{
  prev?: string | null,
  next?: string | null
}

Credential Interactions

list

credentialInteractions.list List credential interaction events, optionally filtered by credential. Risk: read

await corsair.certifier.api.credentialInteractions.list({});

Input

Name	Type	Required	Description
`limit`	`number`	No	—
`cursor`	`string`	No	—
`credentialId`	`string`	No	—

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`pagination`	`object`	No	—

data full type

{
  id: string,
  credentialId?: string,
  eventType?: string,
  triggeredBy?: string,
  triggeredAt?: string
}[]

pagination full type

{
  prev?: string | null,
  next?: string | null
}

Credentials

createIssueSend

credentials.createIssueSend Create, issue, and send a credential in a single request. Risk: write

await corsair.certifier.api.credentials.createIssueSend({});

Input

Name	Type	Required	Description
`groupId`	`string`	Yes	—
`recipient`	`object`	Yes	—
`issueDate`	`string`	No	—
`expiryDate`	`string`	No	—
`customAttributes`	`object`	No	—

recipient full type

{
  name: string,
  email: string
}

customAttributes full type

{
}

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`publicId`	`string`	No	—
`groupId`	`string`	No	—
`status`	`string`	No	—
`recipient`	`object`	No	—
`issueDate`	`string`	No	—
`expiryDate`	`string`	No	—
`attributes`	`object`	No	—
`customAttributes`	`object`	No	—
`createdAt`	`string`	No	—
`updatedAt`	`string`	No	—

recipient full type

{
  id?: string,
  name?: string,
  email?: string
}

attributes full type

{
}

customAttributes full type

{
}

list

credentials.list List credentials with cursor pagination. Risk: read

await corsair.certifier.api.credentials.list({});

Input

Name	Type	Required	Description
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`pagination`	`object`	No	—

data full type

{
  id: string,
  publicId?: string,
  groupId?: string,
  status?: string,
  recipient?: {
    id?: string,
    name?: string,
    email?: string
  },
  issueDate?: string | null,
  expiryDate?: string | null,
  attributes?: {
  },
  customAttributes?: {
  },
  createdAt?: string,
  updatedAt?: string
}[]

pagination full type

{
  prev?: string | null,
  next?: string | null
}

search

credentials.search Search credentials with AND/OR/NOT filters, sort, and pagination. Risk: read

await corsair.certifier.api.credentials.search({});

Input

Name	Type	Required	Description
`filter`	`object`	Yes	—
`sort`	`object`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

filter full type

{
}

sort full type

{
  property: id | createdAt | updatedAt | issueDate | expiryDate,
  order: asc | desc
}

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`pagination`	`object`	No	—

data full type

{
  id: string,
  publicId?: string,
  groupId?: string,
  status?: string,
  recipient?: {
    id?: string,
    name?: string,
    email?: string
  },
  issueDate?: string | null,
  expiryDate?: string | null,
  attributes?: {
  },
  customAttributes?: {
  },
  createdAt?: string,
  updatedAt?: string
}[]

pagination full type

{
  prev?: string | null,
  next?: string | null
}

send

credentials.send Send an issued credential by email. Risk: write

await corsair.certifier.api.credentials.send({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`deliveryMethod`	`email`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`publicId`	`string`	No	—
`groupId`	`string`	No	—
`status`	`string`	No	—
`recipient`	`object`	No	—
`issueDate`	`string`	No	—
`expiryDate`	`string`	No	—
`attributes`	`object`	No	—
`customAttributes`	`object`	No	—
`createdAt`	`string`	No	—
`updatedAt`	`string`	No	—

recipient full type

{
  id?: string,
  name?: string,
  email?: string
}

attributes full type

{
}

customAttributes full type

{
}

Designs

list

designs.list List certificate and badge design templates. Risk: read

await corsair.certifier.api.designs.list({});

Input

Name	Type	Required	Description
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`pagination`	`object`	No	—

data full type

{
  id: string,
  name?: string,
  type?: string,
  previewUrl?: string | null,
  createdAt?: string,
  updatedAt?: string
}[]

pagination full type

{
  prev?: string | null,
  next?: string | null
}

Email Templates

list

emailTemplates.list List email templates used for credential delivery. Risk: read

await corsair.certifier.api.emailTemplates.list({});

Input

Name	Type	Required	Description
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`pagination`	`object`	No	—

data full type

{
  id: string,
  name?: string,
  subject?: string
}[]

pagination full type

{
  prev?: string | null,
  next?: string | null
}

Groups

list

groups.list List credential templates (groups) with pagination. Risk: read

await corsair.certifier.api.groups.list({});

Input

Name	Type	Required	Description
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`pagination`	`object`	No	—

data full type

{
  id: string,
  name?: string,
  designIds?: string[],
  certificateDesignId?: string | null,
  badgeDesignId?: string | null,
  emailTemplateId?: string | null,
  createdAt?: string,
  updatedAt?: string
}[]

pagination full type

{
  prev?: string | null,
  next?: string | null
}

Overview

Plugins

Attributes

list

Credential Interactions

list

Credentials

createIssueSend

list

search

send

Designs

list

Email Templates

list

Groups

list

​Attributes

​list

​Credential Interactions

​list

​Credentials

​createIssueSend

​list

​search

​send

​Designs

​list

​Email Templates

​list

​Groups

​list

Attributes

list

Credential Interactions

list

Credentials

createIssueSend

list

search

send

Designs

list

Email Templates

list

Groups

list