Skip to main content
GET
/
v1
/
admin
/
settlements
/
pipeline
Get settlement pipeline state distribution
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.keystoneos.xyz/v1/admin/settlements/pipeline', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "states": [
    {
      "state": "<string>",
      "count": 123
    }
  ],
  "total_in_flight": 123,
  "total_terminal": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.keystoneos.xyz/llms.txt

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

Authorizations

​
Authorization
string
header
required

Auth0 JWT access token. See Authentication for details.

Query Parameters

​
environment_slug
string | null

Filter by environment slug (e.g., production, staging)

Response

Successful Response

Current distribution of settlements across all states.

​
states
PipelineStateCount · object[]
required
​
total_in_flight
integer
required
​
total_terminal
integer
required