Organizations (Beta)

List and manage organizations the authenticated caller can access.

List organizations the caller can access

get

Returns every organization the authenticated user / API key can act in, ordered with the primary (default-fallback) org first. Use this to discover valid org_id values to pass into other beta tools — required for users who belong to multiple orgs and want to scope a particular call to a non-primary org.

Responses

200

OK

application/json

idstringRequired

Organization ID. Pass as org_id to other tools.

namestringRequired

Human-readable organization name.

domainstring · nullableOptional

Email domain associated with the org (e.g. 'acme.com'), or null if unset. For other org-management fields (postal address, deactivation flag, created_at), use get_organization on a specific org_id.

rolestring · enumRequired

Caller's role in this org: 'user', 'admin', 'support', 'cloud_rep', or 'restricted_user'. Staff users are reported as 'admin' for every active org.

Possible values:

kindundefined · enumRequired

How the caller has access: 'direct' (regular member), 'staff' (staff-level access to every active org), or 'partnership' (inherited via a channel partnership).

Possible values:

is_primarybooleanRequired

True for the org the caller's tokens default to when no org_id is passed. Matches the earliest-joined direct membership returned by User.active_memberships.

denied_permissionsstring[]Required

List of Resource:action strings the caller's role is denied (e.g. 'PurchasePlanV2:execute'). Anything not listed is permitted. Use to gate write/destructive recommendations.

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

405

Method not allowed

application/json

409

Conflict

application/json

500

Internal server error

application/json

default

Default error response

application/json

get

/beta/v1/organizations

HTTPcURLJavaScriptPython

GET /beta/v1/organizations HTTP/1.1
Accept: */*

[
  {
    "id": "text",
    "name": "text",
    "domain": "text",
    "role": "user",
    "kind": "direct",
    "is_primary": true,
    "denied_permissions": [
      "text"
    ]
  }
]

Get an organization's management details

get

Returns the org-management view of a single organization: name, domain, primary address, deactivation flag, and created_at. For the cross-org list of orgs the caller can access (with role / kind / denied_permissions), use GET /organizations.

Path parameters

org_idstring · uuidRequired

Responses

200

OK

application/json

idstringRead-onlyOptional

Organization ID.

namestringRequired

Organization name. Unique across the platform.

domainstring · nullableOptional

Email domain associated with the org (e.g. 'acme.com'). Used for domain-based onboarding flows.

created_atstring · date-timeRead-onlyOptional

When the org was created.

primary_addressany ofOptional

The org's primary postal address (optional).

or

object · nullableOptional

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

405

Method not allowed

application/json

409

Conflict

application/json

500

Internal server error

application/json

default

Default error response

application/json

get

/beta/v1/organizations/{org_id}

HTTPcURLJavaScriptPython

GET /beta/v1/organizations/{org_id} HTTP/1.1
Accept: */*

{
  "id": "text",
  "name": "text",
  "domain": "text",
  "created_at": "2026-06-08T17:33:43.110Z",
  "primary_address": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "line1": "text",
    "line2": "text",
    "city": "text",
    "state": "text",
    "zip": "text",
    "country": "text"
  }
}

Update an organization's management details

patch

Partial-update: every field is optional. Send only the fields you want to change. Sending primary_address replaces the existing address in full; pass null to clear it. Deactivation is intentionally not exposed here — use POST /organizations/<org_id>/deactivate. Requires the caller to have admin role on the org (the Organization:write casbin permission).

Path parameters

org_idstring · uuidRequired

Body

application/json

namestring · min: 1Optional

New organization name.

domainstring · min: 1 · nullableOptional

New email domain, or null to clear.

primary_addressany ofOptional

Replacement primary address. Send the full address object. Pass null to clear the existing address.

or

object · nullableOptional

Responses

200

OK

application/json

idstringRead-onlyOptional

Organization ID.

namestringRequired

Organization name. Unique across the platform.

domainstring · nullableOptional

Email domain associated with the org (e.g. 'acme.com'). Used for domain-based onboarding flows.

created_atstring · date-timeRead-onlyOptional

When the org was created.

primary_addressany ofOptional

The org's primary postal address (optional).

or

object · nullableOptional

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

405

Method not allowed

application/json

409

Conflict

application/json

422

Unprocessable Content

application/json

500

Internal server error

application/json

default

Default error response

application/json

patch

/beta/v1/organizations/{org_id}

HTTPcURLJavaScriptPython

PATCH /beta/v1/organizations/{org_id} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 140

{
  "name": "text",
  "domain": "text",
  "primary_address": {
    "line1": "text",
    "line2": "text",
    "city": "text",
    "state": "text",
    "zip": "text",
    "country": "text"
  }
}

{
  "id": "text",
  "name": "text",
  "domain": "text",
  "created_at": "2026-06-08T17:33:43.110Z",
  "primary_address": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "line1": "text",
    "line2": "text",
    "city": "text",
    "state": "text",
    "zip": "text",
    "country": "text"
  }
}

Deactivate an organization

post

Soft-disables the organization: it stops appearing in list_organizations results and members lose access. Intentionally a one-way door from this API surface — there is no corresponding reactivate endpoint, and once deactivated the org cannot be reached via these admin endpoints at all (the auth layer filters deactivated orgs). Reactivation requires reaching out to Archera support. Returns 204 with no body — there is no further state the caller can read post-deactivation. Requires the caller to have admin role on the org (the Organization:write casbin permission).

Path parameters

org_idstring · uuidRequired

Responses

204

No Content

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

405

Method not allowed

application/json

409

Conflict

application/json

500

Internal server error

application/json

default

Default error response

application/json

post

/beta/v1/organizations/{org_id}/deactivate

HTTPcURLJavaScriptPython

POST /beta/v1/organizations/{org_id}/deactivate HTTP/1.1
Accept: */*

No content