Retrieve a Business

GET

/businesses/{businessId}

• production

Retrieve a Business

Authorizations

• apiKey

Parameters

Path Parameters

businessId

required

string format: uuid

Business ID

Responses

200

Business

object

data

Business

All resources are contained within a Business.

object

id

required

Unique identifier across the platform.

string format: uuid

createdAt

Time when the resource was created (ISO 8601 format).

string format: date-time

updatedAt

Time when the resource was last updated (ISO 8601 format).

string format: date-time

alias

Unique business alias across the platform. Used for forms and public booking pages.

string

Example

acme

name

The name of the Business.

string

Example

ACME Corp

email

Email address.

string format: email

logoURL

URL to the logo image.

string | null

Example

https://account.upvio.com/upvio.favicon.png

defaultStaffWorkingHours

One of:

object

A configuration to define active hours.

object

monday

A group of active hours for a single day.

Array<Array<number>>

Example

[
  [
    900,
    1200
  ],
  [
    1300,
    1700
  ]
]

tuesday

A group of active hours for a single day.

Array<Array<number>>

Example

[
  [
    900,
    1200
  ],
  [
    1300,
    1700
  ]
]

wednesday

A group of active hours for a single day.

Array<Array<number>>

Example

[
  [
    900,
    1200
  ],
  [
    1300,
    1700
  ]
]

thursday

A group of active hours for a single day.

Array<Array<number>>

Example

[
  [
    900,
    1200
  ],
  [
    1300,
    1700
  ]
]

friday

A group of active hours for a single day.

Array<Array<number>>

Example

[
  [
    900,
    1200
  ],
  [
    1300,
    1700
  ]
]

saturday

A group of active hours for a single day.

Array<Array<number>>

Example

[
  [
    900,
    1200
  ],
  [
    1300,
    1700
  ]
]

sunday

A group of active hours for a single day.

Array<Array<number>>

Example

[
  [
    900,
    1200
  ],
  [
    1300,
    1700
  ]
]

null

null

enabled

Disabled businesses prevent any staff from using the platform.

boolean

timezone

Timezone string.

string

nullable

Example

UTC