Skip to main content
GET
/
locations
/
{locationSlugOrId}
Get location basic info
curl --request GET \
  --url https://api.craveup.com/api/v1/locations/{locationSlugOrId} \
  --header 'X-API-Key: <api-key>'
{
  "id": "loc_456def",
  "restaurantSlug": "downtown-pizza",
  "restaurantDisplayName": "Downtown Pizza Co",
  "addressData": {
    "street": null,
    "streetOptional": "",
    "city": null,
    "state": null,
    "zipCode": null,
    "country": null,
    "lat": null,
    "lng": null
  },
  "addressString": "",
  "restaurantBio": "",
  "coverPhoto": "",
  "restaurantLogo": ""
}

Authorizations

​
X-API-Key
string
header
required

API Key required to authenticate requests

Path Parameters

​
locationSlugOrId
string
required

Location slug (e.g. downtown-pizza) or the 24-character location ID (e.g. 6512c8c1f3d9a5aa9d02e2b1).

Response

Location retrieved successfully.

​
id
string
required
Example:

"loc_456def"

​
restaurantSlug
string
required
Example:

"downtown-pizza"

​
restaurantDisplayName
string
required
Example:

"Downtown Pizza Co"

​
addressData
object
required
​
addressString
string
required

Human-readable address assembled from the address fields. Empty string when not available.

Example:

""

​
restaurantBio
string

Marketing copy for the location. Empty string when not configured.

Example:

""

​
coverPhoto
string

Hero image URL for the location. Empty string when no image is stored.

Example:

""

Square logo URL for the location. Empty string when not configured.

Example:

""