API

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

Organisation

get

organisation.get Retrieve the organisation’s details Risk: read

await corsair.streamtime.api.organisation.get({});

Input: empty object Output

Name	Type	Required	Description
`name`	`string`	Yes	Organisation name
`domain`	`string`	Yes	Organisation domain
`currency`	`object`	Yes	Default customer currency
`address`	`string`	Yes	Organisation address (default branch)
`country`	`object`	Yes	Organisation country

currency full type

{
  id: string,
  name: string,
  symbol: string
}

country full type

{
  id: string,
  name: string
}

Roles

get

roles.get Retrieve a role by ID Risk: read

await corsair.streamtime.api.roles.get({});

Input

Name	Type	Required	Description
`role_id`	`number`	Yes	Role ID

Output

Name	Type	Required	Description
`id`	`number`	Yes	The ID of the role
`name`	`string`	Yes	The name of the role
`active`	`boolean`	Yes	Whether the role is active or archived

list

roles.list Retrieve all roles in the organisation Risk: read

await corsair.streamtime.api.roles.list({});

Input: empty object Output: object[]

Output full type

{
  id: number,
  name: string,
  active: boolean
}[]

Users

listSavedSegments

users.listSavedSegments Retrieve saved segments for a specific user Risk: read

await corsair.streamtime.api.users.listSavedSegments({});

Input

Name	Type	Required	Description
`user_id`	`number`	Yes	User ID

Output: object[]

Output full type

{
  id?: number | null,
  userId: number,
  savedSegmentType: {
    id: number,
    name?: string
  },
  name: string,
  value: string
}[]

Overview

Plugins

Organisation

get

Roles

get

list

Users

listSavedSegments

​Organisation

​get

​Roles

​get

​list

​Users

​listSavedSegments

Organisation

get

Roles

get

list

Users

listSavedSegments