Acuity Scheduling · JSON-LD Context

Acuity Context

JSON-LD context defining the semantic vocabulary for Acuity from Acuity Scheduling.

31 Classes 10 Properties 3 Namespaces

View Context View on GitHub

Namespaces

acuity: https://acuityscheduling.com/api/v1/

schema: https://schema.org/

xsd: http://www.w3.org/2001/XMLSchema#

Classes

id firstName lastName phone location price paid amountPaid timezone notes type appointmentTypeID calendarID calendar classID category certificate addonIDs canClientCancel canClientReschedule noShow smsOptIn forms labels formsText transactionID processor amount color meta hooks

Properties

Property	Type	Container
Appointment	reference
email	reference
datetime	dateTime
endTime	dateTime
dateCreated	dateTime
duration	string
confirmationPage	reference
Payment	reference
created	dateTime
Label	reference

JSON-LD Document

{
  "@context": {
    "@version": 1.1,
    "acuity": "https://acuityscheduling.com/api/v1/",
    "schema": "https://schema.org/",
    "xsd": "http://www.w3.org/2001/XMLSchema#",

    "Appointment": {
      "@id": "schema:Appointment",
      "@type": "@id"
    },
    "id": "@id",
    "firstName": "schema:givenName",
    "lastName": "schema:familyName",
    "phone": "schema:telephone",
    "email": {
      "@id": "schema:email",
      "@type": "@id"
    },
    "datetime": {
      "@id": "schema:startDate",
      "@type": "xsd:dateTime"
    },
    "endTime": {
      "@id": "schema:endDate",
      "@type": "xsd:dateTime"
    },
    "dateCreated": {
      "@id": "schema:dateCreated",
      "@type": "xsd:dateTime"
    },
    "duration": {
      "@id": "schema:duration",
      "@type": "xsd:string"
    },
    "location": "schema:location",
    "price": "schema:price",
    "paid": "acuity:paid",
    "amountPaid": "acuity:amountPaid",
    "timezone": "schema:timezone",
    "notes": "schema:description",
    "confirmationPage": {
      "@id": "schema:url",
      "@type": "@id"
    },
    "type": "schema:name",
    "appointmentTypeID": "acuity:appointmentTypeID",
    "calendarID": "acuity:calendarID",
    "calendar": "acuity:calendar",
    "classID": "acuity:classID",
    "category": "schema:category",
    "certificate": "acuity:certificate",
    "addonIDs": "acuity:addonIDs",
    "canClientCancel": "acuity:canClientCancel",
    "canClientReschedule": "acuity:canClientReschedule",
    "noShow": "acuity:noShow",
    "smsOptIn": "acuity:smsOptIn",
    "forms": "acuity:forms",
    "labels": "acuity:labels",
    "formsText": "acuity:formsText",

    "Payment": {
      "@id": "schema:MonetaryAmount",
      "@type": "@id"
    },
    "transactionID": "acuity:transactionID",
    "processor": "acuity:processor",
    "amount": "schema:price",
    "created": {
      "@id": "schema:dateCreated",
      "@type": "xsd:dateTime"
    },

    "Label": {
      "@id": "acuity:Label",
      "@type": "@id"
    },
    "color": "schema:color",

    "meta": "acuity:meta",
    "hooks": "acuity:hooks"
  }
}