v1

latestOpenAPI 3.0.3Apache 2.02026-07-142201861.5 MB
Users

List Your Organizations

Return a list of organizations available to the authenticated session in a region. This is particularly useful for requests with a user bound context. For API key-based requests this will only return the organization that belongs to the key.

get/api/0/organizations/

Query parameters

ownerboolean

Specify true to restrict results to organizations in which you are an owner.

cursorstring

A pointer to the last object fetched and its sort order; used to retrieve the next or previous results.

querystring

Filters results by using query syntax.

Valid query fields include:

  • id: The organization ID
  • slug: The organization slug
  • status: The organization's current status (one of active, pending_deletion, or deletion_in_progress)
  • email or member_id: Filter your organizations by the emails or organization member IDs of specific members included
  • query: Filter your organizations by name, slug, and members that contain this substring

Example: query=(slug:foo AND status:active) OR (email:[thing-one@example.com,thing-two@example.com] AND query:bar)

sortBystring

The field to sort results by, in descending order. If not specified the results are sorted by the date they were created.

Valid fields include:

  • members: By number of members
  • events: By number of events in the past 24 hours
per_pageinteger

Limit the number of rows to return in the result. Default and maximum allowed is 100.

Response

featuresstring[]
extraOptionsobject
accessstring[]
idstring required
slugstring required
namestring required
dateCreatedstring date-time required
isEarlyAdopterboolean required
require2FAboolean required
hasAuthProviderboolean required
allowMemberInviteboolean required
allowMemberProjectCreationboolean required
allowSuperuserAccessboolean required