List a unit's vault requests

curl --request GET \
  --url https://api2.endstate.io/v1/units/{unit_id}/vault-requests \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api2.endstate.io/v1/units/{unit_id}/vault-requests', 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://api2.endstate.io/v1/units/{unit_id}/vault-requests",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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://api2.endstate.io/v1/units/{unit_id}/vault-requests"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api2.endstate.io/v1/units/{unit_id}/vault-requests")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "vault_requests": [
    {
      "id": "00000000-0000-4000-8000-000000000000",
      "unit_id": "22222222-2222-4222-8222-222222222222",
      "vault": {
        "id": "33333333-3333-4333-8333-333333333333",
        "name": "Alliance Vault",
        "logo_url": "https://vault.example/logo.png",
        "key_mode": "managed"
      },
      "status": "pending",
      "notes": null,
      "rejection_reason": null,
      "decided_at": null,
      "available_at": null,
      "hold": null,
      "ready_to_ship": false,
      "dispatched_at": null,
      "expires_at": "2026-07-15T12:00:00.000Z",
      "created_at": "2026-06-15T12:00:00.000Z"
    }
  ],
  "pagination": {
    "limit": 50,
    "has_more": false,
    "next_cursor": null
  }
}

Vaults

List a unit's vault requests

Returns the unit’s vault requests, oldest first, as a cursor-paginated list. Use it to find the request for an item: at most one of a unit’s requests is open at a time, with status pending, submitted, active, unvault_waiting or unvaulting, and the one that reads active, unvault_waiting or unvaulting is the item’s current stay in a vault. Takes an API key, which reads any unit in its environment. A tap session token is not accepted: call this from your server.

GET

units

{unit_id}

vault-requests

List a unit's vault requests

curl --request GET \
  --url https://api2.endstate.io/v1/units/{unit_id}/vault-requests \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api2.endstate.io/v1/units/{unit_id}/vault-requests', 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://api2.endstate.io/v1/units/{unit_id}/vault-requests",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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://api2.endstate.io/v1/units/{unit_id}/vault-requests"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api2.endstate.io/v1/units/{unit_id}/vault-requests")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "vault_requests": [
    {
      "id": "00000000-0000-4000-8000-000000000000",
      "unit_id": "22222222-2222-4222-8222-222222222222",
      "vault": {
        "id": "33333333-3333-4333-8333-333333333333",
        "name": "Alliance Vault",
        "logo_url": "https://vault.example/logo.png",
        "key_mode": "managed"
      },
      "status": "pending",
      "notes": null,
      "rejection_reason": null,
      "decided_at": null,
      "available_at": null,
      "hold": null,
      "ready_to_ship": false,
      "dispatched_at": null,
      "expires_at": "2026-07-15T12:00:00.000Z",
      "created_at": "2026-06-15T12:00:00.000Z"
    }
  ],
  "pagination": {
    "limit": 50,
    "has_more": false,
    "next_cursor": null
  }
}

Authorizations

Authorization

string

header

required

Use Authorization: Bearer end_sk_* for partner API keys (e.g. end_sk_AbCd_example_api_key).

Path Parameters

unit_id

string<uuid>

required

Unit id.

Example:

"22222222-2222-4222-8222-222222222222"

Query Parameters

limit

integer

default:50

Maximum number of records to return. Defaults to 50; maximum 100.

Required range: 1 <= x <= 100

cursor

string

Opaque cursor from the previous page.

Minimum string length: 1

status

enum<string>

Filter to requests with this status.

Available options:

pending,

submitted,

active,

unvault_waiting,

unvaulting,

unvaulted,

cancelled,

expired,

rejected,

failed

Response

A page of vault requests.

vault_requests

object[]

required

Show child attributes

pagination

object

required

Show child attributes

Overview

Endpoints

List a unit's vault requests

Authorizations

Path Parameters

Query Parameters

Response