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 Customers API

Look up customer and guest profile data.

TheFork Customers 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 Customers. 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 2 operations across 2 paths, and defines 2 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.

2 operations 2 paths 2 schemas 2 GET

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 Customers 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 2

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

Customers 2

Look up customer and guest profile data.

GET
/restaurants/{id}/customers/phone/{phoneNumber}
Find Customer By Phone Number
findCustomerByPhone 2 params → 200401404
GET
/customers
List Customers
listCustomers → 200401

Schemas 2

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

Customer
object
8 properties
Error
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

thefork-customers-api-openapi.yml Raw ↑

Other APIs TheFork publishes across the network.

TheFork Orders API
TheFork Reservations API
TheFork Reviews API