Skip to main content
GET
/
v1
/
plans
List plans
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.factify.com/v1/plans', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "plans": [
    {
      "id": "<string>",
      "workflow_id": "<string>",
      "claim_slots": [
        {
          "rubric_id": "<string>",
          "slot_name": "<string>",
          "claim_id": "<string>",
          "substitution_value": "<string>"
        }
      ],
      "submissions": [
        {
          "id": "<string>",
          "plan_id": "<string>",
          "filename": "<string>",
          "mime_type": "<string>",
          "added_at": "2023-11-07T05:31:56Z",
          "record_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "open_conflicts_count": 1,
      "total_conflicts_count": 1,
      "locked_at": "2023-11-07T05:31:56Z",
      "body_md_resolved": "<string>"
    }
  ],
  "page": 2,
  "page_size": 2,
  "total": 1
}

Documentation Index

Fetch the complete documentation index at: https://developers.factify.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Bearer authentication using a factapi-issued API key (ffy_<env>_<base32_uuid><base62_random>). Cookie-based sessions are accepted automatically by user-facing endpoints but are not surfaced as an OpenAPI auth scheme.

Query Parameters

page
integer<int32>
default:1

1-indexed page number.

Required range: x >= 1
page_size
integer<int32>
default:20

Number of plans per page.

Required range: 1 <= x <= 100

Response

Plans.

plans
object[]
required
page
integer<int32>
required

1-indexed page number.

Required range: x >= 1
page_size
integer<int32>
required

Number of plans per page.

Required range: x >= 1
total
integer<int64>
required

Total number of plans across all pages.

Required range: x >= 0