client.organizations
Accessed via client.organizations.
Methods
create
Create an organization.
TypeScript
create(params: CreateOrganizationParams): Promise<Organization>Types: CreateOrganizationParams · Organization
delete
Soft-delete an organization.
TypeScript
delete(params: DeleteOrganizationParams): Promise<SuccessResponse>Types: DeleteOrganizationParams · SuccessResponse
list
List organizations.
TypeScript
list(params?: Omit<ListOrganizationsParams, "filter" | "orderBy"> & { filter?: OrganizationFilter; orderBy?: OrganizationOrderBy[]; } & OrganizationShorthands): Promise<Page<Organization>>Types: ListOrganizationsParams · OrganizationFilter · OrganizationOrderBy · OrganizationShorthands · Page · Organization
purge
Permanently delete a soft-deleted organization.
TypeScript
purge(params: PurgeOrganizationParams): Promise<SuccessResponse>Types: PurgeOrganizationParams · SuccessResponse
restore
Restore a soft-deleted organization.
TypeScript
restore(params: RestoreOrganizationParams): Promise<Organization>Types: RestoreOrganizationParams · Organization
retrieve
Get an organization by ID.
TypeScript
retrieve(params: RetrieveOrganizationParams): Promise<Organization>Types: RetrieveOrganizationParams · Organization
retrieveByHandle
Fetch an organization by handle. GET /api/organizations/by-handle/:handle
TypeScript
retrieveByHandle(params: { handle: string }): Promise<Organization>Types: Organization
update
Update an organization.
TypeScript
update(params: UpdateOrganizationParams): Promise<Organization>Types: UpdateOrganizationParams · Organization