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

National Archives and Records Administration Comments API

Comment search and data retrieval

National Archives and Records Administration Comments API is one of 16 APIs that National Archives and Records Administration publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 7 operations across 6 paths, and defines 2 schemas. It is described by OpenAPI 3.0.0, at version 0.2.0.

Requests are made against a single base URL, https://catalog.archives.gov/api/v2/.

7 operations 6 paths 2 schemas 1 DELETE4 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
0.2.0
Base URL
https://catalog.archives.gov/api/v2/
Resource Areas
1

Paths & Operations 7

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

Comments 7

Comment search and data retrieval

GET
/comments/search
Get search results for comment data by sending a request with search parameters to the catalog.
6 params → 200400422
GET
/comments/{id}
Get a single comment object by comment id.
2 params → 200422
GET
/comments/naId/{naId}
Get comments by their parent record's naId.
2 params → 200422
GET
/comments/userId/{userId}
Get comments by their contributor's userId.
2 params → 200422
POST
/comments/
Add a comment.
body → 200422
PATCH
/comments/{contributionId}
Update a comment.
1 param body → 200422
DELETE
/comments/{contributionId}
Deactivate/remove a comment.
4 params → 200409

Schemas 2

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

commentUpdateBody
object
2 properties
commentBody
object
6 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

national-archives-and-records-administration-comments-api-openapi.yml Raw ↑

Other APIs National Archives and Records Administration publishes across the network.

National Archives and Records Administration Accounts API
National Archives and Records Administration Announcements API
National Archives and Records Administration Contributions API
National Archives and Records Administration Extracted Text API
National Archives and Records Administration Justifications API
National Archives and Records Administration Metadata API
National Archives and Records Administration Online Availability API
National Archives and Records Administration Other Extracted Text API
National Archives and Records Administration Partner API
National Archives and Records Administration Records API
National Archives and Records Administration Statistics API
National Archives and Records Administration Tags API