Skip to content

admin

Accessed as client.admin; the async client mirrors it.

Admin

The admin namespace.

actions

actions: AdminActions = AdminActions(client)

cron

cron: AdminCron = AdminCron(client)

emails

emails: AdminEmails = AdminEmails(client)

hooks

hooks: AdminHooks = AdminHooks(client)

quota

quota: AdminQuota = AdminQuota(client)

runners

runners: AdminRunners = AdminRunners(client)

unadopted

unadopted: AdminUnadopted = AdminUnadopted(client)

users

users: AdminUsers = AdminUsers(client)

orgs

orgs(*, page: int | None = None, limit: int | None = None) -> Paginated[Organization]

List all organizations.

Parameters:

Name Type Description Default
page int | None

1-based page to start iteration at.

None
limit int | None

Page size; the instance caps it server-side.

None

Returns:

Type Description
Paginated[Organization]

OrganizationList.

Raises:

Type Description
ForbiddenError
  1. APIForbiddenError is a forbidden error response.

Operation ID: adminGetAllOrgs

AsyncAdmin

The admin namespace.

actions

cron

emails

hooks

quota

runners

unadopted

users

orgs

orgs(*, page: int | None = None, limit: int | None = None) -> AsyncPaginated[Organization]

List all organizations.

Parameters:

Name Type Description Default
page int | None

1-based page to start iteration at.

None
limit int | None

Page size; the instance caps it server-side.

None

Returns:

Type Description
AsyncPaginated[Organization]

OrganizationList.

Raises:

Type Description
ForbiddenError
  1. APIForbiddenError is a forbidden error response.

Operation ID: adminGetAllOrgs