Get users businesses
GET/api/v1/users/me/businesses
Return all businesses for currently logged in user
Request
Query Parameters
include string
Include associations (delimited with comma). Available associations: addresses, groups, menus, orders, partners, pictures, products, reviews, exclusive_suppliers
search_query string
Search by business name or city
sort string
filter[state] string
Possible values: [draft, waiting_for_approval, rejected, published, hidden]
State in which business is currently
filter[city] string
Filter businesses by city
filter[groups][] string[]
Filter businesses by access groups to which they belong, pass id of access group
filter[features][] string[]
Filter businesses by features, pass feature name
filter[sort_by] string
page int32
Default value: 1
Page offset to fetch.
per_page int32
Default value: 10
Number of results to return per page.
Responses
- 200
Return all businesses for currently logged in user
- application/vnd.api+json
- Schema
- Example (from schema)
- Example
Schema
Array [
Array [
]
]
data
object[]
required
id stringrequired
type stringrequired
Possible values: [businesses]
links
object
required
self stringrequired
attributes
object
required
access-group string
allow-pickup booleanrequired
approved-for-lefood booleanrequired
auto-accept-orders booleanrequired
auto-accept-booking booleanrequired
auto-accept-booking-limit string
available-in-lefood booleanrequired
average-delivery-time numberrequired
average-score numberrequired
average-waiting-time numberrequired
bill-url string
bio string
booking-open-hours
object
id string
monday string[]
tuesday string[]
wednesday string[]
thursday string[]
friday string[]
saturday string[]
sunday string[]
breakfast-service booleanrequired
brunch-service booleanrequired
business-open-hours
object
id string
monday string[]
tuesday string[]
wednesday string[]
thursday string[]
friday string[]
saturday string[]
sunday string[]
cafe-service booleanrequired
can-pay-with-cards booleanrequired
can-pay-with-cash booleanrequired
can-pay-with-mobile booleanrequired
city stringrequired
contact-with-proper-owner-possible booleanrequired
country stringrequired
country-code stringrequired
currency string
delivery-available booleanrequired
delivery-charge-ref string
delivery-price-participation-ratio stringrequired
delivery-service-type-ref string
delivery-url string
detected-language string
dinner-service booleanrequired
email string
facebook string
favorite-id string
geolocation-lat stringrequired
geolocation-lng stringrequired
has-catering booleanrequired
has-delivery booleanrequired
has-join-the-queue booleanrequired
has-online-booking booleanrequired
has-private-events booleanrequired
has-reservations booleanrequired
has-takeaway booleanrequired
hubrise-catalog-id string
hubrise-catalog-name string
instagram string
live-info string
logo
object
required
url string
lunch-service booleanrequired
main-photo-url string
max-reservation-size numberrequired
menu-synced boolean
min-amount-for-delivery-cents numberrequired
min-time-before-reservation numberrequired
name stringrequired
online-booking-url string
owner-role string
partoo-business-id stringnullable
phone string
phone-country-code string
phone-country-prefix string
pos-partner-integration-exists booleanrequired
post-code stringrequired
price-per-person numberrequired
price-range numberrequired
rating numberrequired
region string
region-code stringrequired
secret-code string
slug string
snack-service booleanrequired
special-open-hours
object[]
id string
start_date stringrequired
end_date stringrequired
schedule string[]required
state stringrequired
street stringrequired
street-number stringrequired
stripe-currency stringrequired
stripe-payment-ref string
eat-in-ref required
stripe-user-id string
tagline string
takeaway-service-type-ref string
takeaway-url string
time-of-stay numberrequired
time-slots numberrequired
timezone stringrequired
unit-name stringrequired
unit-style stringrequired
visible-in-lefood booleanrequired
website string
youtube string
settings
object
required
orkestro_delivery_confirmation_enabled booleanrequired
order_business_web_notifications_enabled booleanrequired
reservation_business_web_notifications_enabled booleanrequired
sidebar-settings
object
required
The sidebar settings reflect the configuration in which the sidebar is displayed for your business.
property name*
object
visible boolean
order number
relationships
object
required
addresses
object
required
links
object
required
self stringrequired
related stringrequired
groups
object
required
links
object
required
self stringrequired
related stringrequired
menus
object
required
links
object
required
self stringrequired
related stringrequired
orders
object
required
links
object
required
self stringrequired
related stringrequired
partners
object
required
links
object
required
self stringrequired
related stringrequired
pictures
object
required
links
object
required
self stringrequired
related stringrequired
products
object
required
links
object
required
self stringrequired
related stringrequired
reviews
object
required
links
object
required
self stringrequired
related stringrequired
exclusive-suppliers
object
required
links
object
required
self stringrequired
related stringrequired
meta
object
required
total-count numberrequired
total-pages numberrequired
{
"data": [
{
"id": "string",
"type": "businesses",
"links": {
"self": "string"
},
"attributes": {
"access-group": "string",
"allow-pickup": true,
"approved-for-lefood": true,
"auto-accept-orders": true,
"auto-accept-booking": true,
"auto-accept-booking-limit": "string",
"available-in-lefood": true,
"average-delivery-time": 0,
"average-score": 0,
"average-waiting-time": 0,
"bill-url": "string",
"bio": "string",
"booking-open-hours": {
"id": "string",
"monday": [
"string"
],
"tuesday": [
"string"
],
"wednesday": [
"string"
],
"thursday": [
"string"
],
"friday": [
"string"
],
"saturday": [
"string"
],
"sunday": [
"string"
]
},
"breakfast-service": true,
"brunch-service": true,
"business-open-hours": {
"id": "string",
"monday": [
"string"
],
"tuesday": [
"string"
],
"wednesday": [
"string"
],
"thursday": [
"string"
],
"friday": [
"string"
],
"saturday": [
"string"
],
"sunday": [
"string"
]
},
"cafe-service": true,
"can-pay-with-cards": true,
"can-pay-with-cash": true,
"can-pay-with-mobile": true,
"city": "string",
"contact-with-proper-owner-possible": true,
"country": "string",
"country-code": "string",
"currency": "string",
"delivery-available": true,
"delivery-charge-ref": "string",
"delivery-price-participation-ratio": "string",
"delivery-service-type-ref": "string",
"delivery-url": "string",
"detected-language": "string",
"dinner-service": true,
"email": "string",
"facebook": "string",
"favorite-id": "string",
"geolocation-lat": "string",
"geolocation-lng": "string",
"has-catering": true,
"has-delivery": true,
"has-join-the-queue": true,
"has-online-booking": true,
"has-private-events": true,
"has-reservations": true,
"has-takeaway": true,
"hubrise-catalog-id": "string",
"hubrise-catalog-name": "string",
"instagram": "string",
"live-info": "string",
"logo": {
"url": "string"
},
"lunch-service": true,
"main-photo-url": "string",
"max-reservation-size": 0,
"menu-synced": true,
"min-amount-for-delivery-cents": 0,
"min-time-before-reservation": 0,
"name": "string",
"online-booking-url": "string",
"owner-role": "string",
"partoo-business-id": "string",
"phone": "string",
"phone-country-code": "string",
"phone-country-prefix": "string",
"pos-partner-integration-exists": true,
"post-code": "string",
"price-per-person": 0,
"price-range": 0,
"rating": 0,
"region": "string",
"region-code": "string",
"secret-code": "string",
"slug": "string",
"snack-service": true,
"special-open-hours": [
{
"id": "string",
"start_date": "string",
"end_date": "string",
"schedule": [
"string"
]
}
],
"state": "string",
"street": "string",
"street-number": "string",
"stripe-currency": "string",
"stripe-payment-ref": "string",
"eat-in-ref": {},
"stripe-user-id": "string",
"tagline": "string",
"takeaway-service-type-ref": "string",
"takeaway-url": "string",
"time-of-stay": 0,
"time-slots": 0,
"timezone": "string",
"unit-name": "string",
"unit-style": "string",
"visible-in-lefood": true,
"website": "string",
"youtube": "string",
"settings": {
"orkestro_delivery_confirmation_enabled": true,
"order_business_web_notifications_enabled": true,
"reservation_business_web_notifications_enabled": true
},
"sidebar-settings": {}
},
"relationships": {
"addresses": {
"links": {
"self": "string",
"related": "string"
}
},
"groups": {
"links": {
"self": "string",
"related": "string"
}
},
"menus": {
"links": {
"self": "string",
"related": "string"
}
},
"orders": {
"links": {
"self": "string",
"related": "string"
}
},
"partners": {
"links": {
"self": "string",
"related": "string"
}
},
"pictures": {
"links": {
"self": "string",
"related": "string"
}
},
"products": {
"links": {
"self": "string",
"related": "string"
}
},
"reviews": {
"links": {
"self": "string",
"related": "string"
}
},
"exclusive-suppliers": {
"links": {
"self": "string",
"related": "string"
}
}
}
}
],
"meta": {
"total-count": 0,
"total-pages": 0
}
}
{
"data": [
{
"id": "0eb74ac0-c750-4eee-a467-282bdb0e23a4",
"type": "businesses",
"links": {
"self": "/businesses/0eb74ac0-c750-4eee-a467-282bdb0e23a4"
},
"attributes": {
"allow-pickup": true,
"approved-for-lefood": true,
"auto-accept-orders": false,
"auto-accept-booking": false,
"auto-accept-booking-limit": "2",
"available-in-lefood": true,
"average-delivery-time": 30,
"average-score": 7.3,
"average-waiting-time": 30,
"bill-url": "https://demo.sundayapp.xyz/order/a1731086-274b-3864-86a9-5706a796c799",
"bio": "Le Cinq is a gourmet restaurant in Paris, France, part of the Four Seasons Hotel George V. Le Cinq opened in 2001 to much fanfare and rapidly achieved 1, 2, then 3 Michelin Red Guide stars under the direction of chef Philippe Legendre before being demoted to 2 stars.\r\n\r\nPlease note: order beyond 3km distance won't receive warm meal",
"breakfast-service": true,
"brunch-service": true,
"cafe-service": true,
"can-pay-with-cards": true,
"can-pay-with-cash": true,
"can-pay-with-mobile": true,
"city": "Paris",
"connected-to-partoo": false,
"contact-with-proper-owner-possible": true,
"country": "France",
"country-code": "FR",
"currency": "EUR",
"delivery-available": true,
"delivery-charge-ref": "1234",
"delivery-price-participation-ratio": "1.0",
"delivery-service-type-ref": "2222",
"delivery-url": null,
"detected-language": "en",
"dinner-service": true,
"email": "thefooddetective-team@netguru.pl",
"facebook": "https://www.facebook.com/power.api/",
"favorite-id": null,
"geolocation-lat": "48.8610643",
"geolocation-lng": "2.3599261",
"has-catering": true,
"has-delivery": false,
"has-join-the-queue": true,
"has-online-booking": false,
"has-private-events": true,
"has-reservations": true,
"has-takeaway": false,
"hubrise-catalog-id": "17mxg",
"hubrise-catalog-name": "Le cinq (2) - Uber Eat test account",
"instagram": "https://www.instagram.com/foodetective.co/",
"live-info": null,
"logo": {
"url": "https://foodetective-staging-backend-data.s3.amazonaws.com/uploads/business/logo/0eb74ac0-c750-4eee-a467-282bdb0e23a4/e43529b1-462d-4e97-95fd-03f2e159b9f8.jpeg"
},
"lunch-service": true,
"main-photo-url": "https://foodetective-staging-backend-data.s3.amazonaws.com/uploads/picture/photo/846219ae-bf08-4ba8-b726-b557c3128ae9/8bd57a06-0be5-4527-b4f5-8468ec8255f5.jpeg",
"max-reservation-size": 8,
"menu-synced": false,
"min-amount-for-delivery-cents": 1000,
"min-time-before-reservation": 1800,
"name": "Restaurant",
"online-booking-url": null,
"owner-role": "Main owner",
"phone": "345345345",
"phone-country-code": "FR",
"phone-country-prefix": "33",
"pos-partner-integration-exists": true,
"post-code": "75003",
"price-per-person": 45,
"price-range": 3,
"rating": 7.3,
"region": "Paris",
"region-code": "FR-75",
"secret-code": null,
"slug": "restaurant-10",
"snack-service": true,
"state": "published",
"street": "Rue Charlot",
"street-number": "5",
"stripe-currency": "EUR",
"stripe-payment-ref": "4321",
"eat-in-ref": null,
"stripe-user-id": "acct_1GkWA1Lj6G4jVdPy",
"tagline": "The best restaurant in Paris!",
"takeaway-service-type-ref": "4444",
"takeaway-url": null,
"time-of-stay": 600,
"time-slots": 3000,
"timezone": "Europe/Paris",
"unit-name": "Table",
"unit-style": "Style 1",
"visible-in-lefood": true,
"website": "https://www.index.hr/",
"youtube": "https://youtu.be/-DVkz4LLu8w",
"settings": {
"orkestro_delivery_confirmation_enabled": true,
"order_business_web_notifications_enabled": true,
"reservation_business_web_notifications_enabled": false
},
"sidebar-settings": {
"home": {
"visible": true,
"order": 0
},
"dashboard": {
"visible": true,
"order": 1
}
},
"partoo-business-id": null
},
"relationships": {
"addresses": {
"links": {
"self": "/businesses/0eb74ac0-c750-4eee-a467-282bdb0e23a4/relationships/addresses",
"related": "/businesses/0eb74ac0-c750-4eee-a467-282bdb0e23a4/addresses"
}
},
"groups": {
"links": {
"self": "/businesses/0eb74ac0-c750-4eee-a467-282bdb0e23a4/relationships/groups",
"related": "/businesses/0eb74ac0-c750-4eee-a467-282bdb0e23a4/groups"
}
},
"menus": {
"links": {
"self": "/businesses/0eb74ac0-c750-4eee-a467-282bdb0e23a4/relationships/menus",
"related": "/businesses/0eb74ac0-c750-4eee-a467-282bdb0e23a4/menus"
}
},
"orders": {
"links": {
"self": "/businesses/0eb74ac0-c750-4eee-a467-282bdb0e23a4/relationships/orders",
"related": "/businesses/0eb74ac0-c750-4eee-a467-282bdb0e23a4/orders"
}
},
"partners": {
"links": {
"self": "/businesses/0eb74ac0-c750-4eee-a467-282bdb0e23a4/relationships/partners",
"related": "/businesses/0eb74ac0-c750-4eee-a467-282bdb0e23a4/partners"
}
},
"pictures": {
"links": {
"self": "/businesses/0eb74ac0-c750-4eee-a467-282bdb0e23a4/relationships/pictures",
"related": "/businesses/0eb74ac0-c750-4eee-a467-282bdb0e23a4/pictures"
}
},
"products": {
"links": {
"self": "/businesses/0eb74ac0-c750-4eee-a467-282bdb0e23a4/relationships/products",
"related": "/businesses/0eb74ac0-c750-4eee-a467-282bdb0e23a4/products"
}
},
"reviews": {
"links": {
"self": "/businesses/0eb74ac0-c750-4eee-a467-282bdb0e23a4/relationships/reviews",
"related": "/businesses/0eb74ac0-c750-4eee-a467-282bdb0e23a4/reviews"
}
},
"exclusive-suppliers": {
"links": {
"self": "/businesses/0eb74ac0-c750-4eee-a467-282bdb0e23a4/relationships/exclusive-suppliers",
"related": "/businesses/0eb74ac0-c750-4eee-a467-282bdb0e23a4/exclusive-suppliers"
}
}
}
}
],
"meta": {
"total-count": 1,
"total-pages": 1
}
}
Loading...