Public API: Organization

This is one read endpoint. It answers one question: which organization does this token belong to? Call it right after you create a token. It confirms the token works, and it names the organization before you write anything else.

There is no id in the path. The organization comes from the token, so a token can only ever read its own.

https://app.avsb.cloud/api/v1/org

Every response here follows the shared conventions: the { data } envelope and the standard error shape. Every /api/v1 token is rate-limited the same way everywhere: a scoped token gets 600 reads and 120 writes per minute, and an admin:* token gets 600 requests per minute, reads and writes together. This endpoint also needs the Integrations and API access plan feature, or the call fails with 403 feature_disabled. See rate-limit headers and Refusals at 403.

Scopes

A scope is a named permission on your token. It decides exactly what that token is allowed to read or change.

Get the organization

GET /api/v1/org

curl https://app.avsb.cloud/api/v1/org \  -H "Authorization: Bearer avsb_svc_..."

const res = await fetch('https://app.avsb.cloud/api/v1/org', {  headers: { Authorization: `Bearer ${process.env.AVSB_SERVICE_TOKEN}` },})const { data } = await res.json()console.log(data.name)

import os, requestsres = requests.get(    "https://app.avsb.cloud/api/v1/org",    headers={"Authorization": f"Bearer {os.environ['AVSB_SERVICE_TOKEN']}"},)data = res.json()["data"]print(data["name"])

{  "data": {    "id": "clorg001",    "shortId": 1001,    "name": "Acme",    "industry": "Retail",    "website": "https://acme.example",    "region": "EU",    "logoUrl": null,    "onboardingCompleted": true,    "createdAt": "2026-01-05T00:00:00.000Z"  }}

The response carries a weak ETag that changes whenever any profile field changes. Save it and compare it to a later read to tell whether the profile changed, without diffing every field yourself. AvsB does not read an If-None-Match header on this endpoint. So the ETag saves you a comparison, not a network round trip: every call still returns the full profile.

What is and is not here

This is the organization profile, which is the whole meaning of org:read on the public API:

• Included: name, industry, website, region, logo, and whether first-run setup finished.
• Not included: members (they have their own endpoint), billing and plan entitlements, and notification preferences. Those are dashboard and internal concerns, not an integration contract.

There is no update endpoint. You can change these fields only from Organization Settings in the dashboard, since renaming an organization is a one-off human action.

Error response

A token whose plan does not include Integrations and API access still authenticates, but the call is refused before it reads anything:

{  "error": {    "code": "feature_disabled",    "message": "This feature is not included in your current plan. Upgrade to unlock it.",    "details": { "kind": "plan", "feature": "integrations_api_export" }  }}

Next steps