Organizations

API version

2026-11-11 (latest)next (preview)

PreviewDownload OpenAPI (JSON)Versioning

Preview

next shows changes that are not released or not stable yet. Use the current version for production integrations.

List your organizations

GET /api/v1/organizations

Authentication

• API key in X-API-Key
• API key or session token in Authorization: Bearer

Responses

• 200 Organizations you belong to.

  application/json

  Body (application/json)

  • organizations array of objects
• 401 Missing, invalid, expired or revoked credentials.Error envelope
• 429 A per-user limit was exceeded (the Platform API, embeddings or rerank). This response does not use the error envelope. Wait for Retry-After seconds.

  application/json

  Headers

  • X-Request-ID string

    The request's correlation id (yours, or one BreachLine generated). Quote it to support.

  • Retry-After integer

    Seconds to wait before retrying.

  Body (application/json)

  • detail string Required
  • retry_after integer Required

    Always

    60

Example

cURLCopy

curl "https://api.breachline.io/api/v1/organizations" \
  -H "Authorization: Bearer $BREACHLINE_API_KEY"

Example 200 responseCopy

{
  "organizations": [
    {}
  ]
}

Get an organization

GET /api/v1/organizations/{org_id}

Members only.

Authentication

• API key in X-API-Key
• API key or session token in Authorization: Bearer

Path parameters

• org_id string Required

  Organization id.

Responses

• 200 The organization.

  application/json

  Body (application/json)

• 401 Missing, invalid, expired or revoked credentials.Error envelope
• 403 The credential is valid but lacks a required scope or permission.Error envelope
• 404 The resource does not exist or is not visible to this caller.Error envelope
• 429 A per-user limit was exceeded (the Platform API, embeddings or rerank). This response does not use the error envelope. Wait for Retry-After seconds.

  application/json

  Headers

  • X-Request-ID string

    The request's correlation id (yours, or one BreachLine generated). Quote it to support.

  • Retry-After integer

    Seconds to wait before retrying.

  Body (application/json)

  • detail string Required
  • retry_after integer Required

    Always

    60

Example

cURLCopy

curl "https://api.breachline.io/api/v1/organizations/{org_id}" \
  -H "Authorization: Bearer $BREACHLINE_API_KEY"

Example 200 responseCopy

{}

List members

GET /api/v1/organizations/{org_id}/members

Members only.

Authentication

• API key in X-API-Key
• API key or session token in Authorization: Bearer

Path parameters

• org_id string Required

  Organization id.

Responses

• 200 The members.

  application/json

  Body (application/json)

• 401 Missing, invalid, expired or revoked credentials.Error envelope
• 403 The credential is valid but lacks a required scope or permission.Error envelope
• 429 A per-user limit was exceeded (the Platform API, embeddings or rerank). This response does not use the error envelope. Wait for Retry-After seconds.

  application/json

  Headers

  • X-Request-ID string

    The request's correlation id (yours, or one BreachLine generated). Quote it to support.

  • Retry-After integer

    Seconds to wait before retrying.

  Body (application/json)

  • detail string Required
  • retry_after integer Required

    Always

    60

Example

cURLCopy

curl "https://api.breachline.io/api/v1/organizations/{org_id}/members" \
  -H "Authorization: Bearer $BREACHLINE_API_KEY"

Example 200 responseCopy

{}

Invite a member

POST /api/v1/organizations/{org_id}/invites

Requires the org:invite member scope. The response includes the invitation token; treat it as a secret.

Authentication

• API key in X-API-Key
• API key or session token in Authorization: Bearer

Path parameters

• org_id string Required

  Organization id.

Request body

application/json Required

• email string (email) Required

  Maximum length

  254

• role string

  Default

  MEMBER

• scopes array of strings

  Maximum items

  200

Responses

• 201 The invitation.

  application/json

  Body (application/json)

  • id string
  • invitee_email string
  • role string
  • scopes array of strings
  • status string
  • expires_at string (date-time)
  • token string

    The invitation token. Treat it as a secret.

• 401 Missing, invalid, expired or revoked credentials.Error envelope
• 403 The credential is valid but lacks a required scope or permission.Error envelope
• 422 The request body or parameters failed schema validation.Error envelope
• 429 A per-user limit was exceeded (the Platform API, embeddings or rerank). This response does not use the error envelope. Wait for Retry-After seconds.

  application/json

  Headers

  • X-Request-ID string

    The request's correlation id (yours, or one BreachLine generated). Quote it to support.

  • Retry-After integer

    Seconds to wait before retrying.

  Body (application/json)

  • detail string Required
  • retry_after integer Required

    Always

    60

Example

cURLCopy

curl -X POST "https://api.breachline.io/api/v1/organizations/{org_id}/invites" \
  -H "Authorization: Bearer $BREACHLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "string"
  }'

Example 201 responseCopy

{
  "id": "string",
  "invitee_email": "string",
  "role": "string",
  "scopes": [
    "string"
  ],
  "status": "string",
  "expires_at": "2026-11-11T00:00:00Z",
  "token": "string"
}