API

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

Properties

clone

properties.clone Clone a property, creating a new property with inventory and rate plans Risk: write

await corsair.apaleo.api.properties.clone({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`code`	`string`	Yes	—
`name`	`object`	Yes	—
`companyName`	`string`	Yes	—
`managingDirectors`	`string`	No	—
`commercialRegisterEntry`	`string`	Yes	—
`taxId`	`string`	Yes	—
`description`	`object`	No	—
`location`	`object`	Yes	—
`bankAccount`	`object`	No	—
`paymentTerms`	`object`	Yes	—
`timeZone`	`string`	Yes	—
`defaultCheckInTime`	`string`	Yes	—
`defaultCheckOutTime`	`string`	Yes	—
`currencyCode`	`string`	Yes	—

name full type

{
}

description full type

{
}

location full type

{
  addressLine1: string,
  addressLine2?: string | null,
  postalCode: string,
  city: string,
  regionCode?: string | null,
  countryCode: string
}

bankAccount full type

{
  iban?: string,
  bic?: string,
  bank?: string
}

paymentTerms full type

{
}

Output

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

count

properties.count Return total count of properties Risk: read

await corsair.apaleo.api.properties.count({});

Input

Name	Type	Required	Description
`status`	`Test \| Live[]`	No	—
`includeArchived`	`boolean`	No	—
`countryCode`	`string[]`	No	—

Output

Name	Type	Required	Description
`count`	`number`	Yes	—

countries

properties.countries List ISO country codes that can be used to create properties Risk: read

await corsair.apaleo.api.properties.countries({});

Input: empty object Output

Name	Type	Required	Description
`countryCodes`	`string[]`	Yes	—

create

properties.create Create a new property Risk: write

await corsair.apaleo.api.properties.create({});

Input

Name	Type	Required	Description
`code`	`string`	Yes	—
`name`	`object`	Yes	—
`companyName`	`string`	Yes	—
`managingDirectors`	`string`	No	—
`commercialRegisterEntry`	`string`	Yes	—
`taxId`	`string`	Yes	—
`description`	`object`	No	—
`location`	`object`	Yes	—
`bankAccount`	`object`	No	—
`paymentTerms`	`object`	Yes	—
`timeZone`	`string`	Yes	—
`defaultCheckInTime`	`string`	Yes	—
`defaultCheckOutTime`	`string`	Yes	—
`currencyCode`	`string`	Yes	—

name full type

{
}

description full type

{
}

location full type

{
  addressLine1: string,
  addressLine2?: string | null,
  postalCode: string,
  city: string,
  regionCode?: string | null,
  countryCode: string
}

bankAccount full type

{
  iban?: string,
  bic?: string,
  bank?: string
}

paymentTerms full type

{
}

Output

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

exists

properties.exists Check if a property exists by id Risk: read

await corsair.apaleo.api.properties.exists({});

Input

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

Output

Name	Type	Required	Description
`exists`	`boolean`	Yes	—

get

properties.get Get a property by id Risk: read

await corsair.apaleo.api.properties.get({});

Input

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

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`code`	`string`	Yes	—
`propertyTemplateId`	`string`	No	—
`isTemplate`	`boolean`	Yes	—
`name`	`object`	Yes	—
`description`	`object`	No	—
`companyName`	`string`	Yes	—
`managingDirectors`	`string`	No	—
`commercialRegisterEntry`	`string`	Yes	—
`taxId`	`string`	Yes	—
`location`	`object`	Yes	—
`bankAccount`	`object`	No	—
`paymentTerms`	`object`	Yes	—
`timeZone`	`string`	Yes	—
`currencyCode`	`string`	Yes	—
`created`	`string`	Yes	—
`status`	`string`	Yes	—
`isArchived`	`boolean`	Yes	—
`actions`	`object[]`	No	—

name full type

string | {
}

description full type

string | {
}

location full type

{
  addressLine1?: string | null,
  addressLine2?: string | null,
  postalCode?: string | null,
  city?: string | null,
  regionCode?: string | null,
  countryCode?: string | null
}

bankAccount full type

{
  iban?: string | null,
  bic?: string | null,
  bank?: string | null
}

paymentTerms full type

{
}

actions full type

{
  action?: string | null,
  isAllowed?: boolean | null,
  reasons?: {
    code?: string | null,
    message?: string | null
  }[] | null
}[]

list

properties.list Get the list of properties Risk: read

await corsair.apaleo.api.properties.list({});

Input

Name	Type	Required	Description
`status`	`Test \| Live[]`	No	—
`includeArchived`	`boolean`	No	—
`countryCode`	`string[]`	No	—
`expand`	`string[]`	No	—
`pageNumber`	`number`	No	—
`pageSize`	`number`	No	—

Output

Name	Type	Required	Description
`properties`	`object[]`	Yes	—
`count`	`number`	Yes	—

properties full type

{
  id: string,
  code: string,
  propertyTemplateId?: string | null,
  isTemplate: boolean,
  name: string | {
  },
  description?: string | {
  } | null,
  companyName: string,
  managingDirectors?: string | null,
  commercialRegisterEntry: string,
  taxId: string,
  location: {
    addressLine1?: string | null,
    addressLine2?: string | null,
    postalCode?: string | null,
    city?: string | null,
    regionCode?: string | null,
    countryCode?: string | null
  },
  bankAccount?: {
    iban?: string | null,
    bic?: string | null,
    bank?: string | null
  } | null,
  paymentTerms: {
  },
  timeZone: string,
  currencyCode: string,
  created: string,
  status: string,
  isArchived: boolean,
  actions?: {
    action?: string | null,
    isAllowed?: boolean | null,
    reasons?: {
      code?: string | null,
      message?: string | null
    }[] | null
  }[] | null
}[]

reset

properties.reset Delete transactional data for a property in Test status Risk: write

await corsair.apaleo.api.properties.reset({});

Input

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

Output

Name	Type	Required	Description
`ok`	`true`	Yes	—

setLive

properties.setLive Move a test property to Live status Risk: write

await corsair.apaleo.api.properties.setLive({});

Input

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

Output

Name	Type	Required	Description
`ok`	`true`	Yes	—

Unit Attributes

create

unitAttributes.create Create a new unit attribute Risk: write

await corsair.apaleo.api.unitAttributes.create({});

Input

Name	Type	Required	Description
`name`	`string`	Yes	—
`description`	`string`	No	—

Output

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

delete

unitAttributes.delete Delete a unit attribute Risk: write

await corsair.apaleo.api.unitAttributes.delete({});

Input

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

Output

Name	Type	Required	Description
`ok`	`true`	Yes	—

exists

unitAttributes.exists Check if a unit attribute exists Risk: read

await corsair.apaleo.api.unitAttributes.exists({});

Input

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

Output

Name	Type	Required	Description
`exists`	`boolean`	Yes	—

get

unitAttributes.get Get a unit attribute by id Risk: read

await corsair.apaleo.api.unitAttributes.get({});

Input

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

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	Yes	—
`description`	`string`	No	—

list

unitAttributes.list Get the unit attribute list Risk: read

await corsair.apaleo.api.unitAttributes.list({});

Input

Name	Type	Required	Description
`pageNumber`	`number`	No	—
`pageSize`	`number`	No	—

Output

Name	Type	Required	Description
`unitAttributes`	`object[]`	Yes	—
`count`	`number`	Yes	—

unitAttributes full type

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

Unit Groups

count

unitGroups.count Return number of unit groups matching the filter Risk: read

await corsair.apaleo.api.unitGroups.count({});

Input

Name	Type	Required	Description
`propertyId`	`string`	No	—
`unitGroupTypes`	`BedRoom \| MeetingRoom \| EventSpace \| ParkingLot \| Other[]`	No	—

Output

Name	Type	Required	Description
`count`	`number`	Yes	—

create

unitGroups.create Create a new unit group Risk: write

await corsair.apaleo.api.unitGroups.create({});

Input

Name	Type	Required	Description
`code`	`string`	Yes	—
`propertyId`	`string`	Yes	—
`name`	`object`	Yes	—
`description`	`object`	Yes	—
`maxPersons`	`number`	Yes	—
`rank`	`number`	No	—
`type`	`BedRoom \| MeetingRoom \| EventSpace \| ParkingLot`	No	—
`connectedUnitGroups`	`object[]`	No	—

name full type

{
}

description full type

{
}

connectedUnitGroups full type

{
  unitGroupId: string,
  memberCount: number
}[]

Output

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

delete

unitGroups.delete Delete a unit group Risk: write

await corsair.apaleo.api.unitGroups.delete({});

Input

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

Output

Name	Type	Required	Description
`ok`	`true`	Yes	—

exists

unitGroups.exists Check if a unit group exists by id Risk: read

await corsair.apaleo.api.unitGroups.exists({});

Input

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

Output

Name	Type	Required	Description
`exists`	`boolean`	Yes	—

get

unitGroups.get Get a unit group by id Risk: read

await corsair.apaleo.api.unitGroups.get({});

Input

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

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`code`	`string`	Yes	—
`property`	`object`	Yes	—
`name`	`object`	Yes	—
`memberCount`	`number`	Yes	—
`description`	`object`	Yes	—
`maxPersons`	`number`	Yes	—
`rank`	`number`	No	—
`type`	`string`	Yes	—
`connectedUnitGroups`	`object[]`	No	—

property full type

{
  id?: string | null,
  code?: string | null,
  name?: string | null,
  description?: string | null
}

name full type

string | {
}

description full type

string | {
}

connectedUnitGroups full type

{
  id: string,
  name: string,
  description: string,
  memberCount: number,
  maxPersons?: number | null
}[]

list

unitGroups.list Get the list of unit groups Risk: read

await corsair.apaleo.api.unitGroups.list({});

Input

Name	Type	Required	Description
`propertyId`	`string`	No	—
`unitGroupTypes`	`BedRoom \| MeetingRoom \| EventSpace \| ParkingLot \| Other[]`	No	—
`expand`	`string[]`	No	—
`pageNumber`	`number`	No	—
`pageSize`	`number`	No	—

Output

Name	Type	Required	Description
`unitGroups`	`object[]`	Yes	—
`count`	`number`	Yes	—

unitGroups full type

{
  id: string,
  code: string,
  property: {
    id?: string | null,
    code?: string | null,
    name?: string | null,
    description?: string | null
  },
  name: string | {
  },
  memberCount: number,
  description: string | {
  },
  maxPersons: number,
  rank?: number | null,
  type: string,
  connectedUnitGroups?: {
    id: string,
    name: string,
    description: string,
    memberCount: number,
    maxPersons?: number | null
  }[] | null
}[]

replace

unitGroups.replace Replace a unit group Risk: write

await corsair.apaleo.api.unitGroups.replace({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`object`	Yes	—
`description`	`object`	Yes	—
`maxPersons`	`number`	No	—
`rank`	`number`	No	—
`connectedUnitGroups`	`object[]`	No	—

name full type

{
}

description full type

{
}

connectedUnitGroups full type

{
  unitGroupId: string,
  memberCount: number
}[]

Output

Name	Type	Required	Description
`ok`	`true`	Yes	—

Units

count

units.count Return number of units matching the filter Risk: read

await corsair.apaleo.api.units.count({});

Input

Name	Type	Required	Description
`propertyId`	`string`	No	—
`unitGroupId`	`string`	No	—
`unitGroupIds`	`string[]`	No	—
`unitAttributeIds`	`string[]`	No	—
`isOccupied`	`boolean`	No	—
`maintenanceType`	`OutOfService \| OutOfOrder \| OutOfInventory`	No	—
`condition`	`Clean \| CleanToBeInspected \| Dirty`	No	—
`textSearch`	`string`	No	—
`status`	`Active \| Archived \| All`	No	—

Output

Name	Type	Required	Description
`count`	`number`	Yes	—

create

units.create Create a new unit Risk: write

await corsair.apaleo.api.units.create({});

Input

Name	Type	Required	Description
`propertyId`	`string`	Yes	—
`name`	`string`	Yes	—
`description`	`object`	Yes	—
`unitGroupId`	`string`	No	—
`maxPersons`	`number`	Yes	—
`condition`	`Clean \| CleanToBeInspected \| Dirty`	No	—
`attributes`	`object[]`	No	—
`connectedUnits`	`object[]`	No	—

description full type

{
}

attributes full type

{
  id: string
}[]

connectedUnits full type

{
  unitId: string
}[]

Output

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

createBulk

units.createBulk Create multiple units Risk: write

await corsair.apaleo.api.units.createBulk({});

Input

Name	Type	Required	Description
`units`	`object[]`	Yes	—

units full type

{
  propertyId: string,
  name: string,
  description: {
  },
  unitGroupId?: string | null,
  maxPersons: number,
  condition?: Clean | CleanToBeInspected | Dirty | null,
  attributes?: {
    id: string
  }[] | null,
  connectedUnits?: {
    unitId: string
  }[] | null
}[]

Output

Name	Type	Required	Description
`ids`	`string[]`	Yes	—

delete

units.delete Delete a unit Risk: write

await corsair.apaleo.api.units.delete({});

Input

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

Output

Name	Type	Required	Description
`ok`	`true`	Yes	—

exists

units.exists Check if a unit exists by id Risk: read

await corsair.apaleo.api.units.exists({});

Input

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

Output

Name	Type	Required	Description
`exists`	`boolean`	Yes	—

get

units.get Get a unit by id Risk: read

await corsair.apaleo.api.units.get({});

Input

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

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	Yes	—
`description`	`object`	Yes	—
`property`	`object`	Yes	—
`unitGroup`	`object`	No	—
`connectingUnit`	`object`	No	—
`status`	`object`	Yes	—
`maxPersons`	`number`	Yes	—
`created`	`string`	Yes	—
`archived`	`string`	No	—
`isArchived`	`boolean`	No	—
`attributes`	`object[]`	No	—
`connectedUnits`	`object[]`	No	—
`actions`	`object[]`	No	—

description full type

string | {
}

property full type

{
  id?: string | null,
  code?: string | null,
  name?: string | null,
  description?: string | null
}

unitGroup full type

{
  id?: string | null,
  code?: string | null,
  name?: string | null,
  description?: string | null,
  type?: string | null
}

connectingUnit full type

{
  id?: string | null,
  name?: string | null,
  description?: string | null,
  unitGroupId?: string | null
}

status full type

{
  isOccupied?: boolean | null,
  condition?: string | null,
  maintenance?: {
    id?: string | null,
    from?: string | null,
    to?: string | null,
    type?: string | null,
    description?: string | null
  } | null
}

attributes full type

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

connectedUnits full type

{
  id?: string | null,
  name?: string | null,
  description?: string | null,
  unitGroupId?: string | null,
  condition?: string | null,
  maxPersons?: number | null
}[]

actions full type

{
  action?: string | null,
  isAllowed?: boolean | null,
  reasons?: {
    code?: string | null,
    message?: string | null
  }[] | null
}[]

list

units.list Get the list of units Risk: read

await corsair.apaleo.api.units.list({});

Input

Name	Type	Required	Description
`propertyId`	`string`	No	—
`unitGroupId`	`string`	No	—
`unitGroupIds`	`string[]`	No	—
`unitAttributeIds`	`string[]`	No	—
`isOccupied`	`boolean`	No	—
`maintenanceType`	`OutOfService \| OutOfOrder \| OutOfInventory`	No	—
`condition`	`Clean \| CleanToBeInspected \| Dirty`	No	—
`textSearch`	`string`	No	—
`status`	`Active \| Archived \| All`	No	—
`expand`	`string[]`	No	—
`pageNumber`	`number`	No	—
`pageSize`	`number`	No	—

Output

Name	Type	Required	Description
`units`	`object[]`	Yes	—
`count`	`number`	Yes	—

units full type

{
  id: string,
  name: string,
  description: string | {
  },
  property: {
    id?: string | null,
    code?: string | null,
    name?: string | null,
    description?: string | null
  },
  unitGroup?: {
    id?: string | null,
    code?: string | null,
    name?: string | null,
    description?: string | null,
    type?: string | null
  } | null,
  connectingUnit?: {
    id?: string | null,
    name?: string | null,
    description?: string | null,
    unitGroupId?: string | null
  } | null,
  status: {
    isOccupied?: boolean | null,
    condition?: string | null,
    maintenance?: {
      id?: string | null,
      from?: string | null,
      to?: string | null,
      type?: string | null,
      description?: string | null
    } | null
  },
  maxPersons: number,
  created: string,
  archived?: string | null,
  isArchived?: boolean | null,
  attributes?: {
    id?: string | null,
    name?: string | null,
    description?: string | null
  }[] | null,
  connectedUnits?: {
    id?: string | null,
    name?: string | null,
    description?: string | null,
    unitGroupId?: string | null,
    condition?: string | null,
    maxPersons?: number | null
  }[] | null,
  actions?: {
    action?: string | null,
    isAllowed?: boolean | null,
    reasons?: {
      code?: string | null,
      message?: string | null
    }[] | null
  }[] | null
}[]

Overview

Plugins

Properties

archive

clone

count

countries

create

exists

get

list

reset

setLive

Unit Attributes

create

delete

exists

get

list

Unit Groups

count

create

delete

exists

get

list

replace

Units

count

create

createBulk

delete

exists

get

list

​Properties

​archive

​clone

​count

​countries

​create

​exists

​get

​list

​reset

​setLive

​Unit Attributes

​create

​delete

​exists

​get

​list

​Unit Groups

​count

​create

​delete

​exists

​get

​list

​replace

​Units

​count

​create

​createBulk

​delete

​exists

​get

​list

Properties

archive

clone

count

countries

create

exists

get

list

reset

setLive

Unit Attributes

create

delete

exists

get

list

Unit Groups

count

create

delete

exists

get

list

replace

Units

count

create

createBulk

delete

exists

get

list