Ctrlk
Schedule a DemoMeet with usTo App
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Organizations (Beta)

List and manage organizations the authenticated caller can access.

List organizations the caller can access

get

Returns the organizations 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.

Pass search to match any part of an organization name, case-insensitively. Results are paginated, 300 per page by default and at most 500 with page_size; X-Pagination carries the match total and the page links. Archera staff can act in every active organization, so a staff call spans thousands of results — filter with search rather than walking the pages.

Query parameters
searchstring · nullableOptional

Case-insensitive substring of the organization name — 'acme' matches 'Acme Corp' and 'Global Acme'. No wildcards needed; any '%' or '_' in the term is matched literally. Omit to list every organization the caller can access.

Default: null
pageinteger · min: 1OptionalDefault: 1
page_sizeinteger · min: 1 · max: 500OptionalDefault: 300
Responses
200

OK

application/json
get/beta/v1/organizations
GET /beta/v1/organizations HTTP/1.1
Accept: */*

[
  {
    "id": "text",
    "name": "text",
    "domain": "text",
    "created_at": "2026-01-01T00:00:00.000Z",
    "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
get/beta/v1/organizations/{org_id}
GET /beta/v1/organizations/{org_id} HTTP/1.1
Accept: */*

{
  "id": "text",
  "name": "text",
  "domain": "text",
  "created_at": "2026-01-01T00:00:00.000Z",
  "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
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
patch/beta/v1/organizations/{org_id}
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-01-01T00:00:00.000Z",
  "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

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

No content
PreviousCatalog (Beta)
NextModels

Last updated

Was this helpful?