Skip to main content
GET
/
organizations
/
by-slug
/
{slug}
Get organization by slug
curl --request GET \
  --url https://app.usechar.ai/api/organizations/by-slug/{slug} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "name": "<string>",
  "slug": "<string>",
  "avatar_url": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "role": "<string>"
}

Documentation Index

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

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

Authorizations

​
Authorization
string
header
required

WorkOS JWT token. Obtain via WorkOS AuthKit authentication flow. The token must include organization_id claim for organization-scoped endpoints.

Path Parameters

​
slug
string
required

URL-friendly identifier for the organization (e.g., 'acme-corp')

Response

OK

Organization with the requesting user's role

​
id
string
required

WorkOS organization ID (e.g., org_01ABC...)

​
name
string
required

Organization name displayed in the dashboard.

​
slug
string
required

URL-friendly slug for routing and sharing.

​
avatar_url
string | null
required

URL to the organization logo or avatar, if set.

​
created_at
string<date-time>
required

Timestamp when the organization was created.

​
updated_at
string<date-time>
required

Timestamp when the organization was last updated.

​
role
string
required

User's role in this organization (e.g., 'admin', 'member')