Organizations

All paths are relative to the base URL. :orgId accepts either a UUID or a slug. A key only sees the organization it belongs to.

BASE URL https://api.builderbase.com

Read

Get organization GET /organizations/:slug

Response Additional notes

{
  "success": true,
  "data": {
    "organization": {
      "id": "8f2a9c14-3b7e-4d61-a0f5-6c1b9e2d4a83",
      "name": "Northwind Labs",
      "slug": "northwind-labs"
    },
    "member_count": 4,
    "can_create_events": true,
    "onboarding_state": {
      "team_setup_complete": true,
      "invitation_count": 2,
      "member_count": 4
    }
  }
}

List members GET /organizations/:orgId/members

Response

{
  "data": {
    "members": [
      {
        "user_id": "b3d8e1f0-2c5a-4e9b-8d17-3f6a0c2b5e94",
        "role": "OWNER",
        "email": "alice.rivera@northwind.io",
        "name": "Alice Rivera",
        "avatar_url": "https://cdn.builderbase.com/avatars/alice.png"
      }
    ],
    "pagination": {
      "total": 4,
      "limit": 50,
      "offset": 0,
      "has_more": false
    }
  }
}

Get my permissions GET /organizations/:orgId/me/permissions

Response

{
  "data": {
    "role": "ADMIN",
    "permissions": {
      "events_manage": true,
      "members_manage": true
    }
  }
}

Write

Creating an organization is not available via the API - it’s an account-level onboarding step and must be done from the dashboard.

Update organization PATCH /organizations/:id

Response Request (Body)

{
  "data": {
    "id": "8f2a9c14-3b7e-4d61-a0f5-6c1b9e2d4a83",
    "name": "Northwind Labs",
    "slug": "northwind-labs"
  }
}

Add member POST /organizations/:orgId/members

Response Request (Body) Additional notes

{
  "data": {
    "id": "a1c7e9d3-8b2f-4a60-9d15-6e3c0b7a2f48",
    "user_id": "c4e9f2a1-5d6b-4f0c-9e28-4a7b1d3c6f05",
    "role": "MEMBER"
  }
}

Update member role PATCH /organizations/:orgId/members/:userId

Response Request (Body)

{
  "data": {
    "updated": true
  }
}

Remove member DELETE /organizations/:orgId/members/:userId

Response

{
  "data": {
    "deleted": true
  }
}