Skip to main content

Organizations

List the organizations you belong to, read one, list its members, and invite someone with a role and member scopes.

On this page
GET /api/v1/organizations
Organizations you belong to.
GET /api/v1/organizations/{org_id}
One organization. Members only.
GET /api/v1/organizations/{org_id}/members
Its members. Members only.
POST /api/v1/organizations/{org_id}/invites
Invite someone by email.

Scope: member scope org:invite

Invite a member

Invite
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": "analyst@example.com", "role": "MEMBER", "scopes": ["usage:read"]}'
Field Notes
email Required. Up to 254 characters.
role Default MEMBER.
scopes Member scopes to grant, up to 200. See Scopes and roles.

The response is 201 with the invitation’s id, invitee_email, role, scopes, status, expires_at and token.

Managing members (changing permissions, removing members, transferring ownership) and multi-seat billing happen in the console. See Organization and members.

Search documentation

Type to search guides, the API reference, the CLI and the console guide.

    Enter open↑ ↓ moveEsc close