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

The Users API from National Archives and Records Administration — 3 operation(s) for users.

National Archives and Records Administration Users 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 Users. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 3 operations across 3 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/.

3 operations 3 paths 2 schemas 1 GET2 PATCH

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 3

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

Users 3
PATCH
/users
Update user information given a user's email.
body → 200400422
PATCH
/users/username
Update a users username given their userId.
body → 200400422
GET
/users/notifications/:userId
Recieve the users notifications.
5 params → 200422

Schemas 2

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

userUpdateBody
object
7 properties 3 required
usernameUpdateBody
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

national-archives-and-records-administration-users-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 Comments 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