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

ReqRes Custom Endpoints API

The Custom Endpoints API from ReqRes — 1 operation(s) for custom endpoints.

ReqRes Custom Endpoints API is one of 6 APIs that ReqRes publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 16 JSON Schema definitions.

Tagged areas include Custom Endpoints. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, pricing, an engineering blog, a JSON-LD context, and 16 JSON Schemas.

This API exposes 5 operations across 1 path, and defines 1 schema. It is described by OpenAPI 3.0.3, at version 2.1.0.

Requests are made against 2 base URLs: https://reqres.in, http://localhost:8000.

5 operations 1 paths 1 schemas 1 DELETE1 GET1 PATCH1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
2.1.0
Base URL
https://reqres.in/
Authentication
API Key, HTTP Bearer
License
Resource Areas
1

Authentication & Security 2

ReqRes Custom Endpoints API declares 2 security schemes for authenticating requests. An API key is passed in the header as x-api-key (ApiKeyAuth). It accepts HTTP bearer tokens (session_token) (BearerAuth).

Paths & Operations 5

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

Custom Endpoints 5
GET
/api/custom/{path}
ReqRes Execute Custom Endpoint
executeCustomEndpointGet 1 param → 200401404
POST
/api/custom/{path}
ReqRes Execute Custom Endpoint
executeCustomEndpointPost 1 param body → 200401
PUT
/api/custom/{path}
ReqRes Execute Custom Endpoint
executeCustomEndpointPut 1 param body → 200401
PATCH
/api/custom/{path}
ReqRes Execute Custom Endpoint
executeCustomEndpointPatch 1 param body → 200401
DELETE
/api/custom/{path}
ReqRes Execute Custom Endpoint
executeCustomEndpointDelete 1 param → 200401

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is ErrorResponse (2 properties). Each schema is shown below with its type and property counts.

ErrorResponse
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

reqres-custom-endpoints-api-openapi.yml Raw ↑

Other APIs ReqRes publishes across the network.

ReqRes Agent Sandbox API
ReqRes App Users API
ReqRes Authentication API
ReqRes Collections API
ReqRes Legacy API