Skip to main content
GET
https://api.bunship.com
/
api
/
v1
/
organizations
/
{orgId}
Get Organization
curl --request GET \
  --url https://api.bunship.com/api/v1/organizations/{orgId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "org_cld2abc123def456",
  "name": "Acme Corp",
  "slug": "acme-corp",
  "description": "Building the future of widgets",
  "logoUrl": "https://cdn.bunship.com/logos/acme.png",
  "settings": {
    "branding": {
      "primaryColor": "#5046E5"
    },
    "features": {
      "webhooks": true,
      "apiAccess": true
    }
  },
  "createdBy": "usr_cld2abc123def456",
  "createdAt": "2024-01-15T10:00:00Z",
  "updatedAt": "2024-01-20T14:30:00Z"
}
Returns the full details of an organization. The authenticated user must be a member of the organization.

​
Auth

Requires a valid Bearer token. User must be a member of the organization.

​
Path Parameters

​
orgId
string
required
Organization identifier.

​
Response

​
id
string
Organization identifier.
​
name
string
Organization name.
​
slug
string
URL slug.
​
description
string | null
Description.
​
logoUrl
string | null
Logo URL.
​
settings
object
Organization settings including branding, features, and billing configuration.
​
createdBy
string
User ID of the creator.
​
createdAt
string
ISO 8601 creation timestamp.
​
updatedAt
string
ISO 8601 last update timestamp.
{
  "id": "org_cld2abc123def456",
  "name": "Acme Corp",
  "slug": "acme-corp",
  "description": "Building the future of widgets",
  "logoUrl": "https://cdn.bunship.com/logos/acme.png",
  "settings": {
    "branding": {
      "primaryColor": "#5046E5"
    },
    "features": {
      "webhooks": true,
      "apiAccess": true
    }
  },
  "createdBy": "usr_cld2abc123def456",
  "createdAt": "2024-01-15T10:00:00Z",
  "updatedAt": "2024-01-20T14:30:00Z"
}

​
Errors

StatusCodeDescription
401AUTHENTICATION_ERRORMissing or invalid Bearer token
403AUTHORIZATION_ERRORUser is not a member of this organization
404NOT_FOUNDOrganization not found

​
Example

curl https://api.bunship.com/api/v1/organizations/org_cld2abc123def456 \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIs..."