How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

General Services Administration Documents API

The documents API from General Services Administration — 2 operation(s) for documents.

General Services Administration Documents API is one of 89 APIs that General Services Administration publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Documents. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 2 operations across 2 paths, and defines 18 schemas. It is described by OpenAPI 3.2.0, at version 4.0.

Requests are made against a single base URL, https://api.regulations.gov/v4.

2 operations 2 paths 18 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
4.0
Base URL
https://api.gsa.gov/acquisitiongateway/api/v4.0
Authentication
API Key
Resource Areas
1

Authentication & Security 1

General Services Administration Documents API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Api-Key (ApiKeyAuth). By default, every request must be authenticated.

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.

Documents 2
GET
/documents
List of documents
getDocuments 13 params → 200400403
GET
/documents/{documentId}
Get detailed information for specified documentId
getDocumentsByDocumentId 2 params → 200400403404

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are BasicDetailModel (39 properties), Document (14 properties), Attachment (10 properties), FindAllResponseMetadata (9 properties). Each schema is shown below with its type and property counts.

Attachment
object
10 properties
DocumentFindAllItem
object
A JSON:API document which represents a single document in the list
4 properties
DocumentFindAllResponse
object
A JSON:API document with a list of resources
2 properties
Relationship
object
A single relationship object
2 properties
FileFormat
object
3 properties
Error
object
3 properties
Link
string
A string containing the link URL.
Document
object
14 properties
AttachmentFindAllItem
object
A JSON:API document which represents a single document in the list
4 properties
RelationshipLinks
object
Relationship links to other related resources (attachments)
2 properties
RelationshipToAttachment
array
An array of attachment objects as relationship resources.
SelfLink
object
Link to self
1 property
BasicDetailModel
object
39 properties
JSONError
object
A JSON:API document
1 property
DocumentFindOneResponse
object
A JSON:API document which represents a single document
6 properties
FindAllResponseMetadata
object
A JSON:API document
9 properties
DocumentType
string
type of document. This field is always returned in JSON response
DocumentDetail

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

general-services-administration-documents-api-openapi.yml Raw ↑

Other APIs General Services Administration publishes across the network.

Contract-Awarded Labor Category (CALC) API
GSA Fleet Vehicles / Vehicle Leasing
SAM.gov Federal Hierarchy FOUO API
SAM.gov Federal Hierarchy Public API
SAM.gov Get Opportunities Public API
SAM.gov Product Service Codes (PSC) API
SAM.gov Public Location Services API
Search.gov Type-Ahead Suggestions API
TMSS 2.0 Rate Query API
Sustainable Facilities Tool API
General Services Administration Action API
General Services Administration Admin API
Where this information came from

This is an independent, third-party profile of General Services Administration Documents API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.