Latest update v1.2 at 2025-07-23
\nPlease let us know at hi@resos.com if you have questions or something you need is missing. We are extending the API as needed and per your request.
\nAPI wrapper for Ruby by Tochman (unofficial)
\nAll API requests are rate-limited. The current limit is 100 requests / sec, with a fixed-time reset (i.e. every minute as opposed to a minute from the first request).
\nAll API responses will include the following headers:
\n\n\nRetry-After: Time in ms until reset
\n
Authentication to the resOS API is done using a private API key.
\nAPI key authentication is done by providing one of your private API keys in the request. You can manage your private API keys from your account settings.
\nFirst ensure that the API app is enabled for your restaurant. If not, you can enable it from sidebar -> Apps. When it is enabled, head to your Settings page from the sidebar and find API credentials under the Apps category. On this page, you can view all your existing API keys and generate new ones. If none exist, simply click Generate key. The key that appears is your API key, and should be included in all requests / used for the Zapier connection.
\nYou can also delete old API keys if you wish. Please note that any deleted keys will be invalidated, which means they will not work anymore for API requests or the Zapier integration.
\nRemember to keep this secret! Anyone with this key can perform all actions on resOS for your restaurant data. If used for our API, do not include this in front-end / client-side code, handle it all back-end / server-side. If you suspect that your key has been leaked, stolen or otherwise not secret anymore, you can invalidate it by going to your API credentials settings and deleting it.
\nThe API key must be provided as the HTTP Basic Auth username in all requests. No password should be provided. HTTP Basic Auth is performed by sending an Authorization header with value Basic base64(':').
\nE.g. for a private key:
\n\n\naIcCpRKQqKPg9zVL0a7-RJt2_zx8jPq8jR20XWp_pZN
\n
the key is base64 encoded with a tailing \":\":
\n\n\nbase64('aIcCpRKQqKPg9zVL0a7-RJt2_zx8jPq8jR20XWp_pZN:')
\n
resulting in the value:
\n\n\nYUljQ3BSS1FxS1BnOXpWTDBhNy1SSnQyX3p4OGpQcThqUjIwWFdwX3BaTjo=
\n
The complete header will be:
\n\n\nAuthorization: Basic YUljQ3BSS1FxS1BnOXpWTDBhNy1SSnQyX3p4OGpQcThqUjIwWFdwX3BaTjo=
\n
To test base64 encoding the following site can be used www.base64decode.org
\nIf testing via Postman:
\nMake sure your API key is not being base64 encoded twice. If you pass your API key via the requests' Authorization tab, the API key should be put as is. This is due to Postman automatically encoding it.
\nRequests to our API will fail from the frontend due to our CORS policy. This is done for security reasons - since requests to our API require an API key, requests from the frontend would need to have your API key embedded in the code of the page, making it trivial for anyone to read and make requests on your behalf.
\nThe proper way of calling the API from the frontend is to have a backend which relays the request and response, storing only your API key on the server backend.
\nAll requests must be made using HTTPS for security reasons. Any requests in HTTP will be rejected.
\nAs POST and PUT data we accept application/json content-type. The content-type must be defined in the HTTP header of requests.
\nFor GET requests query parameters are used e.g. for pagination.
\nAll responses will be in JSON.
\nSome list endpoints support pagination using skip and limit query variables, where skip defines the number or records to skip in the result and limit defined the number of records to return.
\nBy default skip is 0 and limit is 100. Maximum number of records returned is also 100 unless defined otherwise for a specific endpoint.
\nE.g. to get 10 records at a time, getting records from 20 to 30:
\n\n\n/bookings?skip=20&limit=10
\n
We use conventional HTTP response codes to indicate success or failure of an API request.
\nIn general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information, and codes in the 5xx range indicate an error at resOS.
\nBesides the status code we include an error description as a text string in the response body.
\nBesides the status code and error text, a hint to the exact problem may be included in the response.
\nWe are currently working on webhooks. If you have any specific requests, needs or use-cases you'd like to see implemented, please reach out to us at hi@resos.com.
\nAll endpoints that return a list can be sorted. This is done by passing a sort parameter.
Sorting by ascending takes the value 1. Descending, the value -1. All document fields can be used for sorting.
E.g. sorting by date, ascending: createdAt:1 or descending createdAt:-1.
Multiple sorting parameters can be passed, with a comma as the delimiter. The results are sorted in priority with regards to the order in which the parameters are passed. E.g. createdAt:1,updatedAt:-1.
Search expressions provide a powerful way to further refine the search results from the API. It supports filtering for any one or more fields as needed.
\nAll dates should be in UTC (Coordinated Universal Time).
\nA search expression is passed as a header in the HTTP request. Each parameter is split by a comma.
\nSearch expressions support the following operators:
\nExamples:
\nMore than 2 people, approved status
\ncustomQuery=people>2,status:\"approved\"
Earlier than date, source contains google
\ncustomQuery=date<\"2021-09-18\",source;\"google\"
Any document fields are searchable in this manner.
Note - for phone numbers, the country code must be included as the first 2 digits. The + sign is not required. For example:customQuery=guest.phone:\"4511111111\"
ISO date format (ISO 8601) in UTC.
\n","type":"text/plain"},"key":"fromDateTime","value":"2021-04-17"},{"description":{"content":"ISO date format (ISO 8601) in UTC.
\n","type":"text/plain"},"key":"toDateTime","value":"2021-04-18"},{"description":{"content":"See \"Pagination\" documentation
\n","type":"text/plain"},"key":"limit","value":"10"},{"description":{"content":"See \"Pagination\" documentation
\n","type":"text/plain"},"key":"skip","value":"1"},{"description":{"content":"Sort results by field. 1 ascending, -1 descending
\n","type":"text/plain"},"key":"sort","value":"createdAt:1"},{"description":{"content":"See \"Search expression\" documentation
\n","type":"text/plain"},"key":"customQuery","value":"people>1,duration>60"},{"description":{"content":"Return only confirmed bookings, i.e. status is not request, and if payment is enabled for it, the payment status is either settled or authorized.
\n","type":"text/plain"},"key":"onlyConfirmed","value":"true/false"}],"variable":[]}},"response":[{"id":"5a36bf94-1111-418c-958a-a4b97b9fd562","name":"List bookings","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.resos.com/v1/bookings?fromDateTime=2021-04-17&toDateTime=2021-04-18&limit=10&skip=1&sort=createdAt:1&customQuery=people>1,duration>60","protocol":"https","host":["api","resos","com"],"path":["v1","bookings"],"query":[{"key":"fromDateTime","value":"2021-04-17"},{"key":"toDateTime","value":"2021-04-18"},{"key":"limit","value":"10"},{"key":"skip","value":"1"},{"key":"sort","value":"createdAt:1"},{"key":"customQuery","value":"people>1,duration>60"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"retry-after","value":"60","description":"","type":"text"},{"key":"x-ratelimit-limit","value":"100","description":"","type":"text"},{"key":"x-ratelimit-remaining","value":"99","description":"","type":"text"},{"key":"x-ratelimit-reset","value":"Mon May 31 2021 14:36:25 GMT+0200 (Central European Summer Time)","description":"","type":"text"},{"key":"access-control-allow-headers","value":"Authorization,Content-Type","description":"","type":"text"},{"key":"content-type","value":"application/json","description":"","type":"text"},{"key":"vary","value":"Accept-Encoding","description":"","type":"text"},{"key":"content-encoding","value":"gzip","description":"","type":"text"},{"key":"date","value":"Mon, 31 May 2021 12:35:25 GMT","description":"","type":"text"},{"key":"connection","value":"keep-alive","description":"","type":"text"},{"key":"transfer-encoding","value":"chunked","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\r\n { \r\n \"_id\" : \"jTW8s9PvK2FMaQP3Y\", \r\n \"restaurantId\" : \"gd2cZJZuP3SZPknAX\", \r\n \"date\" : \"2021-02-25\", \r\n \"time\" : \"11:45\", \r\n \"people\" : 2, \r\n \"guest\" : {\r\n \"name\" : \"Morpheus\", \r\n \"email\" : \"neo@resos.com\", \r\n \"phone\" : \"+4500000000\", \r\n \"notificationEmail\" : true, \r\n \"notificationSms\" : false\r\n }, \r\n \"languageCode\" : \"en\", \r\n \"status\" : \"approved\", \r\n \"openingHourId\" : \"PXDCXmgg2XyfRC4AT\", \r\n \"referrer\" : \"\", \r\n \"source\" : \"website\", \r\n \"dateTime\" : \"2021-02-25T10:45:00.000+0000\", \r\n \"createdAt\" : \"2021-02-25T10:24:26.187+0000\", \r\n \"activityAt\" : \"2021-02-25T10:24:26.187+0000\", \r\n \"sendNotification\" : true, \r\n \"seenByRestaurant\" : false, \r\n \"restaurant\" : {\r\n \"name\" : \"1 2\", \r\n \"address\" : {\r\n \"countryCode\" : \"DK\", \r\n \"country\" : \"Denmark\", \r\n \"address1\" : \"1\", \r\n \"address2\" : \"1\", \r\n \"city\" : \"11\", \r\n \"postalCode\" : 2000\r\n }, \r\n \"slug\" : \"1-2-frederiksberg\", \r\n \"email\" : \"neo@resos.com\", \r\n \"phone\" : \"+4500000000\", \r\n \"languageCode\" : \"en\"\r\n }, \r\n \"duration\" : 120, \r\n \"endDateTime\" : \"2021-02-25T12:45:00.000+0000\", \r\n \"tables\" : [\r\n {\r\n \"_id\" : \"spekLuDbQY6X3ZnS8\", \r\n \"name\" : \"bord 2\", \r\n \"seatsMin\" : 1, \r\n \"seatsMax\" : 5, \r\n \"area\" : {\r\n \"_id\" : \"gEwNJnuubXprz2i3B\", \r\n \"name\" : \"d\", \r\n \"internalNote\" : \"\", \r\n \"bookingPriority\" : 5\r\n }\r\n }\r\n ]\r\n }\r\n]"}],"_postman_id":"f81edf74-f406-46cf-9a75-646fab0e30ff"},{"name":"Get booking","id":"0d5405ff-86b6-4156-905a-53f426cf2e02","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.resos.com/v1/bookings/{id}","auth":{"type":"basic","basic":{"username":"Supports both passing tables by an array of IDs, and an area ID. If no available tables are found with the specified area, an error will be returned.
\nYou can also specify which opening hour the booking should belong to. If not specified, our system will automatically add it. In case of overlapping opening hours, it will attempt to find the best fitting one.
\nPlease note if you are adding bookings with the DateTime field, it must be in UTC format. If adding as separate date and time fields, these must be in the restaurants' local timezone.
\nSupports the waitlist feature, if enabled for the restaurant.
To use, set the status field in the booking object to waitlist. All other fields function as normal.
Supports the custom fields feature, if enabled for the restaurant.
\nTo use, check the \"Create booking with custom fields\" example and the Custom Fields endpoint documentation
\n","auth":{"type":"basic","basic":{"username":"Updates a booking.
\nReturns true / false depending on if the update operation was a success.
When updating specific field(s), you only need to pass in the changed fields. E.g. a body of only:
\n{ \n \"people\": 3, \n \"date\": \"2024-06-10\" \n}\n\nis valid.
\nFields you can update via the API:
\n'date',
'time',
'dateTime',
'people',
'tables',
'duration',
'status',
'metadata',
'source',
'referrer',
'languageCode',
'openingHourId',
'canceledAt',
'deletedAt',
'declinedAt',
'openingHourName',
'customer',
'guest',
'customFields',
Please note that date and time should be passed in the local timezone (the restaurants' timezone), while dateTime should be passed as UTC. If passing date and/or time, a UTC dateTime will automatically be generated, while if passing dateTime a local-timezone date and time will automatically be generated.
Not recommended to pass both dateTime and date / time.
Add a note to an existing booking. A note is only visible to the restaurant and not the customer.
\n","auth":{"type":"basic","basic":{"username":"Add a comment to an existing booking. Comments are visible for both the restaurant and the customer.
\n","auth":{"type":"basic","basic":{"username":"Creating and updating bookins support the waitlist feature, if enabled under apps. To use when creating a booking, simply set the the status field to waitlist. Likewise, for updating bookings, the status can be set accordingly, both to and from waitlist.
To update a waitlist booking to an approved one, the status should be updated to approved.
Returns an array of available dates in the provided date-range. Only takes in account if an opening hour exists, day is not closed etc., - not if the day is fully booked.
\n","auth":{"type":"basic","basic":{"username":"Date in YYYY-MM-DD format. Start date of returned available dates (inclusive)
\n","type":"text/plain"},"key":"fromDate","value":null},{"disabled":true,"description":{"content":"Date in YYYY-MM-DD format. End date of returned available dates (inclusive)
\n","type":"text/plain"},"key":"toDate","value":null}],"variable":[]}},"response":[{"id":"1d17c96f-1f1f-4072-a2ad-531049fe9a37","name":"Get available dates","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.resos.com/v1/bookingFlow/dates?fromDate=2022-11-12&toDate=2022-11-20","protocol":"https","host":["api","resos","com"],"path":["v1","bookingFlow","dates"],"query":[{"key":"fromDate","value":"2022-11-12","description":"Date in YYYY-MM-DD format. Start date of returned available dates (inclusive)"},{"key":"toDate","value":"2022-11-20","description":"Date in YYYY-MM-DD format. End date of returned available dates (inclusive)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n \"2022-11-12\",\n \"2022-11-13\",\n \"2022-11-14\",\n \"2022-11-15\",\n \"2022-11-16\",\n \"2022-11-17\",\n \"2022-11-18\",\n \"2022-11-19\"\n]"}],"_postman_id":"3d30dc9e-2e4a-4939-b6fa-a9a932fd4f08"},{"name":"Available times at date","id":"da7b1ff8-3df0-4fa5-b6a6-dfb14bd18eec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.resos.com/v1/bookingFlow/times","description":"Returns an array of opening hour objects, each with an array inside of available times. These are bookable time intervals.
\nIf activated, available waitlist times are included as well as custom fields for the specific opening hour.
\n","auth":{"type":"basic","basic":{"username":"Party size to check for
\n","type":"text/plain"},"key":"people","value":""},{"disabled":true,"description":{"content":"Specified date, in YYYY-MM-DD format.
\n","type":"text/plain"},"key":"date","value":""},{"disabled":true,"description":{"content":"(optional) Specific area ID to check in
\n","type":"text/plain"},"key":"areaId","value":""},{"disabled":true,"description":{"content":"(optional) If true, only return times which are bookable online. If false, return all. Default: true
\n","type":"text/plain"},"key":"onlyBookableOnline","value":null}],"variable":[]}},"response":[{"id":"2b818fda-9b56-41d0-b896-fb24057ef3d9","name":"Get available times at date","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.resos.com/v1/bookingFlow/times?date=2022-11-20&people=3","protocol":"https","host":["api","resos","com"],"path":["v1","bookingFlow","times"],"query":[{"key":"date","value":"2022-11-20"},{"key":"people","value":"3"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"_id\": \"GTbgqpfADEW34HnJj\",\n \"name\": \"\",\n \"note\": \"\",\n \"payment\": {\n \"active\": false\n },\n \"availableTimes\": [\n \"10:00\",\n \"10:15\",\n \"10:30\",\n \"10:45\",\n \"11:00\"\n ],\n \"unavailableTimes\": [],\n \"waitlistTimes\": [],\n \"useWaitlist\": true,\n \"activeCustomFields\": [\n {\n \"_id\": \"A9AL6pgqN2pS7H3oQ\",\n \"name\": \"Text\",\n \"type\": \"string\",\n \"isRequired\": false,\n \"defaultOnAllOpeningHours\": true,\n \"showAsBadge\": true,\n \"restaurantId\": \"MuxTyr9eco87Tkwut\",\n \"createdAt\": \"2022-10-17T11:45:19.950Z\",\n \"activeFlows\": [\n \"booking\"\n ],\n \"createdBy\": \"33P5EPKycx5tTkTLz\",\n \"badgeColor\": \"red\",\n \"label\": \"Text label\",\n \"helptext\": \"Text helptext\",\n \"sortIndex\": 0,\n \"updatedAt\": \"2022-11-02T11:14:51.797Z\",\n \"updatedBy\": \"33P5EPKycx5tTkTLz\"\n }\n ]\n },\n {\n \"_id\": \"bFaFADoBjii8rahc3\",\n \"name\": \"\",\n \"note\": \"\",\n \"payment\": {\n \"active\": false\n },\n \"availableTimes\": [\n \"20:00\",\n \"20:15\",\n \"20:30\",\n \"20:45\",\n \"21:00\",\n \"21:15\",\n \"21:30\",\n \"21:45\",\n \"22:00\",\n \"22:15\",\n \"22:30\",\n \"22:45\",\n \"23:00\"\n ],\n \"unavailableTimes\": [],\n \"waitlistTimes\": [],\n \"useWaitlist\": true,\n \"activeCustomFields\": [\n {\n \"_id\": \"pWpbQst7rdHw4BYd5\",\n \"name\": \"Radio\",\n \"type\": \"radio\",\n \"isRequired\": false,\n \"defaultOnAllOpeningHours\": true,\n \"showAsBadge\": true,\n \"restaurantId\": \"MuxTyr9eco87Tkwut\",\n \"createdAt\": \"2022-10-17T11:46:35.166Z\",\n \"activeFlows\": [\n \"booking\"\n ],\n \"createdBy\": \"33P5EPKycx5tTkTLz\",\n \"badgeColor\": \"turquoise\",\n \"label\": \"Radio label\",\n \"helptext\": \"Radio helptext\",\n \"multipleChoiceSelections\": [\n {\n \"_id\": \"aauPgKhJxG6GCCEQK\",\n \"name\": \"Option 1\"\n },\n {\n \"_id\": \"qsFxnX3t75iaYNo2s\",\n \"name\": \"Option 2\"\n },\n {\n \"_id\": \"efkcxMnKNcWSXwuQo\",\n \"name\": \"Option 3\"\n }\n ],\n \"sortIndex\": 2,\n \"updatedAt\": \"2022-11-02T11:14:57.691Z\",\n \"updatedBy\": \"33P5EPKycx5tTkTLz\"\n }\n ]\n }\n]"}],"_postman_id":"da7b1ff8-3df0-4fa5-b6a6-dfb14bd18eec"},{"name":"Available tables at time","id":"931b3f71-46c4-4c48-a46e-ac50720ff974","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.resos.com/v1/bookingFlow/availableTables","description":"Returns an array of tables that are available in a given timeframe, for a specific party size.
\n","auth":{"type":"basic","basic":{"username":"Party size to check for
\n","type":"text/plain"},"key":"people","value":""},{"disabled":true,"description":{"content":"Specificed start dateTime, in YYYY-MM-DDTHH:mm:ss format
\n","type":"text/plain"},"key":"fromDateTime","value":""},{"disabled":true,"description":{"content":"Specificed end dateTime, in YYYY-MM-DDTHH:mm:ss format
\n","type":"text/plain"},"key":"toDateTime","value":""},{"disabled":true,"description":{"content":"(Optional) Only return tables which are bookable online
\n","type":"text/plain"},"key":"onlyBookableOnline","value":""},{"disabled":true,"description":{"content":"(Optional) Return all tables, even if they are not available
\n","type":"text/plain"},"key":"returnAllTables","value":""},{"disabled":true,"description":{"content":"(Optional) Specific area ID to check in
\n","type":"text/plain"},"key":"areaId","value":""},{"disabled":true,"description":{"content":"(Optional) Exclude a specific booking when determining availability
\n","type":"text/plain"},"key":"excludeBookingId","value":""}],"variable":[]}},"response":[{"id":"4fb0ac78-0c20-4397-a3ae-ccba87d6a268","name":"Get available tables at time","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.resos.com/v1/bookingFlow/availableTables?people=2&fromDateTime=2025-05-12T08:00:00.000Z&toDateTime=2025-05-12T18:00:00.000Z&onlyBookableOnline=false&returnAllTables=true&areaId=so2fPrmjJZML6mSP8","protocol":"https","host":["api","resos","com"],"path":["v1","bookingFlow","availableTables"],"query":[{"key":"people","value":"2"},{"key":"fromDateTime","value":"2025-05-12T08:00:00.000Z"},{"key":"toDateTime","value":"2025-05-12T18:00:00.000Z"},{"key":"onlyBookableOnline","value":"false"},{"key":"returnAllTables","value":"true"},{"key":"areaId","value":"so2fPrmjJZML6mSP8"},{"key":"excludeBookingId","value":"","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"_id\": \"be69DFLSSBk9ji466\",\n \"name\": \"101\",\n \"seatsMin\": 1,\n \"seatsMax\": 2,\n \"bookable\": true,\n \"bookableOnline\": true,\n \"bookingPriority\": 5,\n \"createdBy\": \"33P5EPKycx5tTkTLz\",\n \"createdAt\": \"2025-05-05T06:40:58.893Z\",\n \"type\": \"single\",\n \"area\": {\n \"_id\": \"so2fPrmjJZML6mSP8\",\n \"name\": \"Restaurant\",\n \"bookingPriority\": 5\n },\n \"booked\": false\n },\n {\n \"_id\": \"3xoCMWoR7CPB4B5r7\",\n \"name\": \"102\",\n \"seatsMin\": 1,\n \"seatsMax\": 2,\n \"bookable\": true,\n \"bookableOnline\": true,\n \"bookingPriority\": 5,\n \"createdBy\": \"33P5EPKycx5tTkTLz\",\n \"createdAt\": \"2025-05-05T06:40:58.899Z\",\n \"type\": \"single\",\n \"area\": {\n \"_id\": \"so2fPrmjJZML6mSP8\",\n \"name\": \"Restaurant\",\n \"bookingPriority\": 5\n },\n \"booked\": false\n },\n {\n \"_id\": \"iKYGXFcy2q3Rj4WWK\",\n \"name\": \"103\",\n \"seatsMin\": 1,\n \"seatsMax\": 2,\n \"bookable\": true,\n \"bookableOnline\": true,\n \"bookingPriority\": 5,\n \"createdBy\": \"33P5EPKycx5tTkTLz\",\n \"createdAt\": \"2025-05-05T06:40:58.906Z\",\n \"type\": \"single\",\n \"area\": {\n \"_id\": \"so2fPrmjJZML6mSP8\",\n \"name\": \"Restaurant\",\n \"bookingPriority\": 5\n },\n \"booked\": false\n },\n {\n \"_id\": \"iwHNXScELGaWbdC9Q\",\n \"name\": \"104\",\n \"seatsMin\": 1,\n \"seatsMax\": 2,\n \"bookable\": true,\n \"bookableOnline\": true,\n \"bookingPriority\": 5,\n \"createdBy\": \"33P5EPKycx5tTkTLz\",\n \"createdAt\": \"2025-05-05T06:40:58.912Z\",\n \"type\": \"single\",\n \"area\": {\n \"_id\": \"so2fPrmjJZML6mSP8\",\n \"name\": \"Restaurant\",\n \"bookingPriority\": 5\n },\n \"booked\": false\n },\n {\n \"_id\": \"WXQtfGRSTx3Xk9Hww\",\n \"name\": \"105\",\n \"seatsMin\": 1,\n \"seatsMax\": 2,\n \"bookable\": true,\n \"bookableOnline\": true,\n \"bookingPriority\": 5,\n \"createdBy\": \"33P5EPKycx5tTkTLz\",\n \"createdAt\": \"2025-05-05T06:40:58.917Z\",\n \"type\": \"single\",\n \"area\": {\n \"_id\": \"so2fPrmjJZML6mSP8\",\n \"name\": \"Restaurant\",\n \"bookingPriority\": 5\n },\n \"booked\": false\n }\n]"}],"_postman_id":"931b3f71-46c4-4c48-a46e-ac50720ff974"}],"id":"4156bc4d-3f5b-4b19-92a0-d05b1abdd7e2","description":"Related to the booking flow itself, e.g. times available for online booking on a given date.
\n","_postman_id":"4156bc4d-3f5b-4b19-92a0-d05b1abdd7e2","auth":{"type":"basic","basic":{"username":"Each document represents an area. Each area can have multiple tables and table combinations.
\n","event":[{"listen":"prerequest","script":{"id":"1c2f8eea-2940-4490-9cf2-da69236ab982","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"56615df0-b96f-4f09-bee9-1efab5a7e6f9","type":"text/javascript","exec":[""]}}],"_postman_id":"16bb4165-ec0b-4b42-bc5e-46af4b5f13f4","auth":{"type":"basic","basic":{"username":"True/false. If true, also include deleted opening hours in response
\n","type":"text/plain"},"key":"showDeleted","value":""},{"disabled":true,"description":{"content":"True/false. If true, only include special opening hours in response
\n","type":"text/plain"},"key":"onlySpecial","value":""},{"disabled":true,"description":{"content":"restaurant / takeaway. Specify which type of opening hours to return. Defaults to restaurant.
\n","type":"text/plain"},"key":"type","value":"restaurant"}],"variable":[]}},"response":[{"id":"ed5b4ab7-b174-4334-ac9f-93eee8618718","name":"List opening hours","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.resos.com/v1/openingHours?showDeleted=false&onlySpecial=false&type=restaurant","protocol":"https","host":["api","resos","com"],"path":["v1","openingHours"],"query":[{"key":"showDeleted","value":"false","description":"True/false. If true, also include deleted opening hours in response"},{"key":"onlySpecial","value":"false","description":"True/false. If true, only include special opening hours in response"},{"key":"type","value":"restaurant","description":"restaurant / takeaway. Specify which type of opening hours to return. Defaults to restaurant."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"_id\": \"zafbQPmxiW7iiyRZM\",\n \"mode\": \"restaurant\",\n \"special\": false,\n \"name\": \"\",\n \"maxBookings\": 0,\n \"maxGuests\": 0,\n \"maxBookingsInterval\": 0,\n \"maxGuestsInterval\": 0,\n \"note\": \"\",\n \"onlyCountOnlineBookings\": false,\n \"areas\": [],\n \"useDurationByPeople\": false,\n \"durationByPeople\": [],\n \"seating\": {\n \"active\": false,\n \"interval\": 15,\n \"duration\": 120\n },\n \"day\": 1,\n \"open\": 1200,\n \"close\": 1645,\n \"open_sec\": 43200,\n \"close_sec\": 60300,\n \"restaurantId\": \"SFdvxW2eDixsLX5M6\",\n \"createdBy\": \"qaRxqAK38rGcMDHea\",\n \"createdAt\": \"2022-01-11T09:22:56.106Z\",\n \"endDate\": \"\",\n \"payment\": {\n \"active\": false\n },\n \"updatedAt\": \"2022-05-19T08:44:02.915Z\",\n \"updatedBy\": \"qaRxqAK38rGcMDHea\",\n \"changeLog\": [\n {\n \"createdAt\": \"2022-05-19T08:43:27.322Z\",\n \"userName\": \"Christoffer's test restaurant\",\n \"changes\": [\n {\n \"key\": \"open\",\n \"from\": 1000,\n \"to\": 1200\n },\n {\n \"key\": \"close\",\n \"from\": 2200,\n \"to\": 1545\n },\n {\n \"key\": \"open_sec\",\n \"from\": 36000,\n \"to\": 43200\n },\n {\n \"key\": \"close_sec\",\n \"from\": 79200,\n \"to\": 55979\n }\n ]\n },\n {\n \"createdAt\": \"2022-05-19T08:44:03.006Z\",\n \"createdBy\": \"qaRxqAK38rGcMDHea\",\n \"userName\": \"Christoffer's test restaurant\",\n \"changes\": [\n {\n \"key\": \"close\",\n \"from\": 1545,\n \"to\": 1645\n },\n {\n \"key\": \"close_sec\",\n \"from\": 55979,\n \"to\": 60300\n }\n ]\n }\n ]\n },\n {\n \"_id\": \"PQMG8BWNKeJGCdusJ\",\n \"mode\": \"restaurant\",\n \"special\": false,\n \"name\": \"\",\n \"maxBookings\": 0,\n \"maxGuests\": 0,\n \"maxBookingsInterval\": 0,\n \"maxGuestsInterval\": 0,\n \"note\": \"\",\n \"onlyCountOnlineBookings\": false,\n \"areas\": [],\n \"useDurationByPeople\": false,\n \"durationByPeople\": [],\n \"seating\": {\n \"active\": false,\n \"interval\": 15,\n \"duration\": 120\n },\n \"day\": 2,\n \"open\": 1000,\n \"close\": 2200,\n \"open_sec\": 36000,\n \"close_sec\": 79200,\n \"restaurantId\": \"SFdvxW2eDixsLX5M6\",\n \"createdBy\": \"qaRxqAK38rGcMDHea\",\n \"createdAt\": \"2022-01-11T09:22:57.521Z\"\n },\n {\n \"_id\": \"yuyFTy6haM5ddNtmv\",\n \"mode\": \"restaurant\",\n \"special\": false,\n \"name\": \"\",\n \"maxBookings\": 0,\n \"maxGuests\": 0,\n \"maxBookingsInterval\": 0,\n \"maxGuestsInterval\": 0,\n \"note\": \"\",\n \"onlyCountOnlineBookings\": false,\n \"areas\": [],\n \"useDurationByPeople\": false,\n \"durationByPeople\": [],\n \"seating\": {\n \"active\": false,\n \"interval\": 15,\n \"duration\": 120\n },\n \"day\": 3,\n \"open\": 1000,\n \"close\": 2200,\n \"open_sec\": 36000,\n \"close_sec\": 79200,\n \"restaurantId\": \"SFdvxW2eDixsLX5M6\",\n \"createdBy\": \"qaRxqAK38rGcMDHea\",\n \"createdAt\": \"2022-01-11T09:22:58.032Z\"\n },\n {\n \"_id\": \"EsYQgGgKY5uouF5FW\",\n \"mode\": \"restaurant\",\n \"special\": false,\n \"name\": \"\",\n \"maxBookings\": 0,\n \"maxGuests\": 0,\n \"maxBookingsInterval\": 0,\n \"maxGuestsInterval\": 0,\n \"note\": \"\",\n \"onlyCountOnlineBookings\": false,\n \"areas\": [],\n \"useDurationByPeople\": false,\n \"durationByPeople\": [],\n \"seating\": {\n \"active\": false,\n \"interval\": 15,\n \"duration\": 120\n },\n \"day\": 4,\n \"open\": 1000,\n \"close\": 2200,\n \"open_sec\": 36000,\n \"close_sec\": 79200,\n \"restaurantId\": \"SFdvxW2eDixsLX5M6\",\n \"createdBy\": \"qaRxqAK38rGcMDHea\",\n \"createdAt\": \"2022-01-11T09:22:58.540Z\"\n },\n {\n \"_id\": \"AS3sumv6xHHuKwBkn\",\n \"mode\": \"restaurant\",\n \"special\": false,\n \"name\": \"\",\n \"maxBookings\": 0,\n \"maxGuests\": 0,\n \"maxBookingsInterval\": 0,\n \"maxGuestsInterval\": 0,\n \"note\": \"\",\n \"onlyCountOnlineBookings\": false,\n \"areas\": [],\n \"useDurationByPeople\": false,\n \"durationByPeople\": [],\n \"seating\": {\n \"active\": false,\n \"interval\": 15,\n \"duration\": 120\n },\n \"day\": 5,\n \"open\": 1000,\n \"close\": 2200,\n \"open_sec\": 36000,\n \"close_sec\": 79200,\n \"restaurantId\": \"SFdvxW2eDixsLX5M6\",\n \"createdBy\": \"qaRxqAK38rGcMDHea\",\n \"createdAt\": \"2022-01-11T09:22:59.057Z\"\n },\n {\n \"_id\": \"LWY3wTWFx6nxwi4en\",\n \"mode\": \"restaurant\",\n \"special\": false,\n \"name\": \"\",\n \"maxBookings\": 0,\n \"maxGuests\": 0,\n \"maxBookingsInterval\": 0,\n \"maxGuestsInterval\": 0,\n \"note\": \"\",\n \"onlyCountOnlineBookings\": false,\n \"areas\": [],\n \"useDurationByPeople\": false,\n \"durationByPeople\": [],\n \"seating\": {\n \"active\": false,\n \"interval\": 15,\n \"duration\": 120\n },\n \"day\": 6,\n \"open\": 1000,\n \"close\": 2200,\n \"open_sec\": 36000,\n \"close_sec\": 79200,\n \"restaurantId\": \"SFdvxW2eDixsLX5M6\",\n \"createdBy\": \"qaRxqAK38rGcMDHea\",\n \"createdAt\": \"2022-01-11T09:23:00.867Z\"\n },\n {\n \"_id\": \"89E39LPb9q2e8xTEE\",\n \"mode\": \"restaurant\",\n \"special\": false,\n \"name\": \"\",\n \"maxBookings\": 0,\n \"maxGuests\": 0,\n \"maxBookingsInterval\": 0,\n \"maxGuestsInterval\": 0,\n \"note\": \"\",\n \"onlyCountOnlineBookings\": false,\n \"areas\": [],\n \"useDurationByPeople\": false,\n \"durationByPeople\": [],\n \"seating\": {\n \"active\": false,\n \"interval\": 15,\n \"duration\": 120\n },\n \"day\": 7,\n \"open\": 1000,\n \"close\": 2200,\n \"open_sec\": 36000,\n \"close_sec\": 79200,\n \"restaurantId\": \"SFdvxW2eDixsLX5M6\",\n \"createdBy\": \"qaRxqAK38rGcMDHea\",\n \"createdAt\": \"2022-01-11T09:23:01.864Z\"\n }\n]"}],"_postman_id":"06760c75-bc61-4d40-a83a-c57c085300ea"},{"name":"Get by id","event":[{"listen":"test","script":{"id":"52c06eb6-f4aa-44cb-87d7-ad03c0d0041f","exec":["pm.test(\"Status code is 200 and rate-limit header included\", function () {\r"," pm.response.to.have.status(200),\r"," pm.response.to.have.header('retry-after');\r","});\r","\r","pm.test(\"Body data validation\", function () {\r"," var jsonData = pm.response.json();\r"," pm.expect(jsonData[0]._id).to.exist;\r"," pm.expect(jsonData[0].people).to.exist;\r"," pm.expect(typeof jsonData).to.eql('object')\r"," pm.expect(jsonData[0].guest).to.exist;\r","});\r",""],"type":"text/javascript"}}],"id":"f479b589-2448-42c5-aeb9-208427eea410","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.resos.com/v1/openingHours/{id}","auth":{"type":"basic","basic":{"username":"See \"Pagination\" documentation
\n","type":"text/plain"},"key":"limit","value":"10"},{"description":{"content":"See \"Pagination\" documentation
\n","type":"text/plain"},"key":"skip","value":"1"},{"description":{"content":"Sort results by field. 1 ascending, -1 descending
\n","type":"text/plain"},"key":"sort","value":"createdAt:1"},{"description":{"content":"See \"Search expression\" documentation
\n","type":"text/plain"},"key":"customQuery","value":"type:booking"},{"description":{"content":"Return only submitted feedback, i.e. after the user has been to the feedback link and clicked submit.
\n","type":"text/plain"},"key":"onlySubmitted","value":"true/false"}],"variable":[]}},"response":[{"id":"74078747-21ac-45e5-acc4-b311fbba3534","name":"List feedback","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.resos.com/v1/guestFeedback?limit=10&skip=1&sort=createdAt:1&customQuery=type:booking","protocol":"https","host":["api","resos","com"],"path":["v1","guestFeedback"],"query":[{"key":"limit","value":"10"},{"key":"skip","value":"1"},{"key":"sort","value":"createdAt:1"},{"key":"customQuery","value":"type:booking"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"retry-after","value":"60","description":"","type":"text"},{"key":"x-ratelimit-limit","value":"100","description":"","type":"text"},{"key":"x-ratelimit-remaining","value":"99","description":"","type":"text"},{"key":"x-ratelimit-reset","value":"Mon May 31 2021 14:36:25 GMT+0200 (Central European Summer Time)","description":"","type":"text"},{"key":"access-control-allow-headers","value":"Authorization,Content-Type","description":"","type":"text"},{"key":"content-type","value":"application/json","description":"","type":"text"},{"key":"vary","value":"Accept-Encoding","description":"","type":"text"},{"key":"content-encoding","value":"gzip","description":"","type":"text"},{"key":"date","value":"Mon, 31 May 2021 12:35:25 GMT","description":"","type":"text"},{"key":"connection","value":"keep-alive","description":"","type":"text"},{"key":"transfer-encoding","value":"chunked","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\r\n { \r\n \"_id\" : \"Die4HLN512Aw4kE7E7G\", \r\n \"restaurantId\" : \"T4ehrSt4126YFbY47Kcd\", \r\n \"recommended\" : true, \r\n \"booking\" : {\r\n \"_id\" : \"6xBk5J9eH3TaTCQkf\", \r\n \"people\" : 3, \r\n \"dateTime\" : \"2021-08-27T12:15:00.000+0000\", \r\n \"endDateTime\" : \"2021-08-27T14:15:00.000+0000\", \r\n \"guest\" : {\r\n \"name\" : \"Neo\", \r\n \"email\" : \"neo@matrix.com\", \r\n \"phone\" : \"+454564123320565954\", \r\n \"notificationEmail\" : true, \r\n \"notificationSms\" : false\r\n }, \r\n \"tables\" : [\r\n {\r\n \"_id\" : \"wDiuFQP83412mjcyBh9S\", \r\n \"name\" : \"100\", \r\n \"seatsMin\" : 2, \r\n \"seatsMax\" : 4, \r\n \"area\" : {\r\n \"_id\" : \"QQopHk3DApn123KCxttp\", \r\n \"name\" : \"Inside\", \r\n \"internalNote\" : \"\", \r\n \"bookingPriority\" : 5\r\n }\r\n }\r\n ], \r\n \"status\" : \"approved\", \r\n \"source\" : \"website\", \r\n \"createdAt\" : \"2021-08-24T07:04:57.599+0000\"\r\n }, \r\n \"createdAt\" : \"2021-08-24T07:09:41.487+0000\", \r\n \"type\" : \"booking\", \r\n \"customerId\" : \"E9h8f2z74123CKeNxsPeW\", \r\n \"atmosphere\" : 4, \r\n \"food\" : 5, \r\n \"message\" : \"Awesome\", \r\n \"service\" : 5, \r\n \"submitted\" : true, \r\n \"value\" : 3\r\n },\r\n { \r\n \"_id\" : \"Die4HLN512Aw4kE7E7G\", \r\n \"restaurantId\" : \"T4ehrSt4126YFbY47Kcd\", \r\n \"recommended\" : true, \r\n \"booking\" : {\r\n \"_id\" : \"6xBk5J9eH3TaTCQkf\", \r\n \"people\" : 3, \r\n \"dateTime\" : \"2021-08-27T12:15:00.000+0000\", \r\n \"endDateTime\" : \"2021-08-27T14:15:00.000+0000\", \r\n \"guest\" : {\r\n \"name\" : \"Neo\", \r\n \"email\" : \"neo@matrix.com\", \r\n \"phone\" : \"+454564123320565954\", \r\n \"notificationEmail\" : true, \r\n \"notificationSms\" : false\r\n }, \r\n \"tables\" : [\r\n {\r\n \"_id\" : \"wDiuFQP83412mjcyBh9S\", \r\n \"name\" : \"100\", \r\n \"seatsMin\" : 2, \r\n \"seatsMax\" : 4, \r\n \"area\" : {\r\n \"_id\" : \"QQopHk3DApn123KCxttp\", \r\n \"name\" : \"Inside\", \r\n \"internalNote\" : \"\", \r\n \"bookingPriority\" : 5\r\n }\r\n }\r\n ], \r\n \"status\" : \"approved\", \r\n \"source\" : \"website\", \r\n \"createdAt\" : \"2021-08-24T07:04:57.599+0000\"\r\n }, \r\n \"createdAt\" : \"2021-08-24T07:09:41.487+0000\", \r\n \"type\" : \"booking\", \r\n \"customerId\" : \"E9h8f2z74123CKeNxsPeW\", \r\n \"atmosphere\" : 1, \r\n \"food\" : 2, \r\n \"message\" : \"Not good!\", \r\n \"service\" : 5, \r\n \"submitted\" : true, \r\n \"value\" : 5\r\n }\r\n]"}],"_postman_id":"4006d757-abc3-460d-a5ef-8e58db718178"},{"name":"Get feedback","id":"c764fe2c-3704-47dc-b9b2-e14ef097724f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.resos.com/v1/guestFeedback/{id}","auth":{"type":"basic","basic":{"username":"See \"Pagination\" documentation
\n","type":"text/plain"},"key":"limit","value":"10"},{"description":{"content":"See \"Pagination\" documentation
\n","type":"text/plain"},"key":"skip","value":"1"},{"description":{"content":"See \"Search expression\" documentation
\n","type":"text/plain"},"key":"customQuery","value":"name;Neo"}],"variable":[]}},"response":[{"id":"661a34a9-a23f-4c19-9758-5121c3270852","name":"List customers","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.resos.com/v1/customers?limit=10&skip=1&customQuery=name;Neo","protocol":"https","host":["api","resos","com"],"path":["v1","customers"],"query":[{"key":"limit","value":"10"},{"key":"skip","value":"1"},{"key":"customQuery","value":"name;Neo"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"retry-after","value":"60","description":"","type":"text"},{"key":"x-ratelimit-limit","value":"100","description":"","type":"text"},{"key":"x-ratelimit-remaining","value":"99","description":"","type":"text"},{"key":"x-ratelimit-reset","value":"Mon May 31 2021 14:36:25 GMT+0200 (Central European Summer Time)","description":"","type":"text"},{"key":"access-control-allow-headers","value":"Authorization,Content-Type","description":"","type":"text"},{"key":"content-type","value":"application/json","description":"","type":"text"},{"key":"vary","value":"Accept-Encoding","description":"","type":"text"},{"key":"content-encoding","value":"gzip","description":"","type":"text"},{"key":"date","value":"Mon, 31 May 2021 12:35:25 GMT","description":"","type":"text"},{"key":"connection","value":"keep-alive","description":"","type":"text"},{"key":"transfer-encoding","value":"chunked","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\r\n { \r\n \"_id\" : \"b141131616-e418c1-41a0e-b230ac-04a42d064b24c\", \r\n \"restaurantId\" : \"PT4Mphga312zdoTwH6eJ\", \r\n \"name\" : \"Neo Matrix\", \r\n \"emails\" : [\r\n \"neo@matrix.com\"\r\n ]\r\n },\r\n { \r\n \"_id\" : \"b141211616-e84c1-4a01e-b0ac-0a2342d064b24c\", \r\n \"restaurantId\" : \"PT4Mphga312zdoTwH6eJ\", \r\n \"name\" : \"Matrix Neo\", \r\n \"emails\" : [\r\n \"neo@matrix.com\"\r\n ]\r\n }\r\n]"}],"_postman_id":"6951b541-6e67-49af-88e6-0bd77b45cda6"},{"name":"Get customer","id":"26118f8e-8c60-4565-9adb-30e002b37d92","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.resos.com/v1/customers/{id}","auth":{"type":"basic","basic":{"username":"Fetch all custom fields
\n","auth":{"type":"basic","basic":{"username":"Get a single custom field
\n","auth":{"type":"basic","basic":{"username":"A collection of endpoints for working with the feature Custom Fields.
\nTo use when creating bookings, an array field called customFields should be passed in the root of the body. This array should contain objects with each active custom field to be set on the booking.
Properties for text and number fields
\nFor the single-value fields, text and number, the custom field object should contain 4 properties:
\n_id - corresponds to the custom field ID which can be fetched with the list endpoint
name - corresponds to the name of the custom field
label - corresponds to the label of the custom field
value - the specific value for the field. Any arbitrary text for the text custom field, and any arbitrary numeric value for the number field
Properties for the single-choice radio and dropdown fields
\nFor the single-choice fields, radio and dropdown, the custom field object should contain 5 properties:
\n_id - corresponds to the custom field ID which can be fetched with the list endpoint
name - corresponds to the name of the custom field
label - corresponds to the label of the custom field
value - the ID of the value (not the custom field) chosen
multipleChoiceValueName - corresponds to the name of the specific value chosen
Properties for the multiple choice field
\nFor the multiple choice checkbox custom field, the custom field object should contain 4 properties:
\n_id - corresponds to the custom field ID which can be fetched with the list endpoint
name - corresponds to the name of the custom field
label - corresponds to the label of the custom field
value - an array of objects. Each object is a choice checked.
These objects should contain 3 properties -
\n_id - the ID of the choice (not the custom field)
name - the name of the choice
value - true / false
For an example, check the \"Create booking with custom fields\" example.
\n","_postman_id":"c08b5ef8-0b4c-4cee-a8e6-0817cbea1f45","auth":{"type":"basic","basic":{"username":"Verify your API key and connection by sending a request to this endpoint.
\nReturns an authentication error if missing or invalid API key is included.
\n","auth":{"type":"basic","basic":{"username":"