Xbow Organizations API
Endpoints related to organizations and their management.
Endpoints related to organizations and their management.
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/xbow-organizations-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
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. 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:
description: '# Versioning
The API is in public preview.'
title: XBOW Organizations API
version: '2026-07-01'
servers:
- description: Default
url: https://console.xbow.com/
- description: Multi SAAS - Europe data resident instance
url: https://console.eu.xbow.com/
- description: Multi SAAS - Asia Pacific data resident instance
url: https://console.sg.xbow.com/
tags:
- description: Endpoints related to organizations and their management.
name: Organizations
paths:
/api/v1/integrations/{integrationId}/organizations:
get:
description: 'Lists all organizations for an integration.
Requires an _integration_ API key.
Supports pagination via `limit` and `after` query parameters.'
parameters:
- in: query
name: limit
required: false
schema:
default: 20
maximum: 100
minimum: 1
type: integer
- in: query
name: after
required: false
schema:
type: string
- in: path
name: integrationId
required: true
schema:
type: string
- description: API version to use for this request
in: header
name: X-XBOW-API-Version
required: true
schema:
enum:
- '2026-07-01'
example: '2026-07-01'
type: string
responses:
'200':
content:
application/json:
schema:
example:
items:
- createdAt: '2025-01-01T00:00:00Z'
externalId: '123'
id: 123e4567-e89b-12d3-a456-426614174000
name: Example Organization
state: active
updatedAt: '2025-01-01T00:00:00Z'
- createdAt: '2025-01-02T00:00:00Z'
externalId: '234'
id: 456e7890-e89b-12d3-a456-426614174111
name: Another Organization
state: active
updatedAt: '2025-01-02T00:00:00Z'
nextCursor: eyJjcmVhdGVkQXQiOiIyMDI1LTAxLTAyVDAwOjAwOjAwWiIsImlkIjoiNDU2ZTc4OTAtZTg5Yi0xMmQzLWE0NTYtNDI2NjE0MTc0MTExIn0=
properties:
items:
items:
properties:
createdAt:
format: date-time
type: string
externalId:
anyOf:
- type: string
- type: 'null'
id:
type: string
name:
type: string
state:
enum:
- active
- disabled
type: string
updatedAt:
format: date-time
type: string
required:
- createdAt
- externalId
- id
- name
- state
- updatedAt
type: object
type: array
nextCursor:
type: string
required:
- items
type: object
description: Default Response
'400':
content:
application/json:
schema:
properties:
code:
description: A constant for machines
enum:
- FST_ERR_VALIDATION
type: string
error:
description: A human readable string for the constant
enum:
- Bad Request
type: string
message:
description: A human readable message
type: string
requestId:
description: A unique identifier for the request
type: string
required:
- code
- error
- message
- requestId
type: object
description: Default Response
security:
- Authorization: []
summary: List organizations
tags:
- Organizations
operationId: getApiV1IntegrationsByIntegrationIdOrganizations
x-operation-id-source: derived
post:
description: 'Creates a new organization. This is required before setting up an asset.
Requires an _integration_ API key.'
parameters:
- in: path
name: integrationId
required: true
schema:
type: string
- description: API version to use for this request
in: header
name: X-XBOW-API-Version
required: true
schema:
enum:
- '2026-07-01'
example: '2026-07-01'
type: string
requestBody:
content:
application/json:
schema:
example:
externalId: org-12345
members:
- email: john@example.com
name: John Smith
- email: jane@example.com
name: Jane Doe
name: Example Organization
properties:
externalId:
anyOf:
- type: string
- type: 'null'
description: External reference for this customer. Must be unique among all organizations you provision.
members:
description: List of members in the organization. At least one member is required.
items:
properties:
email:
description: Email of the customer
format: email
pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
type: string
name:
description: Name of the customer
minLength: 1
type: string
required:
- email
- name
type: object
minItems: 1
type: array
name:
description: Name of the company. Not required to be unique.
minLength: 1
type: string
required:
- externalId
- members
- name
type: object
required: true
responses:
'200':
content:
application/json:
schema:
example:
createdAt: '2025-01-01T00:00:00Z'
externalId: org-12345
id: 123e4567-e89b-12d3-a456-426614174000
name: Example Organization
state: active
updatedAt: '2025-01-01T00:00:00Z'
properties:
createdAt:
format: date-time
type: string
externalId:
anyOf:
- type: string
- type: 'null'
id:
type: string
name:
type: string
state:
enum:
- active
- disabled
type: string
updatedAt:
format: date-time
type: string
required:
- createdAt
- externalId
- id
- name
- state
- updatedAt
type: object
description: Default Response
'400':
content:
application/json:
schema:
properties:
code:
description: A constant for machines
enum:
- FST_ERR_VALIDATION
type: string
error:
description: A human readable string for the constant
enum:
- Bad Request
type: string
message:
description: A human readable message
type: string
requestId:
description: A unique identifier for the request
type: string
required:
- code
- error
- message
- requestId
type: object
description: Default Response
'403':
content:
application/json:
schema:
properties:
code:
description: A constant for machines
enum:
- ERR_FORBIDDEN
type: string
error:
description: A human readable string for the constant
enum:
- Forbidden
type: string
message:
description: A human readable message
type: string
requestId:
description: A unique identifier for the request
type: string
required:
- code
- error
- message
- requestId
type: object
description: Default Response
'409':
content:
application/json:
schema:
properties:
code:
description: A constant for machines
enum:
- ERR_CONFLICT
type: string
error:
description: A human readable string for the constant
enum:
- Conflict
type: string
message:
description: A human readable message
type: string
requestId:
description: A unique identifier for the request
type: string
required:
- code
- error
- message
- requestId
type: object
description: The resource already exists
security:
- Authorization: []
summary: Create organization
tags:
- Organizations
operationId: postApiV1IntegrationsByIntegrationIdOrganizations
x-operation-id-source: derived
/api/v1/keys/{keyId}:
delete:
description: 'Revokes an existing API key for an organization.
Requires an _integration_ API key.'
parameters:
- in: path
name: keyId
required: true
schema:
type: string
- description: API version to use for this request
in: header
name: X-XBOW-API-Version
required: true
schema:
enum:
- '2026-07-01'
example: '2026-07-01'
type: string
responses:
'204':
description: Default Response
'400':
content:
application/json:
schema:
properties:
code:
description: A constant for machines
enum:
- FST_ERR_VALIDATION
type: string
error:
description: A human readable string for the constant
enum:
- Bad Request
type: string
message:
description: A human readable message
type: string
requestId:
description: A unique identifier for the request
type: string
required:
- code
- error
- message
- requestId
type: object
description: Default Response
security:
- Authorization: []
summary: Revoke organization key
tags:
- Organizations
operationId: deleteApiV1KeysByKeyId
x-operation-id-source: derived
/api/v1/organizations/{organizationId}:
get:
description: 'Retrieves a specific organization by ID.
Accepts either an _integration_ API key or an _organization_ API key.'
parameters:
- in: path
name: organizationId
required: true
schema:
type: string
- description: API version to use for this request
in: header
name: X-XBOW-API-Version
required: true
schema:
enum:
- '2026-07-01'
example: '2026-07-01'
type: string
responses:
'200':
content:
application/json:
schema:
example:
createdAt: '2025-01-01T00:00:00Z'
externalId: org-12345
id: 123e4567-e89b-12d3-a456-426614174000
name: Example Organization
state: active
updatedAt: '2025-01-01T00:00:00Z'
properties:
createdAt:
format: date-time
type: string
externalId:
anyOf:
- type: string
- type: 'null'
id:
type: string
name:
type: string
state:
enum:
- active
- disabled
type: string
updatedAt:
format: date-time
type: string
required:
- createdAt
- externalId
- id
- name
- state
- updatedAt
type: object
description: Default Response
'400':
content:
application/json:
schema:
properties:
code:
description: A constant for machines
enum:
- FST_ERR_VALIDATION
type: string
error:
description: A human readable string for the constant
enum:
- Bad Request
type: string
message:
description: A human readable message
type: string
requestId:
description: A unique identifier for the request
type: string
required:
- code
- error
- message
- requestId
type: object
description: Default Response
'404':
content:
application/json:
schema:
properties:
code:
description: A constant for machines
enum:
- ERR_NOT_FOUND
type: string
error:
description: A human readable string for the constant
enum:
- Not Found
type: string
message:
description: A human readable message
type: string
requestId:
description: A unique identifier for the request
type: string
required:
- code
- error
- message
- requestId
type: object
description: The requested resource was not found
security:
- Authorization: []
summary: Get organization
tags:
- Organizations
operationId: getApiV1OrganizationsByOrganizationId
x-operation-id-source: derived
put:
description: 'Updates an existing organization.
Requires an _integration_ API key.'
parameters:
- in: path
name: organizationId
required: true
schema:
type: string
- description: API version to use for this request
in: header
name: X-XBOW-API-Version
required: true
schema:
enum:
- '2026-07-01'
example: '2026-07-01'
type: string
requestBody:
content:
application/json:
schema:
example:
externalId: updated-org-12345
name: Updated Organization Name
properties:
externalId:
anyOf:
- type: string
- type: 'null'
name:
type: string
required:
- externalId
- name
type: object
required: true
responses:
'200':
content:
application/json:
schema:
example:
createdAt: '2025-01-01T00:00:00Z'
externalId: updated-org-12345
id: 123e4567-e89b-12d3-a456-426614174000
name: Updated Organization Name
state: active
updatedAt: '2025-01-01T00:00:00Z'
properties:
createdAt:
format: date-time
type: string
externalId:
anyOf:
- type: string
- type: 'null'
id:
type: string
name:
type: string
state:
enum:
- active
- disabled
type: string
updatedAt:
format: date-time
type: string
required:
- createdAt
- externalId
- id
- name
- state
- updatedAt
type: object
description: Default Response
'400':
content:
application/json:
schema:
properties:
code:
description: A constant for machines
enum:
- FST_ERR_VALIDATION
type: string
error:
description: A human readable string for the constant
enum:
- Bad Request
type: string
message:
description: A human readable message
type: string
requestId:
description: A unique identifier for the request
type: string
required:
- code
- error
- message
- requestId
type: object
description: Default Response
security:
- Authorization: []
summary: Update organization
tags:
- Organizations
operationId: putApiV1OrganizationsByOrganizationId
x-operation-id-source: derived
/api/v1/organizations/{organizationId}/keys:
post:
description: 'Creates a new API key for an organization in an integration.
Requires an _integration_ API key.'
parameters:
- in: path
name: organizationId
required: true
schema:
type: string
- description: API version to use for this request
in: header
name: X-XBOW-API-Version
required: true
schema:
enum:
- '2026-07-01'
example: '2026-07-01'
type: string
requestBody:
content:
application/json:
schema:
example:
expiresInMinutes: 30
name: Example Key
properties:
expiresInMinutes:
default: 60
description: Number of minutes until the key expires. If not specified, defaults to 1 hour. Maximum 1440 minutes (24 hours).
exclusiveMinimum: 0
maximum: 1440
type: integer
name:
type: string
required:
- name
type: object
required: true
responses:
'200':
content:
application/json:
schema:
example:
createdAt: '2025-01-01T00:00:00Z'
expiresAt: '2026-01-01T00:00:00Z'
id: 123e4567-e89b-12d3-a456-426614174000
key: xbt_0010-123e4567-e89b-12d3-a456-426614174000-AbCdEfGhIjKlMnOpQrStUvWxYz
name: Example Key
updatedAt: '2025-01-01T00:00:00Z'
properties:
createdAt:
format: date-time
type: string
expiresAt:
anyOf:
- format: date-time
pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
type: string
- type: 'null'
id:
type: string
key:
type: string
name:
type: string
updatedAt:
format: date-time
type: string
required:
- createdAt
- expiresAt
- id
- key
- name
- updatedAt
type: object
description: Default Response
'400':
content:
application/json:
schema:
properties:
code:
description: A constant for machines
enum:
- FST_ERR_VALIDATION
type: string
error:
description: A human readable string for the constant
enum:
- Bad Request
type: string
message:
description: A human readable message
type: string
requestId:
description: A unique identifier for the request
type: string
required:
- code
- error
- message
- requestId
type: object
description: Default Response
'403':
content:
application/json:
schema:
properties:
code:
description: A constant for machines
enum:
- ERR_FORBIDDEN
type: string
error:
description: A human readable string for the constant
enum:
- Forbidden
type: string
message:
description: A human readable message
type: string
requestId:
description: A unique identifier for the request
type: string
required:
- code
- error
- message
- requestId
type: object
description: Default Response
security:
- Authorization: []
summary: Create organization key
tags:
- Organizations
operationId: postApiV1OrganizationsByOrganizationIdKeys
x-operation-id-source: derived
components:
securitySchemes:
Authorization:
bearerFormat: API Key
description: Authorization header with Bearer token
scheme: bearer
type: http