Orbit Members API
Org membership — list, invite, change roles, remove
Org membership — list, invite, change roles, remove
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/orbitapps-io:orbitapps-io-members-api"
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.
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: 3.2.0
info:
title: Orbit Apps Members API
version: 1.0.0
description: Public REST API for Orbit Apps.
servers:
- url: https://api.orbitapps.io
description: Production
security:
- bearerAuth: []
tags:
- name: Members
description: Org membership — list, invite, change roles, remove
paths:
/api/v1/orgs/{id}/members/{member_id}:
delete:
parameters:
- in: path
name: id
required: true
schema:
type: string
format: uuid
description: Org id from GET /api/v1/orgs
- in: path
name: member_id
required: true
schema:
type: string
format: uuid
description: Member id from GET /api/v1/orgs/{id}/members
responses:
'204':
description: Member removed.
'403':
description: Caller lacks the role to manage members.
content:
application/json:
schema:
type: object
properties: {}
additionalProperties: false
'404':
description: Org or member not found / not visible.
content:
application/json:
schema:
type: object
properties: {}
additionalProperties: false
'409':
description: Owner-protected, or the caller targeted themselves.
content:
application/json:
schema:
type: object
properties: {}
additionalProperties: false
tags:
- Members
summary: Remove a member
description: 'Hard-deletes the membership row. Pending invites can be revoked the same way. The owner is protected, and callers cannot remove themselves (leave the org from Studio instead).
Authorization: `[:manage :member]` (owner/admin).'
operationId: deleteApiV1OrgsByIdMembersByMemberId
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
- in: path
name: member_id
required: true
schema:
type: string
format: uuid
description: Member id from GET /api/v1/orgs/{id}/members
requestBody:
content:
application/json:
schema:
title: MemberRolePatch
type: object
properties:
role:
description: Assignable roles. `owner` is reserved — ownership transfer is a separate studio flow.
type: string
enum:
- admin
- member
- viewer
required:
- role
additionalProperties: false
responses:
'200':
description: The updated member row.
content:
application/json:
schema:
title: Member
description: One org membership row.
type: object
properties:
role:
description: owner | admin | member | viewer.
type: string
email:
description: The membership's email. Null for a non-human member — an agent has no inbox.
oneOf:
- type: string
- type: 'null'
org_id:
description: Owning org id.
type: string
format: uuid
updated_at:
oneOf:
- type: string
- type: 'null'
status:
description: invited | active | suspended.
type: string
id:
description: Stable UUIDv7 identifier.
type: string
format: uuid
kind:
description: human | agent | integration | runner. Rows written before kinds existed read as `human`.
type: string
joined_at:
oneOf:
- type: string
- type: 'null'
profile_id:
description: Linked profile once the invite is accepted. Null while invited.
oneOf:
- type: string
format: uuid
- type: 'null'
invited_at:
oneOf:
- type: string
- type: 'null'
created_at:
oneOf:
- type: string
- type: 'null'
required:
- id
- org_id
- profile_id
- kind
- email
- role
- status
additionalProperties: false
'403':
description: Caller lacks the role to manage members.
content:
application/json:
schema:
type: object
properties: {}
additionalProperties: false
'404':
description: Org or member not found / not visible.
content:
application/json:
schema:
type: object
properties: {}
additionalProperties: false
'409':
description: Owner-protected, or the caller targeted themselves.
content:
application/json:
schema:
type: object
properties: {}
additionalProperties: false
tags:
- Members
summary: Change a member's role
description: 'Sets the member''s role to `admin`, `member`, or `viewer`. The owner''s row is protected (409 `member-protected`), and callers cannot change their own role (409 `member-self`).
Authorization: `[:manage :member]` (owner/admin).'
operationId: patchApiV1OrgsByIdMembersByMemberId
x-operation-id-source: derived
/api/v1/orgs/{id}/members:
get:
parameters:
- in: path
name: id
required: true
schema:
type: string
format: uuid
description: Org id from GET /api/v1/orgs
- in: query
name: kind
required: false
schema:
type: string
enum:
- human
- agent
- integration
- runner
- all
description: Which principals to list. Defaults to `human`, so a caller that asks for nothing keeps getting people. `all` returns every row in the org.
responses:
'200':
description: Membership rows for the org.
content:
application/json:
schema:
title: MemberList
type: object
properties:
data:
type: array
items:
title: Member
description: One org membership row.
type: object
properties:
role:
description: owner | admin | member | viewer.
type: string
email:
description: The membership's email. Null for a non-human member — an agent has no inbox.
oneOf:
- type: string
- type: 'null'
org_id:
description: Owning org id.
type: string
format: uuid
updated_at:
oneOf:
- type: string
- type: 'null'
status:
description: invited | active | suspended.
type: string
id:
description: Stable UUIDv7 identifier.
type: string
format: uuid
kind:
description: human | agent | integration | runner. Rows written before kinds existed read as `human`.
type: string
joined_at:
oneOf:
- type: string
- type: 'null'
profile_id:
description: Linked profile once the invite is accepted. Null while invited.
oneOf:
- type: string
format: uuid
- type: 'null'
invited_at:
oneOf:
- type: string
- type: 'null'
created_at:
oneOf:
- type: string
- type: 'null'
required:
- id
- org_id
- profile_id
- kind
- email
- role
- status
additionalProperties: false
required:
- data
additionalProperties: false
'404':
description: Org does not exist, or the caller has no visibility.
content:
application/json:
schema:
type: object
properties: {}
additionalProperties: false
tags:
- Members
summary: List the org's members
description: 'Every membership row — active, invited, suspended. Any active member may read (viewer included). 404 opacity for non-members.
People by default. Pass `?kind=agent`, `integration` or `runner` for one class of non-human principal, or `?kind=all` to read the org as a single list. Agents are also managed on their own resource, `/api/v1/orgs/{id}/agents`, which mints their tokens.'
operationId: getApiV1OrgsByIdMembers
x-operation-id-source: derived
post:
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: MemberInvite
description: Request body for POST /api/v1/orgs/{id}/members.
type: object
properties:
email:
description: Invitee's email. One member row per email per org.
allOf:
- type: string
- {}
role:
description: Assignable roles. `owner` is reserved — ownership transfer is a separate studio flow.
type: string
enum:
- admin
- member
- viewer
required:
- email
- role
additionalProperties: false
responses:
'201':
description: The invited member row, including the one-time invite token.
content:
application/json:
schema:
title: Member
description: One org membership row.
type: object
properties:
role:
description: owner | admin | member | viewer.
type: string
email:
description: The membership's email. Null for a non-human member — an agent has no inbox.
oneOf:
- type: string
- type: 'null'
invite_token:
description: One-time invite token — shown only in this response. The invitee accepts at <studio>/org/{org_id}/members?invite_token={token}.
type: string
org_id:
description: Owning org id.
type: string
format: uuid
updated_at:
oneOf:
- type: string
- type: 'null'
status:
description: invited | active | suspended.
type: string
id:
description: Stable UUIDv7 identifier.
type: string
format: uuid
kind:
description: human | agent | integration | runner. Rows written before kinds existed read as `human`.
type: string
joined_at:
oneOf:
- type: string
- type: 'null'
profile_id:
description: Linked profile once the invite is accepted. Null while invited.
oneOf:
- type: string
format: uuid
- type: 'null'
invited_at:
oneOf:
- type: string
- type: 'null'
created_at:
oneOf:
- type: string
- type: 'null'
required:
- id
- org_id
- profile_id
- kind
- email
- role
- status
- invite_token
additionalProperties: false
'403':
description: Caller lacks the role to invite.
content:
application/json:
schema:
type: object
properties: {}
additionalProperties: false
'404':
description: Org does not exist, or the caller has no visibility.
content:
application/json:
schema:
type: object
properties: {}
additionalProperties: false
'409':
description: A member row with this email already exists.
content:
application/json:
schema:
type: object
properties: {}
additionalProperties: false
tags:
- Members
summary: Invite a teammate
description: 'Creates an `invited` member row and returns it with the one-time `invite_token` — shown only in this response.
The api does NOT send the invite email; deliver the link yourself: `/org/{org_id}/members?invite_token={token}`.
`owner` is not assignable. An email that already has a member row returns 409 `member-exists`.
Authorization: `[:write :member]` (owner/admin).'
operationId: postApiV1OrgsByIdMembers
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