Skip to main content
GET
/
api
/
v2
/
org
Get organization
curl --request GET \
  --url https://app.octolens.com/api/v2/org \
  --header 'Authorization: Bearer <token>'
{
  "organizationId": "<string>",
  "name": "Vercel",
  "plan": "Pro_v3",
  "isAnnualPlan": true,
  "platforms": "all",
  "createdAt": "2023-11-07T05:31:56Z",
  "onboardingFinishedAt": "2023-11-07T05:31:56Z",
  "freeTrialExpired": true
}

Documentation Index

Fetch the complete documentation index at: https://octolens.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Clerk API key. Create one in Settings → API Keys. Pass as Authorization: Bearer <key>.

Response

200 response

The authenticated workspace.

​
organizationId
string
required

Organization ID (org_...). Immutable.

​
name
string
required

Workspace name. Shown in email notifications and in-app headers.

Example:

"Vercel"

​
plan
string | null
required

Current subscription plan (e.g. Free_trial, Pro_v3, Enterprise). null if no active plan / free trial expired.

Example:

"Pro_v3"

​
isAnnualPlan
boolean
required

If true, the subscription is billed annually (vs. monthly).

​
platforms
required

"all" means every supported platform is enabled org-wide. Otherwise a list of Platform enum values.

Allowed value: "all"
Example:

"all"

​
createdAt
string<date-time>
required

When the organization was created.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
​
onboardingFinishedAt
string<date-time> | null
required

When the workspace finished onboarding. null if still onboarding.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
​
freeTrialExpired
boolean
required

If true, the free trial has ended and a paid subscription is required.