Titles
Defined in: src/team/client.gen.ts:387
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new Titles(
_core):Titles
Defined in: src/team/client.gen.ts:388
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Titles
Methods
Section titled “Methods”create()
Section titled “create()”create(
body,options?):Promise<{id:string;name:string; }>
Defined in: src/team/client.gen.ts:398
Create title
This endpoint creates a new title
POST /v2/titles — requires OAuth scope: titles
Supports an optional Idempotency-Key via options.idempotencyKey.
Parameters
Section titled “Parameters”string
Description
Name of the title
options?
Section titled “options?”Returns
Section titled “Returns”Promise<{ id: string; name: string; }>
get(
id,options?):Promise<{id:string;name:string; }>
Defined in: src/team/client.gen.ts:416
Get title
This endpoint gets a title by ID.
GET /v2/titles/{id} — requires OAuth scope: titles, titles.readonly
Parameters
Section titled “Parameters”string
options?
Section titled “options?”Returns
Section titled “Returns”Promise<{ id: string; name: string; }>
list()
Section titled “list()”list(
query?,options?):PagePromise<{items:object[];next_cursor?:string|null; }>
Defined in: src/team/client.gen.ts:433
List titles
This endpoint lists all titles.
GET /v2/titles — requires OAuth scope: titles, titles.readonly
Await for a single page, or for await to iterate items across all pages.
Parameters
Section titled “Parameters”query?
Section titled “query?”cursor?
Section titled “cursor?”string | null
limit?
Section titled “limit?”number | null
string | null
options?
Section titled “options?”Returns
Section titled “Returns”PagePromise<{ items: object[]; next_cursor?: string | null; }>