Skip to main content
GET
/
api
/
v1
/
locations
/
{locationSlugOrId}
curl -X GET https://api.cravejs.com/api/v1/locations/downtown-pizza \
  -H "X-API-Key: YOUR_API_KEY"

{
  "id": "64a7b8c9d1e2f3a4b5c6d7e8",
  "restaurantSlug": "downtown-pizza",
  "restaurantDisplayName": "Downtown Pizza Co",
  "restaurantBio": "Authentic wood-fired pizza in the heart of downtown",
  "coverPhoto": "https://example.com/images/cover-photo.jpg",
  "restaurantLogo": "https://example.com/images/logo.png",
  "addressData": {
    "street": "456 Main Street",
    "streetOptional": "Suite 100",
    "city": "San Francisco",
    "state": "CA",
    "zipCode": "94102",
    "country": "United States",
    "lat": 37.7749,
    "lng": -122.4194,
    "_id": "64a7b8c9d1e2f3a4b5c6d7e9",
    "id": "64a7b8c9d1e2f3a4b5c6d7e9"
  },
  "addressString": "456 Main Street, Suite 100, San Francisco CA 94102, United States",
  "isOrderingAllowed": true,
  "isScheduledOrderAllowed": true
}

​
Path Parameters

​
locationSlugOrId
string
required
The unique identifier or slug for the restaurant location

​
Playground

curl -X GET https://api.cravejs.com/api/v1/locations/downtown-pizza \
  -H "X-API-Key: YOUR_API_KEY"

{
  "id": "64a7b8c9d1e2f3a4b5c6d7e8",
  "restaurantSlug": "downtown-pizza",
  "restaurantDisplayName": "Downtown Pizza Co",
  "restaurantBio": "Authentic wood-fired pizza in the heart of downtown",
  "coverPhoto": "https://example.com/images/cover-photo.jpg",
  "restaurantLogo": "https://example.com/images/logo.png",
  "addressData": {
    "street": "456 Main Street",
    "streetOptional": "Suite 100",
    "city": "San Francisco",
    "state": "CA",
    "zipCode": "94102",
    "country": "United States",
    "lat": 37.7749,
    "lng": -122.4194,
    "_id": "64a7b8c9d1e2f3a4b5c6d7e9",
    "id": "64a7b8c9d1e2f3a4b5c6d7e9"
  },
  "addressString": "456 Main Street, Suite 100, San Francisco CA 94102, United States",
  "isOrderingAllowed": true,
  "isScheduledOrderAllowed": true
}

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
locationSlugOrId
string
required

The unique identifier or slug for the restaurant location

Response

Location information retrieved successfully.

​
id
string

The unique identifier of the location

​
restaurantSlug
string

The URL-friendly slug for the restaurant

​
restaurantDisplayName
string

The display name of the restaurant

​
restaurantBio
string

A brief description of the restaurant

​
coverPhoto
string

URL of the restaurant's cover photo

URL of the restaurant's logo

​
addressData
object
​
addressString
string

Formatted address string

​
isOrderingAllowed
boolean

Whether ordering is currently allowed at this location

​
isScheduledOrderAllowed
boolean

Whether scheduled orders are allowed at this location