Get organization

curl --request GET \
  --url https://api.helloannie.com/v1/organizations/{id}

{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Downtown Dental Clinic",
    "externalId": "location_001",
    "phone": "+1-555-123-4567",
    "timezone": "America/New_York",
    "address": {
      "addressLine1": "123 Main Street",
      "addressLine2": "Suite 200",
      "city": "Springfield",
      "state": "IL",
      "country": "US",
      "zip": "62701",
      "directions": "Enter through the back entrance"
    },
    "officeHours": [
      {
        "dayOfWeek": "MONDAY",
        "open": "09:00",
        "close": "17:00",
        "notes": "Lunch break 12:00-13:00"
      }
    ],
    "staff": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440001",
        "name": "Dr. Jane Smith",
        "role": "DOCTOR",
        "bio": "Dr. Smith has over 15 years of experience in general dentistry",
        "isActive": true
      }
    ],
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

GET

organizations

{id}

Get organization

curl --request GET \
  --url https://api.helloannie.com/v1/organizations/{id}

{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Downtown Dental Clinic",
    "externalId": "location_001",
    "phone": "+1-555-123-4567",
    "timezone": "America/New_York",
    "address": {
      "addressLine1": "123 Main Street",
      "addressLine2": "Suite 200",
      "city": "Springfield",
      "state": "IL",
      "country": "US",
      "zip": "62701",
      "directions": "Enter through the back entrance"
    },
    "officeHours": [
      {
        "dayOfWeek": "MONDAY",
        "open": "09:00",
        "close": "17:00",
        "notes": "Lunch break 12:00-13:00"
      }
    ],
    "staff": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440001",
        "name": "Dr. Jane Smith",
        "role": "DOCTOR",
        "bio": "Dr. Smith has over 15 years of experience in general dentistry",
        "isActive": true
      }
    ],
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Path Parameters

string<uuid>

required

Response

200 - application/json

data

object

Show child attributes

data.id

string<uuid>

Unique identifier for the organization

Example:

"550e8400-e29b-41d4-a716-446655440000"

data.name

string

Display name of the office/location

Example:

"Downtown Dental Clinic"

data.externalId

string | null

Optional external identifier for PMS integration

Example:

"location_001"

data.phone

string | null

Primary office phone number

Example:

"+1-555-123-4567"

data.timezone

string | null

Location timezone for appointment scheduling

Example:

"America/New_York"

data.address

object

Show child attributes

data.address.addressLine1

string

Primary street address

Example:

"123 Main Street"

data.address.addressLine2

string | null

Optional secondary address line (suite, unit, etc.)

Example:

"Suite 200"

data.address.city

string

City name

Example:

"Springfield"

data.address.state

string

State/province

Example:

"IL"

data.address.country

string

Country

Example:

"US"

data.address.zip

string

Postal/ZIP code

Example:

"62701"

data.address.directions

string | null

Optional special directions or notes

Example:

"Enter through the back entrance"

data.officeHours

object[]

Office hours for each day of the week

Show child attributes

data.officeHours.dayOfWeek

enum<string>

Day of the week

Available options:

MONDAY,

TUESDAY,

WEDNESDAY,

THURSDAY,

FRIDAY,

SATURDAY,

SUNDAY

Example:

"MONDAY"

data.officeHours.open

string | null

Opening time in HH:MM format (null if closed)

Example:

"09:00"

data.officeHours.close

string | null

Closing time in HH:MM format (null if closed)

Example:

"17:00"

data.officeHours.notes

string | null

Optional notes for this day

Example:

"Lunch break 12:00-13:00"

data.staff

object[]

Staff/team members at this location

Show child attributes

data.staff.id

string<uuid>

Unique identifier for the staff member

Example:

"550e8400-e29b-41d4-a716-446655440001"

data.staff.name

string

Staff member name

Example:

"Dr. Jane Smith"

data.staff.role

enum<string>

Staff member role

Available options:

DOCTOR,

HYGIENIST,

RECEPTIONIST,

ASSISTANT,

MANAGER,

OTHER

Example:

"DOCTOR"

data.staff.bio

string | null

Optional biography or description

Example:

"Dr. Smith has over 15 years of experience in general dentistry"

data.staff.isActive

boolean

Whether the staff member is currently active

Example:

true

data.createdAt

string<date-time>

Timestamp when the organization was created

data.updatedAt

string<date-time>

Timestamp when the organization was last updated

Create organization Update organization

⌘I

Getting Started

Configuration

Training

Conversations

Get organization

Path Parameters

Response