List Approvals

Retrieve a paginated list of your approvals. Approvals can be of type CONSENT, FORM, DOCUMENT, JSON, or POLICY. Filter with the optional query parameters: search (case-insensitive match on the approval name), active (active or inactive approvals only), types (one or more resource types), and internalId (your own identifier for a specific approval). Use pageIndex and pageSize to paginate.

GET /approvals

List Approvals

cURL

curl --request GET \
  --url https://api.example.com/approvals

import requests

url = "https://api.example.com/approvals"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://api.example.com/approvals', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/approvals",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/approvals"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.example.com/approvals")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/approvals")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

200

{
  "data": [
    {
      "id": "507f1f77bcf86cd799439011",
      "name": "Identity Document",
      "type": "DOCUMENT",
      "active": true,
      "groupIds": [
        "507f1f77bcf86cd799439011"
      ],
      "updatedAt": "2025-01-15T10:30:00Z",
      "internalId": "internal-12345",
      "description": "Document to be requested on onboarding",
      "content": "s3://humanos-resources/onboarding/identity-document.pdf",
      "consentUrl": "https://example.com/terms-and-conditions",
      "placements": [
        {
          "id": "plc_1",
          "contact": null,
          "type": "SIGNATURE",
          "identityType": null,
          "x": 100,
          "y": 200,
          "width": 150,
          "height": 50,
          "pageIndex": 0
        }
      ]
    }
  ],
  "totalPages": 5
}

Headers

API-Version · string

Pin request, response, and webhook shapes to a specific dated API version (YYYY-MM-DD). Omit to use the version pinned to your API key (set when the key is created; new keys default to the latest version). New integrations should target the latest version.

Pattern: ^\d{4}-\d{2}-\d{2}$

Example:

"2026-07-06"

Query Parameters

pageIndex · number · default: 0

Zero-based page index. 0 returns the first page.

Example:

0

pageSize · number · default: 10

Number of items per page

Required range: 5 <= x <= 100

Example:

10

search · string

Search query to filter by. Is case-insensitive and does not need to match the entire value.

Maximum string length: 100

Example:

"example"

active · boolean

Filter by active status. Accepts true/false as string or boolean.

Example:

true

types · enum<string>[]

Filter by resource types. Can be a single value or array

Available options: CONSENT, FORM, DOCUMENT, JSON, POLICY

Example:

["DOCUMENT", "CONSENT"]

internalId · string

Identifier to help you identify the resource in your own system. We recommend using a unique value.

Example:

"internal-12345"

Response

200 - application/json

Returns an array of approval items and the total number of pages.

data · object[] · required

Array of your resources matching the query parameters

Show child attributes

totalPages · number · required

Total number of pages available based on the page size and total count

Example:

5