National Archives and Records Administration

National Archives and Records Administration Partner API

The Partner API from National Archives and Records Administration — 5 operation(s) for partner.

Documentation GitHub OpenAPI

Operations 5

POST /partners/create Create a new partner #

GET /partners/search Search for partners #

PATCH /partners/update Update partner name #

GET /partners/contributions/partnerNameId/{partnerNameId} Get partner contributions by partnerNameId #

GET /partners/contributions/fullName/{fullName} Get partner contributions by fullName #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/national-archives-and-records-administration-partner-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: NextGen Catalog Partner API
  version: 0.2.0
  description: This is the NextGen Catalog API application made with Express and documented with Swagger.
servers:
- url: https://catalog.archives.gov/api/v2/
tags:
- name: Partner
paths:
  /partners/create:
    post:
      summary: Create a new partner
      description: Allows a moderator to create a new partner. The partner is initially created with a status of 'ACTIVE'.
      tags:
      - Partner
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - status
              - fullName
              - userId
              properties:
                userId:
                  format: uuid
                  type: string
                  example: 3fa85f64-5717-4562-b3fc-2c963f66afa
                  description: The Id of the partner.
                status:
                  type: string
                  example: ACTIVE
                  description: The current status of the partner. Default is set to active.
                fullName:
                  type: string
                  example: Demo Partner
                  description: The full name of the partner.
      responses:
        '201':
          description: The partner was created successfully. The response includes the created partner details.
          content:
            application/json:
              schema:
                type: object
                properties:
                  partnerNameId:
                    type: string
                    example: 0360214c-55b4-4819-8f28-206b24cca41a
                    description: The unique identifier of the partner.
                    format: uuid
                  userId:
                    format: uuid
                    type: string
                    example: 3fa85f64-5717-4562-b3fc-2c963f66afa
                    description: The Id of the partner.
                  status:
                    type: string
                    example: ACTIVE
                    description: The current status of the partner. Default is set to active.
                  fullName:
                    type: string
                    example: Demo Partner
                    description: The full name of the partner.
        '400':
          description: Validation error. This can occur if the request body does not match the expected format.
        '500':
          description: Internal server error.
      security:
      - ApiKeyAuth: []
      operationId: postPartnersCreate
      x-operation-id-source: derived
  /partners/search:
    get:
      summary: Search for partners
      description: Allows users to search for partners via userId , partner name, partnerNameId or all
      tags:
      - Partner
      parameters:
      - in: query
        name: partnerNameId
        description: partnerNameId of the partner being searched
        required: false
        schema:
          maximum: 50
          type: string
        example: 0360214c-55b4-4819-8f28-206b24cca41a
      - in: query
        name: fullName
        description: Full name of the partner being searched
        required: false
        schema:
          maximum: 100
          type: string
        example: Demo Partner
      - in: query
        name: userId
        description: userId of the user that associated with the partner
        required: false
        schema:
          maximum: 50
          type: string
        example: 3fa85f64-5717-4562-b3fc-2c963f66afa
      responses:
        '200':
          description: List of the partners retrieved through the search criteria.
          content:
            application/json:
              schema:
                type: object
                properties:
                  partnerNameId:
                    type: string
                    description: The unique identifier of the partner.
                    format: uuid
                  userId:
                    format: uuid
                    type: string
                    example: 3fa85f64-5717-4562-b3fc-2c963f66afa
                    description: The Id of the partner.
                  status:
                    type: string
                    example: ACTIVE
                    description: The current status of the partner. Default is set to active.
                  fullName:
                    type: string
                    example: Demo Partner
                    description: The full name of the partner.
        '400':
          description: Validation error. This can occur if the request body does not match the expected format.
        '500':
          description: Internal server error.
      security:
      - ApiKeyAuth: []
      operationId: getPartnersSearch
      x-operation-id-source: derived
  /partners/update:
    patch:
      summary: Update partner name
      description: Allows a moderator to update partner's full name and status.
      tags:
      - Partner
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - partnerNameId
              - userId
              properties:
                partnerNameId:
                  type: string
                  format: uuid
                  example: 3fa85f64-5717-4562-b3fc-2c963f66afa
                  description: Id of the partner to be updated.
                status:
                  type: string
                  example: INACTIVE
                  description: Current status of the partner to be updated.
                userId:
                  type: string
                  format: uuid
                  example: 0360214c-55b4-4819-8f28-206b24cca41a
                  description: Id of the account to do the update.
                fullName:
                  type: string
                  example: Demo Partner Changed
                  description: Name of the partner to be updated.
      responses:
        '200':
          description: The partner was updated successfully. The response includes the updated partner name.
          content:
            application/json:
              schema:
                type: object
                properties:
                  partnerNameId:
                    type: string
                    format: uuid
                    example: 3fa85f64-5717-4562-b3fc-2c963f66afa
                    description: The unique identifier of the partner.
                  userId:
                    type: string
                    format: uuid
                    example: 0360214c-55b4-4819-8f28-206b24cca41a
                    description: The unique identifier of the user making the changes.
                  fullName:
                    type: string
                    format: string
                    example: Demo Partner Changed
                    description: The new name of the partner.
                  status:
                    type: string
                    format: string
                    example: INACTIVE
                    description: The status of the partner.
        '400':
          description: Validation error. This can occur if the request body does not match the expected format.
        '500':
          description: Internal server error.
      security:
      - ApiKeyAuth: []
      operationId: patchPartnersUpdate
      x-operation-id-source: derived
  /partners/contributions/partnerNameId/{partnerNameId}:
    get:
      summary: Get partner contributions by partnerNameId
      description: Allows a moderator to get partner contributions by partnerNameId.
      tags:
      - Partner
      parameters:
      - in: path
        name: partnerNameId
        type: string
        format: uuid
        required: true
        description: The unique identifier of the partner.
        example: 0360214c-55b4-4819-8f28-206b24cca41a
      - $ref: '#/components/parameters/paramPage'
      - $ref: '#/components/parameters/paramLimit'
      responses:
        '200':
          description: List of the partner contributions retrieved successfully.
        '400':
          description: Validation error. This can occur if the request body does not match the expected format.
        '500':
          description: Internal server error.
      security:
      - ApiKeyAuth: []
      operationId: getPartnersContributionsPartnerNameIdByPartnerNameId
      x-operation-id-source: derived
  /partners/contributions/fullName/{fullName}:
    get:
      summary: Get partner contributions by fullName
      description: Allows a moderator to get partner contributions by id.
      tags:
      - Partner
      parameters:
      - in: path
        name: fullName
        type: string
        required: true
        description: The fullName of the partner.
        example: NARA Partner
      - $ref: '#/components/parameters/paramPage'
      - $ref: '#/components/parameters/paramLimit'
      responses:
        '200':
          description: List of the partner contributions retrieved successfully.
        '400':
          description: Validation error. This can occur if the request body does not match the expected format.
        '500':
          description: Internal server error.
      security:
      - ApiKeyAuth: []
      operationId: getPartnersContributionsFullNameByFullName
      x-operation-id-source: derived
components:
  parameters:
    paramPage:
      in: query
      name: page
      description: Page number of the paginated result set in which to return.
      required: false
      schema:
        default: 1
        maximum: 10000
        type: integer
      example: 20
    paramLimit:
      in: query
      name: limit
      description: Maximum number of results returned for each page of paginated data.
      required: false
      schema:
        default: 20
        maximum: 1000
        type: integer
      example: 75