Skip to content

Organization

Retrieve basic metadata about the organization that owns the API key.

GET/api/v1/organization

Returns the organization name, slug, status, and current plan.

Headers

NameTypeRequiredDescription
AuthorizationstringrequiredBearer sk_live_<your_key>

Example response

Json
{
  "data": {
    "id": "org_01HZ8...",
    "name": "Acme Corp",
    "slug": "acme-corp",
    "status": "active",
    "createdAt": "2025-03-01T12:00:00.000Z",
    "planSlug": "pro",
    "planName": "Pro"
  }
}

Organization object

Fields

NameTypeRequiredDescription
iduuidoptionalOrganization ID.
namestringoptionalDisplay name of the organization.
slugstringoptionalURL-safe unique identifier.
statusstringoptionalactive | suspended
createdAtISO 8601optionalWhen the org was created.
planSlugstring | nulloptionalSlug of the current plan (e.g. "pro").
planNamestring | nulloptionalHuman-readable plan name.

Code samples

curl https://sopflow.io/api/v1/organization \
  -H "Authorization: Bearer sk_live_YOUR_KEY"

Confirm the workspace before syncing

Read /api/v1/organization and compare its ID with the workspace your integration was configured to use. Stop if it differs; a valid key alone does not establish that the destination is correct.

Cache only the fields your integration needs. A plan name in the response is useful context, but authorization is determined by each actual request and current access rules.