Companies
Defined in: src/team/client.gen.ts:205
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new Companies(
_core):Companies
Defined in: src/team/client.gen.ts:206
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Companies
Methods
Section titled “Methods”get(
options?):Promise<{accountType:"BREX_CLASSIC"|"BREX_EMPOWER";id:string;legal_name:string;mailing_address: {city?:string|null;country?:string|null;line1?:string|null;line2?:string|null;phone_number?:string|null;postal_code?:string|null;state?:string|null; }; }>
Defined in: src/team/client.gen.ts:215
Get company
This endpoint returns the company associated with the OAuth2 access token.
GET /v2/company — requires OAuth scope: companies.readonly
Parameters
Section titled “Parameters”options?
Section titled “options?”Returns
Section titled “Returns”Promise<{ accountType: "BREX_CLASSIC" | "BREX_EMPOWER"; id: string; legal_name: string; mailing_address: { city?: string | null; country?: string | null; line1?: string | null; line2?: string | null; phone_number?: string | null; postal_code?: string | null; state?: string | null; }; }>