Framework Health & Vendor Data APIs

Learn how to retrieve framework health metrics and vendor information using Sprinto's Developer APIs.

Use the Framework Health & Vendor Data APIs to retrieve framework health summaries and vendor information from your Sprinto workspace. These APIs are read-only and do not modify data.

Before you begin

Before you use these APIs, make sure you have:

• Your Sprinto application URL (for example, https://app.sprinto.com)

• A valid Developer API key

To generate an API key:

1. Log in to Sprinto.

2. Navigate to Settings > Developer API.

3. Generate a new API key.

1. Copy and securely store the key.

Note

Keep your API key secure. Treat it like a password and never commit it to source control.

---

Request format

All Framework Health & Vendor Data APIs:

• Use the POST method.

• Require the API key in the api-key header.

• Accept request parameters inside the args object.

POST {baseURL}/api/external/schema/queries/<queryName>/execute

Headers

api-key: <YOUR_API_KEY>Content-Type: application/json

Body

{
  "args": {}
}

---

Framework health API

Returns the number of passing and non-passing checks for each enabled compliance framework.

Endpoint

POST /api/external/schema/queries/frameworksCheckSummary/execute

Request body

No request parameters are required.

{
  "args": {}
}

Example response

{
  "isSuccess": true,
  "data": [
    {
      "frameworkPk": "578f45c8-…",
      "passing": 302,
      "notPassing": 1415
    },
    {
      "frameworkPk": "5cb8380b-…",
      "passing": 105,
      "notPassing": 1103
    }
  ]
}

Response fields

Field	Description
frameworkPk	Unique identifier of the framework.
passing	Number of passing checks.
notPassing	Number of checks that are not passing.

---

List vendors API

Returns a paginated list of vendors in your Sprinto workspace.

Endpoint

POST /api/external/schema/queries/vendorsPaginated/execute

Request parameters

Parameter	Type	Required	Description
first	Integer	No	Number of vendors to return.
after	String	No	Cursor for retrieving the next page.
searchQuery	String	No	Search vendors by name.
categories	Array	No	Filter vendors by category.

Example request

{
  "args": {
    "first": 20
  }
}

Example response

{
  "isSuccess": true,
  "data": {
    "totalCount": 128,
    "edges": [
      {
        "cursor": "eyJ…",
        "node": {
          "pk": "a7ecf560-…",
          "name": "AWS",
          "category": "Cloud Providers"
        }
      }
    ],
    "pageInfo": {
      "hasNextPage": true,
      "endCursor": "eyJ…"
    }
  }
}

Pagination

To retrieve the next page, pass the endCursor value returned in the previous response as the after parameter.

Example:

{
  "args": {
    "first": 20,
    "after": "eyJ…"
  }
}

---

Get vendor details API

Returns detailed information for a specific vendor.

Endpoint

POST /api/external/schema/queries/getVendorByPk/execute

Request parameters

Parameter	Type	Required	Description
vendorPk	String	Yes	Unique identifier of the vendor.

Example request

{
  "args": {
    "vendorPk": "a7ecf560-4155-4b6a-9afc-80a73ba9de45"
  }
}

Example response

{
  "isSuccess": true,
  "data": {
    "pk": "a7ecf560-…",
    "name": "AWS",
    "category": "Cloud Providers",
    "riskLevel": "HIGH",
    "isActive": true
  }
}

Response fields

Field	Description
pk	Unique identifier of the vendor.
name	Vendor name.
category	Vendor category.
riskLevel	Assigned vendor risk level.
isActive	Indicates whether the vendor is active.

---

Error responses

The APIs return the following errors:

Error	Description
401 Unauthorized	API key is missing (User login required!).
401 Unauthorized	API key is invalid or inactive.
Invalid parameters	One or more request parameters are invalid. The response includes details about the invalid input.

Note

• These APIs are read-only.

• They do not create, update, or delete data in your Sprinto workspace.

• Use the List vendors API to retrieve a vendor's vendorPk before calling the Get vendor details API.