Skip to content

Organization

GET /api/v1/org

Scope: org:read

Returns your organization’s configuration. This endpoint is read-only.

Terminal window
curl "https://api.brightlyai.app/api/v1/org" \
-H "Authorization: Bearer brk_your_key"
{
"data": {
"id": "org-uuid-...",
"name": "Smith Roofing",
"logo_url": "https://example.com/logo.png",
"primary_phone": "+15551234567",
"primary_email": "info@smithroofing.com",
"address": "456 Oak Ave, Austin TX 78701",
"business_hours": {
"monday": { "start": "08:00", "end": "17:00" },
"tuesday": { "start": "08:00", "end": "17:00" },
"wednesday": { "start": "08:00", "end": "17:00" },
"thursday": { "start": "08:00", "end": "17:00" },
"friday": { "start": "08:00", "end": "17:00" },
"saturday": null,
"sunday": null
},
"payment_status": "active",
"plan_tier": "growth",
"ai_name": "Sarah",
"ai_tone": "friendly_professional",
"timezone": "America/Chicago",
"created_at": "2026-01-15T00:00:00Z",
"updated_at": "2026-05-10T14:30:00Z"
}
}
FieldTypeDescription
idUUIDOrganization ID
namestringOrganization name
logo_urlstringLogo image URL
primary_phonestringMain business phone
primary_emailstringMain business email
addressstringBusiness address
business_hoursobjectPer-day start/end times (null = closed)
payment_statusstringSubscription status: active, past_due, cancelled
plan_tierstringCurrent plan: starter, growth, scale
ai_namestringAI agent’s display name
ai_tonestringAI agent’s communication style
timezonestringIANA timezone