Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

TheFork Reservations API

Create, retrieve, and update reservations.

TheFork Reservations API is one of 4 APIs that TheFork publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 6 JSON Schema definitions.

Tagged areas include Reservations. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, a JSON-LD context, and 6 JSON Schemas.

This API exposes 3 operations across 2 paths, and defines 8 schemas. It is described by OpenAPI 3.0.3, at version v1.

Requests are made against a single base URL, https://api.thefork.io/manager/v1.

3 operations 2 paths 8 schemas 1 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
v1
Base URL
https://api.thefork.io
Authentication
OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 1

TheFork Reservations API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2ClientCredentials) using the clientCredentials flow. By default, every request must be authenticated.

  • OAuth2ClientCredentials — Auth0 OAuth 2.0 client credentials flow. Exchange clientid and clientsecret for a bearer token at https://auth.thefork.io/oauth/token with audience https://api…

Paths & Operations 3

Across 2 paths, the API surfaces 3 operations — 1 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Reservations 3

Create, retrieve, and update reservations.

POST
/restaurants/{id}/reservations
Create Reservation
createReservation 1 param body → 200401404409429
GET
/reservations/{id}
Get Reservation
getReservation 1 param → 200401404
PATCH
/reservations/{id}
Update Reservation
updateReservation 1 param body → 200401404409

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are Reservation (9 properties), Customer (8 properties), ReservationCreateRequest (6 properties), CustomerInput (4 properties). Each schema is shown below with its type and property counts.

Offer
object
4 properties
ReservationStatus
string
Lifecycle status of a reservation.
ReservationCreateRequest
object
6 properties 3 required
Customer
object
8 properties
Reservation
object
9 properties
ReservationUpdateRequest
object
Fields that can be changed on an existing reservation.
2 properties
CustomerInput
object
4 properties 2 required
Error
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

thefork-reservations-api-openapi.yml Raw ↑

Other APIs TheFork publishes across the network.

TheFork Customers API
TheFork Orders API
TheFork Reviews API