Yelp · JSON-LD Context

Yelp Context

JSON-LD context defining the semantic vocabulary for Yelp from Yelp.

25 Classes 86 Properties 4 Namespaces

View Context View on GitHub

Namespaces

schema: https://schema.org/

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

dcterms: http://purl.org/dc/terms/

yelp: https://yelp.com/schema#

Classes

ProgramName DIField Error AiChatRequest AiChatResponse MatchingCriteria Update LeadObject Project ProjectConsumerUser LeadEventContentBase LeadEventBase GetEventsResponse WriteLeadEventRequest RequestBodyValidationFailureResponse MarkLeadAsRepliedRequest MarkLeadEventAsReadRequest TokenRequestBase TokenRefreshTokenResponse AddRemoveBusinessesToAllowListResponse WebhookKeySet WebhookKey OrderValue BookedService GenericAttributionWebhookRequest

Properties

Property	Type	Container
status	string
requested_value	string
error
query	string
chat_id	string
user_context
request_context
response
types		list
entities		list
request_a_quote_survey
address1	string
address2	string
address3	string
city	string
country	string
latitude	decimal
longitude	decimal
name	string
phone	string
postal_code	string
state	string
yelp_business_id	string
about_this_business_history	string
service_type_v2
id	string
business_id	string
conversation_id	string
temporary_email_address	string
temporary_email_address_expiry	dateTime
temporary_phone_number	string
temporary_phone_number_expiry	dateTime
phone_number	string
time_created	dateTime
last_event_time	dateTime
user	reference
project	reference
link_to_reply_in_yelp	string
location
availability
job_names		list
survey_answers		list
attachments		list
display_name	string
fallback_text	string
cursor	string
user_type	string
user_id	string
user_display_name	string
channel	string
events		list
request_content	string
request_type	string
reply_type	string
event_id	string
time_read	dateTime
client_id	reference
client_secret	reference
grant_type	string
access_token	reference
expires_in	integer
expires_on	dateTime
token_type	string
whitelist_business_ids_count	decimal
keys		list
kty	string
crv	string
kid	string
use	string
x	string
price	decimal
currency	string
title	string
provider	string
duration_minutes	integer
start_datetime	integer
order_value	reference
yelp_token	string
event_type	string
event_timestamp	integer
external_id	string
original_external_id	string
external_business_id	string
booking_details_url	string
booked_services		list
metadata

JSON-LD Document

{
  "@context": {
    "@vocab": "https://yelp.com/schema#",
    "schema": "https://schema.org/",
    "xsd": "http://www.w3.org/2001/XMLSchema#",
    "dcterms": "http://purl.org/dc/terms/",
    "yelp": "https://yelp.com/schema#",
    "ProgramName": "yelp:ProgramName",
    "DIField": "yelp:DIField",
    "status": {
      "@id": "yelp:status",
      "@type": "xsd:string"
    },
    "requested_value": {
      "@id": "yelp:requested_value",
      "@type": "xsd:string"
    },
    "Error": "yelp:Error",
    "error": {
      "@id": "yelp:error"
    },
    "AiChatRequest": "yelp:AiChatRequest",
    "query": {
      "@id": "yelp:query",
      "@type": "xsd:string"
    },
    "chat_id": {
      "@id": "yelp:chat_id",
      "@type": "xsd:string"
    },
    "user_context": {
      "@id": "yelp:user_context"
    },
    "request_context": {
      "@id": "yelp:request_context"
    },
    "AiChatResponse": "yelp:AiChatResponse",
    "response": {
      "@id": "yelp:response"
    },
    "types": {
      "@id": "yelp:types",
      "@container": "@list"
    },
    "entities": {
      "@id": "yelp:entities",
      "@container": "@list"
    },
    "request_a_quote_survey": {
      "@id": "yelp:request_a_quote_survey"
    },
    "MatchingCriteria": "yelp:MatchingCriteria",
    "address1": {
      "@id": "yelp:address1",
      "@type": "xsd:string"
    },
    "address2": {
      "@id": "yelp:address2",
      "@type": "xsd:string"
    },
    "address3": {
      "@id": "yelp:address3",
      "@type": "xsd:string"
    },
    "city": {
      "@id": "yelp:city",
      "@type": "xsd:string"
    },
    "country": {
      "@id": "yelp:country",
      "@type": "xsd:string"
    },
    "latitude": {
      "@id": "yelp:latitude",
      "@type": "xsd:decimal"
    },
    "longitude": {
      "@id": "yelp:longitude",
      "@type": "xsd:decimal"
    },
    "name": {
      "@id": "yelp:name",
      "@type": "xsd:string"
    },
    "phone": {
      "@id": "yelp:phone",
      "@type": "xsd:string"
    },
    "postal_code": {
      "@id": "yelp:postal_code",
      "@type": "xsd:string"
    },
    "state": {
      "@id": "yelp:state",
      "@type": "xsd:string"
    },
    "yelp_business_id": {
      "@id": "yelp:yelp_business_id",
      "@type": "xsd:string"
    },
    "Update": "yelp:Update",
    "about_this_business_history": {
      "@id": "yelp:about_this_business_history",
      "@type": "xsd:string"
    },
    "service_type_v2": {
      "@id": "yelp:service_type_v2"
    },
    "LeadObject": "yelp:LeadObject",
    "id": {
      "@id": "yelp:id",
      "@type": "xsd:string"
    },
    "business_id": {
      "@id": "yelp:business_id",
      "@type": "xsd:string"
    },
    "conversation_id": {
      "@id": "yelp:conversation_id",
      "@type": "xsd:string"
    },
    "temporary_email_address": {
      "@id": "yelp:temporary_email_address",
      "@type": "xsd:string"
    },
    "temporary_email_address_expiry": {
      "@id": "yelp:temporary_email_address_expiry",
      "@type": "xsd:dateTime"
    },
    "temporary_phone_number": {
      "@id": "yelp:temporary_phone_number",
      "@type": "xsd:string"
    },
    "temporary_phone_number_expiry": {
      "@id": "yelp:temporary_phone_number_expiry",
      "@type": "xsd:dateTime"
    },
    "phone_number": {
      "@id": "yelp:phone_number",
      "@type": "xsd:string"
    },
    "time_created": {
      "@id": "yelp:time_created",
      "@type": "xsd:dateTime"
    },
    "last_event_time": {
      "@id": "yelp:last_event_time",
      "@type": "xsd:dateTime"
    },
    "user": {
      "@id": "yelp:user",
      "@type": "@id"
    },
    "project": {
      "@id": "yelp:project",
      "@type": "@id"
    },
    "link_to_reply_in_yelp": {
      "@id": "yelp:link_to_reply_in_yelp",
      "@type": "xsd:string"
    },
    "Project": "yelp:Project",
    "location": {
      "@id": "yelp:location"
    },
    "availability": {
      "@id": "yelp:availability"
    },
    "job_names": {
      "@id": "yelp:job_names",
      "@container": "@list"
    },
    "survey_answers": {
      "@id": "yelp:survey_answers",
      "@container": "@list"
    },
    "attachments": {
      "@id": "yelp:attachments",
      "@container": "@list"
    },
    "ProjectConsumerUser": "yelp:ProjectConsumerUser",
    "display_name": {
      "@id": "yelp:display_name",
      "@type": "xsd:string"
    },
    "LeadEventContentBase": "yelp:LeadEventContentBase",
    "fallback_text": {
      "@id": "yelp:fallback_text",
      "@type": "xsd:string"
    },
    "LeadEventBase": "yelp:LeadEventBase",
    "cursor": {
      "@id": "yelp:cursor",
      "@type": "xsd:string"
    },
    "user_type": {
      "@id": "yelp:user_type",
      "@type": "xsd:string"
    },
    "user_id": {
      "@id": "yelp:user_id",
      "@type": "xsd:string"
    },
    "user_display_name": {
      "@id": "yelp:user_display_name",
      "@type": "xsd:string"
    },
    "channel": {
      "@id": "yelp:channel",
      "@type": "xsd:string"
    },
    "GetEventsResponse": "yelp:GetEventsResponse",
    "events": {
      "@id": "yelp:events",
      "@container": "@list"
    },
    "WriteLeadEventRequest": "yelp:WriteLeadEventRequest",
    "request_content": {
      "@id": "yelp:request_content",
      "@type": "xsd:string"
    },
    "request_type": {
      "@id": "yelp:request_type",
      "@type": "xsd:string"
    },
    "RequestBodyValidationFailureResponse": "yelp:RequestBodyValidationFailureResponse",
    "MarkLeadAsRepliedRequest": "yelp:MarkLeadAsRepliedRequest",
    "reply_type": {
      "@id": "yelp:reply_type",
      "@type": "xsd:string"
    },
    "MarkLeadEventAsReadRequest": "yelp:MarkLeadEventAsReadRequest",
    "event_id": {
      "@id": "yelp:event_id",
      "@type": "xsd:string"
    },
    "time_read": {
      "@id": "yelp:time_read",
      "@type": "xsd:dateTime"
    },
    "TokenRequestBase": "yelp:TokenRequestBase",
    "client_id": {
      "@id": "yelp:client_id",
      "@type": "@id"
    },
    "client_secret": {
      "@id": "yelp:client_secret",
      "@type": "@id"
    },
    "grant_type": {
      "@id": "yelp:grant_type",
      "@type": "xsd:string"
    },
    "TokenRefreshTokenResponse": "yelp:TokenRefreshTokenResponse",
    "access_token": {
      "@id": "yelp:access_token",
      "@type": "@id"
    },
    "expires_in": {
      "@id": "yelp:expires_in",
      "@type": "xsd:integer"
    },
    "expires_on": {
      "@id": "yelp:expires_on",
      "@type": "xsd:dateTime"
    },
    "token_type": {
      "@id": "yelp:token_type",
      "@type": "xsd:string"
    },
    "AddRemoveBusinessesToAllowListResponse": "yelp:AddRemoveBusinessesToAllowListResponse",
    "whitelist_business_ids_count": {
      "@id": "yelp:whitelist_business_ids_count",
      "@type": "xsd:decimal"
    },
    "WebhookKeySet": "yelp:WebhookKeySet",
    "keys": {
      "@id": "yelp:keys",
      "@container": "@list"
    },
    "WebhookKey": "yelp:WebhookKey",
    "kty": {
      "@id": "yelp:kty",
      "@type": "xsd:string"
    },
    "crv": {
      "@id": "yelp:crv",
      "@type": "xsd:string"
    },
    "kid": {
      "@id": "yelp:kid",
      "@type": "xsd:string"
    },
    "use": {
      "@id": "yelp:use",
      "@type": "xsd:string"
    },
    "x": {
      "@id": "yelp:x",
      "@type": "xsd:string"
    },
    "OrderValue": "yelp:OrderValue",
    "price": {
      "@id": "yelp:price",
      "@type": "xsd:decimal"
    },
    "currency": {
      "@id": "yelp:currency",
      "@type": "xsd:string"
    },
    "BookedService": "yelp:BookedService",
    "title": {
      "@id": "yelp:title",
      "@type": "xsd:string"
    },
    "provider": {
      "@id": "yelp:provider",
      "@type": "xsd:string"
    },
    "duration_minutes": {
      "@id": "yelp:duration_minutes",
      "@type": "xsd:integer"
    },
    "start_datetime": {
      "@id": "yelp:start_datetime",
      "@type": "xsd:integer"
    },
    "order_value": {
      "@id": "yelp:order_value",
      "@type": "@id"
    },
    "GenericAttributionWebhookRequest": "yelp:GenericAttributionWebhookRequest",
    "yelp_token": {
      "@id": "yelp:yelp_token",
      "@type": "xsd:string"
    },
    "event_type": {
      "@id": "yelp:event_type",
      "@type": "xsd:string"
    },
    "event_timestamp": {
      "@id": "yelp:event_timestamp",
      "@type": "xsd:integer"
    },
    "external_id": {
      "@id": "yelp:external_id",
      "@type": "xsd:string"
    },
    "original_external_id": {
      "@id": "yelp:original_external_id",
      "@type": "xsd:string"
    },
    "external_business_id": {
      "@id": "yelp:external_business_id",
      "@type": "xsd:string"
    },
    "booking_details_url": {
      "@id": "yelp:booking_details_url",
      "@type": "xsd:string"
    },
    "booked_services": {
      "@id": "yelp:booked_services",
      "@container": "@list"
    },
    "metadata": {
      "@id": "yelp:metadata"
    }
  },
  "@type": "schema:Dataset",
  "schema:name": "Yelp API JSON-LD context",
  "schema:description": "A JSON-LD @context for the objects Yelp's own API contract declares: one class per component schema, one property per declared field, typed from the contract. Derived by script (derive-json-ld.py, 2026-11-05) from openapi/yelp-advertising-api-openapi.yml, openapi/yelp-ai-api-openapi.yml, openapi/yelp-business-subscriptions-api-openapi.yml.",
  "dcterms:created": "2026-11-05",
  "dcterms:source": [
    "openapi/yelp-advertising-api-openapi.yml",
    "openapi/yelp-ai-api-openapi.yml",
    "openapi/yelp-business-subscriptions-api-openapi.yml",
    "openapi/yelp-businesses-api-openapi.yml",
    "openapi/yelp-categories-api-openapi.yml"
  ]
}