Get an appointment

GET

/api/v1/appointments/{id}

const url = 'https://digize.com/api/v1/appointments/example';
const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://digize.com/api/v1/appointments/example \
  --header 'x-api-key: <x-api-key>'

One appointment with its customer, deposit and status.

Needs the crm:read permission.

Authorizations

apiKey
bearer

Parameters

Path Parameters

required

string

>= 1 characters <= 64 characters

Responses

200

Done

application/json

object

required

string

calendarId

required

string

service

required

The calendar’s name when it was booked.

string

customer

required

object

required

The contact’s id.

string

name

required

string

email

required

string

phone

required

string

staff

required

object

required

The team member’s user id.

string

name

required

string

partySize

required

number

startsAt

required

string format: date-time

endsAt

required

string format: date-time

status

required

string

Allowed values: confirmed deposit_due completed cancelled no_show

total

required

The price for the whole party.

integer

<= 100000000

deposit

required

The deposit for the whole party.

integer

<= 100000000

depositPaidAt

required

Any of:

string
null

string format: date-time

depositRefunded

required

boolean

paymentId

required

The Stripe PaymentIntent that took the deposit.

string | null

notes

required

string | null

bookedVia

required

string

Allowed values: site staff

bookedAt

required

string format: date-time

Example

{
  "status": "confirmed",
  "bookedVia": "site"
}

400

What was sent isn’t valid (invalid).

application/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

401

No key, or one that’s unknown, off or expired.

application/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

403

The key doesn’t have the permission this needs.

application/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

404

Nothing has that id (not_found).

application/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

429

Over the rate limit; see retry-after.

application/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}