Orbit Orgs API

Organization endpoints

GitHub OpenAPI

Operations 4

GET /api/v1/orgs List the caller's organizations #
POST /api/v1/orgs Create an organization #
GET /api/v1/orgs/{id} Get an organization #
PATCH /api/v1/orgs/{id} Update an organization #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/orbitapps-io:orbitapps-io-orgs-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

orbitapps-io-orgs-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Orbit Apps Orgs API
  version: 1.0.0
  description: Public REST API for Orbit Apps.
servers:
- url: https://api.orbitapps.io
  description: Production
security:
- bearerAuth: []
tags:
- name: Orgs
  description: Organization endpoints
paths:
  /api/v1/orgs:
    get:
      responses:
        '200':
          description: Visible organizations.
          content:
            application/json:
              schema:
                title: OrganizationList
                description: Paginated-ready envelope. v1 returns the entire visible set in `data`; future revisions may add pagination cursors alongside.
                type: object
                properties:
                  data:
                    type: array
                    items:
                      title: Organization
                      description: Public projection of an organization the caller can see. Mutable fields are exposed via PATCH /api/v1/orgs/{id}.
                      type: object
                      properties:
                        id:
                          description: Stable UUIDv7 identifier. Use this in path params.
                          type: string
                          format: uuid
                        display_name:
                          description: Human-readable org name shown in UI. Required, 1-200 chars.
                          type: string
                        description:
                          description: Optional short blurb. May be null.
                          oneOf:
                          - type: string
                          - type: 'null'
                        image:
                          description: Optional logo URL. May be null.
                          oneOf:
                          - type: string
                          - type: 'null'
                        settings:
                          description: Free-form org-level settings map. Treat as opaque to other tools.
                          oneOf:
                          - type: object
                            additionalProperties: {}
                          - type: 'null'
                        archived:
                          description: True once the org has been archived. Archived orgs remain visible to existing members but can't be PATCHed via this api.
                          type: boolean
                        created_at:
                          description: RFC 3339 timestamp. Stable across PATCHes.
                          type: string
                        updated_at:
                          description: RFC 3339 timestamp of the most recent PATCH or system mutation.
                          type: string
                      required:
                      - id
                      - display_name
                      - settings
                      - archived
                      - created_at
                      - updated_at
                      additionalProperties: false
                required:
                - data
                additionalProperties: false
      tags:
      - Orgs
      summary: List the caller's organizations
      description: 'Returns every organization the calling token can read.


        Scope semantics:

        • profile-scoped tokens → all orgs where the caller has an active member row.

        • org-scoped tokens → a single-element array containing the token''s own org.


        Use this as your first call after authenticating: it tells you which org_ids are addressable for subsequent /api/v1/orgs/{id} and /api/v1/apps requests.'
      operationId: getApiV1Orgs
      x-operation-id-source: derived
    post:
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                display_name:
                  allOf:
                  - type: string
                  - {}
              required:
              - display_name
              additionalProperties: false
      responses:
        '201':
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    format: uuid
                  display_name:
                    type: string
                required:
                - id
                - display_name
                additionalProperties: false
        '400':
          content:
            application/json:
              schema:
                type: object
                properties: {}
                additionalProperties: false
        '403':
          content:
            application/json:
              schema:
                type: object
                properties: {}
                additionalProperties: false
        '404':
          content:
            application/json:
              schema:
                type: object
                properties: {}
                additionalProperties: false
        '409':
          content:
            application/json:
              schema:
                type: object
                properties: {}
                additionalProperties: false
      tags:
      - Orgs
      summary: Create an organization
      description: Requires a profile token with write:org access. Creates the owner membership, billing account, and wallet, then activates the organization. The owner slot limit applies.
      operationId: postApiV1Orgs
      x-operation-id-source: derived
  /api/v1/orgs/{id}:
    get:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
          format: uuid
        description: Org id from GET /api/v1/orgs
      responses:
        '200':
          description: The org row.
          content:
            application/json:
              schema:
                title: Organization
                description: Public projection of an organization the caller can see. Mutable fields are exposed via PATCH /api/v1/orgs/{id}.
                type: object
                properties:
                  id:
                    description: Stable UUIDv7 identifier. Use this in path params.
                    type: string
                    format: uuid
                  display_name:
                    description: Human-readable org name shown in UI. Required, 1-200 chars.
                    type: string
                  description:
                    description: Optional short blurb. May be null.
                    oneOf:
                    - type: string
                    - type: 'null'
                  image:
                    description: Optional logo URL. May be null.
                    oneOf:
                    - type: string
                    - type: 'null'
                  settings:
                    description: Free-form org-level settings map. Treat as opaque to other tools.
                    oneOf:
                    - type: object
                      additionalProperties: {}
                    - type: 'null'
                  archived:
                    description: True once the org has been archived. Archived orgs remain visible to existing members but can't be PATCHed via this api.
                    type: boolean
                  created_at:
                    description: RFC 3339 timestamp. Stable across PATCHes.
                    type: string
                  updated_at:
                    description: RFC 3339 timestamp of the most recent PATCH or system mutation.
                    type: string
                required:
                - id
                - display_name
                - settings
                - archived
                - created_at
                - updated_at
                additionalProperties: false
        '404':
          description: Org does not exist, or the caller has no visibility (response shape is intentionally identical for both).
          content:
            application/json:
              schema:
                type: object
                properties: {}
                additionalProperties: false
      tags:
      - Orgs
      summary: Get an organization
      description: 'Returns the org''s public metadata.


        Returns 404 (not 403) when the caller has no visibility — this prevents probing for existence. If you receive 404 and expected access, list visible orgs with GET /api/v1/orgs to confirm membership.'
      operationId: getApiV1OrgsById
      x-operation-id-source: derived
    patch:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
          format: uuid
        description: Org id from GET /api/v1/orgs
      requestBody:
        content:
          application/json:
            schema:
              title: OrganizationPatch
              description: Partial-update body. Send only the fields you want to change; omitted fields are preserved. Unknown fields are dropped by coercion before they reach the handler so a client can't accidentally edit protected fields.
              type: object
              properties:
                display_name:
                  description: New display name. 1-200 chars.
                  allOf:
                  - type: string
                  - {}
                description:
                  description: New description, or null to clear.
                  oneOf:
                  - type: string
                  - type: 'null'
                image:
                  description: New logo URL, or null to clear.
                  oneOf:
                  - type: string
                  - type: 'null'
                settings:
                  description: Replaces the entire `settings` map; merge client-side before sending.
                  type: object
                  additionalProperties: {}
              additionalProperties: false
      responses:
        '200':
          description: The updated org row.
          content:
            application/json:
              schema:
                title: Organization
                description: Public projection of an organization the caller can see. Mutable fields are exposed via PATCH /api/v1/orgs/{id}.
                type: object
                properties:
                  id:
                    description: Stable UUIDv7 identifier. Use this in path params.
                    type: string
                    format: uuid
                  display_name:
                    description: Human-readable org name shown in UI. Required, 1-200 chars.
                    type: string
                  description:
                    description: Optional short blurb. May be null.
                    oneOf:
                    - type: string
                    - type: 'null'
                  image:
                    description: Optional logo URL. May be null.
                    oneOf:
                    - type: string
                    - type: 'null'
                  settings:
                    description: Free-form org-level settings map. Treat as opaque to other tools.
                    oneOf:
                    - type: object
                      additionalProperties: {}
                    - type: 'null'
                  archived:
                    description: True once the org has been archived. Archived orgs remain visible to existing members but can't be PATCHed via this api.
                    type: boolean
                  created_at:
                    description: RFC 3339 timestamp. Stable across PATCHes.
                    type: string
                  updated_at:
                    description: RFC 3339 timestamp of the most recent PATCH or system mutation.
                    type: string
                required:
                - id
                - display_name
                - settings
                - archived
                - created_at
                - updated_at
                additionalProperties: false
        '403':
          description: Caller has visibility but lacks the role to write.
          content:
            application/json:
              schema:
                type: object
                properties: {}
                additionalProperties: false
        '404':
          description: Org does not exist, or the caller has no visibility (response shape is intentionally identical for both).
          content:
            application/json:
              schema:
                type: object
                properties: {}
                additionalProperties: false
      tags:
      - Orgs
      summary: Update an organization
      description: 'Updates `display_name`, `description`, `image`, or `settings`.


        Authorization: the caller''s role must grant `:write :org` (owner or admin). Member or viewer roles get 403.


        Unknown body fields are silently dropped by request coercion before they reach the handler, so it is safe to PATCH with the full GET response after editing only the fields you care about.


        Archive/delete are not exposed in v1 — they will land on dedicated verbs.'
      operationId: patchApiV1OrgsById
      x-operation-id-source: derived
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: opaque
      description: 'An Orbit api token, sent as `Authorization: Bearer <token>`.


        Mint one with the RFC 8628 device-authorization grant (`POST /api/v1/device/code`, then poll `POST /api/v1/device/token`), or from Studio.


        Every token carries a scope set from the `[verb resource]` RBAC catalog — `read:app`, `write:deployment`, `manage:secret`, and so on. The full vocabulary is published as `scopes_supported` at `/.well-known/oauth-protected-resource` (RFC 9728) and `/.well-known/oauth-authorization-server` (RFC 8414). Grant an agent the narrowest set that does its job.'
externalDocs:
  description: Full documentation
  url: https://docs.orbitapps.io
x-id:
- reitit.openapi/default