Retrieve a Business

GET

/businesses/{businessId}

curl --request GET \
  --url https://api.upvio.com/v1/businesses/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

• production

Retrieve a Business

Authorizations

• apiKey

Parameters

Path Parameters

businessId

required

string format: uuid

Business ID

Responses

200

Business

Media typeapplication/json

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

name

The name of the Business.

string

email

Email address.

string format: email

logoURL

URL to the logo image.

string | null

defaultStaffWorkingHours

One of:

object

A configuration to define active hours.

object

monday

A group of active hours for a single day.

Array<Array<number>>

tuesday

A group of active hours for a single day.

Array<Array<number>>

wednesday

A group of active hours for a single day.

Array<Array<number>>

thursday

A group of active hours for a single day.

Array<Array<number>>

friday

A group of active hours for a single day.

Array<Array<number>>

saturday

A group of active hours for a single day.

Array<Array<number>>

sunday

A group of active hours for a single day.

Array<Array<number>>

null

null

enabled

Disabled businesses prevent any staff from using the platform.

boolean

timezone

Timezone string.

string

nullable

Example

{
  "data": {
    "alias": "acme",
    "name": "ACME Corp",
    "logoURL": "https://account.upvio.com/upvio.favicon.png",
    "defaultStaffWorkingHours": {
      "monday": [
        [
          900,
          1200
        ],
        [
          1300,
          1700
        ]
      ],
      "tuesday": [
        [
          900,
          1200
        ],
        [
          1300,
          1700
        ]
      ],
      "wednesday": [
        [
          900,
          1200
        ],
        [
          1300,
          1700
        ]
      ],
      "thursday": [
        [
          900,
          1200
        ],
        [
          1300,
          1700
        ]
      ],
      "friday": [
        [
          900,
          1200
        ],
        [
          1300,
          1700
        ]
      ],
      "saturday": [
        [
          900,
          1200
        ],
        [
          1300,
          1700
        ]
      ],
      "sunday": [
        [
          900,
          1200
        ],
        [
          1300,
          1700
        ]
      ]
    },
    "timezone": "UTC"
  }
}

400

The request is invalid.

Media typeapplication/json

object

error

object

code

number

type

The specific error that occurred.

string

Allowed values: BadRequestError

title

Human-readable description of the error.

string

Example

{
  "error": {
    "code": 400,
    "type": "BadRequestError",
    "title": "Business ID does not match API key"
  }
}

403

The API key is missing or invalid, or the Business cannot be accessed with it.

Media typeapplication/json

object

error

object

code

number

type

The specific error that occurred.

string

Allowed values: UnauthorizedError BusinessArchivedError BusinessDisabledError

title

Human-readable description of the error.

string

Example

{
  "error": {
    "code": 403,
    "type": "UnauthorizedError",
    "title": "Invalid API token"
  }
}

404

The Business does not exist.

Media typeapplication/json

object

error

object

code

number

type

The specific error that occurred.

string

Allowed values: NotFoundError BusinessNotFoundError

title

Human-readable description of the error.

string

Example

{
  "error": {
    "code": 404,
    "type": "BusinessNotFoundError",
    "title": "Business not found"
  }
}