Skip to content
adversarial

List documents

GET
/v1/documents
curl --request GET \
  --url 'https://api.adversarial.com/api/v1/documents?version=2024.04.01&freetext=incident%20response'

Returns one row per (slug, version) the organization can see: its current documents, a version held for adoption, and any retired versions it previously used. Workflow state is absent only on retired rows.

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
version
string | null

Only return rows for this version.

Example
2024.04.01
state
One of:

Whether a document version is the organization’s current one, a retired one it previously used, or an in-flight adoption draft.

string
Allowed values: current archived draft

Only return current or archived rows.

freetext
string | null

Only return documents matching this text. Every whitespace-separated word must appear in the title, description or slug, so adding words narrows the result rather than widening it. Case-insensitive.

Example
incident response

Responses

Section titled “Responses”

200

Section titled “200”

List all documents

Media typeapplication/json

A list of compliance documents with their current status.

Array<object>

Provides basic information about one version of a document. The document list contains one row per (slug, version) the organization can see.

object
archived_date

When the organization retired this version. Only set on archived rows.

string | null format: date-time
category
required

The compliance-program section containing a document.

string
Allowed values: governance procedure policy
description
required
string
latest_version
required

The edition of a document as YYYY.MM.NN: the year and month it was issued, then a two-digit sequence number counting editions issued in that month.

string
slug
required
string
state
One of:
One of:

The document has not been initialized yet. It is possible for the document to have details, meaning that a proposal is “open” to initialize it.

object
value
required
string
Allowed values: uninitialized
title
required
string
version
required

The version this row describes.

string
version_state
required

Whether a document version is the organization’s current one, a retired one it previously used, or an in-flight adoption draft.

string
Allowed values: current archived draft
Example
[
  {
    "category": "governance",
    "latest_version": "2026.09.01",
    "slug": "cisp",
    "state": {
      "value": "uninitialized"
    },
    "version": "2026.09.01",
    "version_state": "current"
  }
]