API

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

Attachments

generateUploadUrl

attachments.generateUploadUrl Generate a time-limited pre-signed file upload URL Risk: write

await corsair.connecteam.api.attachments.generateUploadUrl({});

Input

Name	Type	Required	Description
`fileName`	`string`	Yes	—
`featureType`	`chat \| shiftscheduler \| users \| quicktasks`	Yes	—
`fileTypeHint`	`string`	No	—

Output

Name	Type	Required	Description
`requestId`	`string`	No	—
`data`	`object`	Yes	—
`paging`	`object`	No	—

data full type

{
  fileId: string,
  uploadFileUrl: string
}

paging full type

{
  offset?: number
}

Chat

get

chat.get List team chats and channels Risk: read

await corsair.connecteam.api.chat.get({});

Input

Name	Type	Required	Description
`limit`	`number`	No	—
`offset`	`number`	No	—

Output

Name	Type	Required	Description
`requestId`	`string`	No	—
`data`	`object`	Yes	—
`paging`	`object`	No	—

data full type

{
  conversations?: {
    id?: number | string,
    conversationId?: number | string,
    type?: string | null,
    title?: string | null
  }[]
}

paging full type

{
  offset?: number
}

Custom Field Categories

get

customFieldCategories.get List custom field categories Risk: read

await corsair.connecteam.api.customFieldCategories.get({});

Input

Name	Type	Required	Description
`limit`	`number`	No	—
`offset`	`number`	No	—
`ids`	`number[]`	No	—
`names`	`string[]`	No	—

Output

Name	Type	Required	Description
`requestId`	`string`	No	—
`data`	`object`	Yes	—
`paging`	`object`	No	—

data full type

{
  categories: {
    id: number,
    name?: string | null
  }[]
}

paging full type

{
  offset?: number
}

Custom Fields

get

customFields.get List custom fields with optional filters and pagination Risk: read

await corsair.connecteam.api.customFields.get({});

Input

Name	Type	Required	Description
`limit`	`number`	No	—
`offset`	`number`	No	—
`customFieldTypes`	`string[]`	No	—
`customFieldIds`	`number[]`	No	—
`names`	`string[]`	No	—
`categoryIds`	`number[]`	No	—

Output

Name	Type	Required	Description
`requestId`	`string`	No	—
`data`	`object`	Yes	—
`paging`	`object`	No	—

data full type

{
  customFields: {
    id: number,
    name?: string | null,
    type?: string | null,
    categoryId?: number | null,
    isRequired?: boolean | null,
    isVisibleToAllAdmins?: boolean | null,
    isEditableForAllAdmins?: boolean | null,
    isVisibleToUsers?: boolean | null,
    isEditableForUsers?: boolean | null,
    isMultiSelect?: boolean | null,
    dropdownOptions?: any[]
  }[]
}

paging full type

{
  offset?: number
}

Forms

get

forms.get List form definitions Risk: read

await corsair.connecteam.api.forms.get({});

Input

Name	Type	Required	Description
`name`	`string`	No	—
`startDate`	`string`	No	—
`endDate`	`string`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—

Output

Name	Type	Required	Description
`requestId`	`string`	No	—
`data`	`object`	Yes	—
`paging`	`object`	No	—

data full type

{
  forms: {
    formId: number,
    formName?: string | null,
    createdAt?: number | null,
    lastUpdatedAt?: number | null,
    questions?: any[],
    settings?: any
  }[]
}

paging full type

{
  offset?: number
}

Jobs

get

jobs.get List jobs for a scheduler or time clock instance Risk: read

await corsair.connecteam.api.jobs.get({});

Input

Name	Type	Required	Description
`instanceIds`	`number[]`	No	—
`jobIds`	`string[]`	No	—
`jobNames`	`string[]`	No	—
`jobCodes`	`string[]`	No	—
`includeDeleted`	`boolean`	No	—
`sort`	`title`	No	—
`order`	`asc \| desc`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—

Output

Name	Type	Required	Description
`requestId`	`string`	No	—
`data`	`object`	Yes	—
`paging`	`object`	No	—

data full type

{
  jobs: {
    jobId: string,
    title?: string | null,
    code?: string | null,
    color?: string | null,
    description?: string | null,
    gps?: any,
    isDeleted?: boolean | null,
    assign?: any,
    useParentData?: boolean | null,
    parentId?: string | null,
    subJobs?: any[],
    instanceIds?: number[],
    customFields?: any[]
  }[],
  paging?: {
    offset?: number
  }
}

paging full type

{
  offset?: number
}

Me

list

me.list Get Connecteam account company name and company ID Risk: read

await corsair.connecteam.api.me.list({});

Input: empty object Output

Name	Type	Required	Description
`requestId`	`string`	No	—
`data`	`object`	Yes	—
`paging`	`object`	No	—

data full type

{
  companyId: string,
  companyName?: string | null
}

paging full type

{
  offset?: number
}

Performance Indicators

get

performanceIndicators.get List performance metric indicators Risk: read

await corsair.connecteam.api.performanceIndicators.get({});

Input: empty object Output

Name	Type	Required	Description
`requestId`	`string`	No	—
`data`	`object`	Yes	—
`paging`	`object`	No	—

data full type

{
  indicators?: {
    id?: string | number,
    name?: string | null
  }[],
  performanceIndicators?: {
    id?: string | number,
    name?: string | null
  }[]
}

paging full type

{
  offset?: number
}

Policy Types

get

policyTypes.get List time-off policy types Risk: read

await corsair.connecteam.api.policyTypes.get({});

Input: empty object Output

Name	Type	Required	Description
`requestId`	`string`	No	—
`data`	`object`	Yes	—
`paging`	`object`	No	—

data full type

{
  policyTypes?: {
    id?: string | number,
    policyTypeId?: string | number,
    name?: string | null,
    policies?: {
      id?: string | number,
      name?: string | null,
      unit?: string | null,
      accrualType?: string | null
    }[]
  }[],
  policies?: {
    id?: string | number,
    policyTypeId?: string | number,
    name?: string | null,
    policies?: {
      id?: string | number,
      name?: string | null,
      unit?: string | null,
      accrualType?: string | null
    }[]
  }[]
}

paging full type

{
  offset?: number
}

Publishers

get

publishers.get List custom publishers Risk: read

await corsair.connecteam.api.publishers.get({});

Input: empty object Output

Name	Type	Required	Description
`requestId`	`string`	No	—
`data`	`object`	Yes	—
`paging`	`object`	No	—

data full type

{
  publishers?: {
    id?: number,
    publisherId?: number | null,
    name?: string | null
  }[]
}

paging full type

{
  offset?: number
}

Schedulers

get

schedulers.get List job schedulers Risk: read

await corsair.connecteam.api.schedulers.get({});

Input: empty object Output

Name	Type	Required	Description
`requestId`	`string`	No	—
`data`	`object`	Yes	—
`paging`	`object`	No	—

data full type

{
  schedulers: {
    schedulerId: number,
    name?: string | null,
    isArchived?: boolean | null,
    timezone?: string | null
  }[]
}

paging full type

{
  offset?: number
}

Smart Groups

get

smartGroups.get List smart groups Risk: read

await corsair.connecteam.api.smartGroups.get({});

Input

Name	Type	Required	Description
`id`	`number`	No	—
`name`	`string`	No	—

Output

Name	Type	Required	Description
`requestId`	`string`	No	—
`data`	`object`	Yes	—
`paging`	`object`	No	—

data full type

{
  groups?: {
    id?: number,
    smartGroupId?: number | null,
    name?: string | null,
    groupSegmentId?: number | null,
    description?: string | null
  }[],
  smartGroups?: {
    id?: number,
    smartGroupId?: number | null,
    name?: string | null,
    groupSegmentId?: number | null,
    description?: string | null
  }[]
}

paging full type

{
  offset?: number
}

Task Boards

get

taskBoards.get List task boards Risk: read

await corsair.connecteam.api.taskBoards.get({});

Input: empty object Output

Name	Type	Required	Description
`requestId`	`string`	No	—
`data`	`object`	Yes	—
`paging`	`object`	No	—

data full type

{
  taskBoards?: {
    id?: number | string,
    taskBoardId?: number | null,
    name?: string | null,
    title?: string | null,
    isArchived?: boolean | null
  }[],
  taskboards?: {
    id?: number | string,
    taskBoardId?: number | null,
    name?: string | null,
    title?: string | null,
    isArchived?: boolean | null
  }[]
}

paging full type

{
  offset?: number
}

Users

Name	Type	Required	Description
`userIds`	`number[]`	Yes	—

create

users.create Create users in Connecteam Risk: write

await corsair.connecteam.api.users.create({});

Input

Name	Type	Required	Description
`users`	`object[]`	Yes	—
`sendActivation`	`boolean`	No	—

users full type

{
  firstName: string,
  lastName?: string,
  phoneNumber: string,
  email?: string,
  userType?: user,
  isArchived?: boolean,
  customFields?: any[]
}[]

Output

Name	Type	Required	Description
`requestId`	`string`	No	—
`data`	`object`	No	—
`paging`	`object`	No	—

data full type

{
  results?: {
    userId: number,
    firstName?: string | null,
    lastName?: string | null,
    phoneNumber?: string | null,
    userType?: string | null,
    email?: string | null,
    customFields?: any[],
    isArchived?: boolean | null,
    kioskCode?: string | null,
    createdAt?: number | null,
    modifiedAt?: number | null,
    archivedAt?: number | null,
    lastLogin?: number | null,
    smartGroupsIds?: number[],
    invitedToBeManager?: boolean | null,
    profilePictureUrl?: string | null,
    mobileDevice?: string | null,
    osVersion?: string | null,
    appVersion?: string | null,
    mobileDeviceId?: string | null
  }[]
}

paging full type

{
  offset?: number
}

get

users.get List Connecteam users with optional filters and pagination Risk: read

await corsair.connecteam.api.users.get({});

Input

Name	Type	Required	Description
`limit`	`number`	No	—
`offset`	`number`	No	—
`sort`	`created_at`	No	—
`order`	`asc \| desc`	No	—
`userIds`	`number[]`	No	—
`userStatus`	`active \| archived \| all`	No	—
`fullNames`	`string[]`	No	—
`phoneNumbers`	`string[]`	No	—
`emailAddresses`	`string[]`	No	—
`createdAt`	`number`	No	—
`modifiedAt`	`number`	No	—
`lastLogin`	`number`	No	—
`archivedAt`	`number`	No	—

Output

Name	Type	Required	Description
`requestId`	`string`	No	—
`data`	`object`	Yes	—
`paging`	`object`	No	—

data full type

{
  users: {
    userId: number,
    firstName?: string | null,
    lastName?: string | null,
    phoneNumber?: string | null,
    userType?: string | null,
    email?: string | null,
    customFields?: any[],
    isArchived?: boolean | null,
    kioskCode?: string | null,
    createdAt?: number | null,
    modifiedAt?: number | null,
    archivedAt?: number | null,
    lastLogin?: number | null,
    smartGroupsIds?: number[],
    invitedToBeManager?: boolean | null,
    profilePictureUrl?: string | null,
    mobileDevice?: string | null,
    osVersion?: string | null,
    appVersion?: string | null,
    mobileDeviceId?: string | null
  }[]
}

paging full type

{
  offset?: number
}

Overview

Plugins

Attachments

generateUploadUrl

Chat

get

Custom Field Categories

get

Custom Fields

get

Forms

get

Jobs

get

Me

list

Performance Indicators

get

Policy Types

get

Publishers

get

Schedulers

get

Smart Groups

get

Task Boards

get

Users

archive

create

get

​Attachments

​generateUploadUrl

​Chat

​get

​Custom Field Categories

​get

​Custom Fields

​get

​Forms

​get

​Jobs

​get

​Me

​list

​Performance Indicators

​get

​Policy Types

​get

​Publishers

​get

​Schedulers

​get

​Smart Groups

​get

​Task Boards

​get

​Users

​archive

​create

​get

Attachments

generateUploadUrl

Chat

get

Custom Field Categories

get

Custom Fields

get

Forms

get

Jobs

get

Me

list

Performance Indicators

get

Policy Types

get

Publishers

get

Schedulers

get

Smart Groups

get

Task Boards

get

Users

archive

create

get