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

The Collections API from ReqRes — 4 operation(s) for collections.

ReqRes Collections 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 Collections. 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 10 operations across 4 paths, and defines 11 schemas. 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.

10 operations 4 paths 11 schemas 2 DELETE4 GET2 POST2 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 Collections 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 10

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

Collections 10
GET
/api/collections
ReqRes List Collections
listCollections 1 param → 200401
POST
/api/collections
ReqRes Create Collection
createCollection 1 param body → 201400401
GET
/api/collections/{slug}
ReqRes Get Collection
getCollection 2 params → 200404
PUT
/api/collections/{slug}
ReqRes Update Collection
updateCollection 2 params body → 200400404
DELETE
/api/collections/{slug}
ReqRes Delete Collection
deleteCollection 2 params → 204404
GET
/api/collections/{slug}/records
ReqRes List Records
listCollectionRecords 10 params → 200400404
POST
/api/collections/{slug}/records
ReqRes Create Record
createCollectionRecord 2 params body → 201400404
GET
/api/collections/{slug}/records/{recordId}
ReqRes Get Record
getCollectionRecord 3 params → 200404
PUT
/api/collections/{slug}/records/{recordId}
ReqRes Update Record
updateCollectionRecord 3 params body → 200400404
DELETE
/api/collections/{slug}/records/{recordId}
ReqRes Delete Record
deleteCollectionRecord 3 params → 204404

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are CollectionRecord (9 properties), Collection (9 properties), CollectionCreateRequest (5 properties), CollectionUpdateRequest (4 properties). Each schema is shown below with its type and property counts.

CollectionListResponse
object
1 property 1 required
Collection
object
9 properties 3 required
CollectionRecordResponse
object
1 property 1 required
CollectionResponse
object
1 property 1 required
ErrorResponse
object
2 properties 1 required
CollectionCreateRequest
object
5 properties 1 required
CollectionRecordListResponse
object
2 properties 1 required
CollectionRecordCreateRequest
object
1 property 1 required
CollectionRecordUpdateRequest
object
1 property 1 required
CollectionUpdateRequest
object
4 properties
CollectionRecord
object
9 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

reqres-collections-api-openapi.yml Raw ↑

Other APIs ReqRes publishes across the network.

ReqRes Agent Sandbox API
ReqRes App Users API
ReqRes Authentication API
ReqRes Custom Endpoints API
ReqRes Legacy API