Skip to main content
GET
/
v2
/
orders
List Orders
curl --request GET \
  --url https://api.kausate.com/v2/orders \
  --header 'X-API-Key: <api-key>'
{
  "orders": [
    {
      "orderId": "report-D2601V_HRB******-DEHRSI-20240319143022",
      "customerReference": "my-ref-123",
      "status": "completed",
      "requestTime": "2024-03-19T14:30:22.787045Z",
      "responseTime": "2024-03-19T14:32:45.108791Z"
    }
  ],
  "total": 1
}

Authorizations

X-API-Key
string
header
required

Sign up at Kausate.com to get an API key

Query Parameters

limit
integer
default:100

Maximum number of orders to return

Required range: 1 <= x <= 100
workflowType
enum<string> | null

Filter orders by workflow type

Available options:
DocumentRetrieval,
CompanyReport,
ShareholderGraph,
UBOExtraction

Response

Orders retrieved successfully

Response model for listing orders.

orders
OrderSummary · object[]
required

List of orders

total
integer
required

Total number of orders returned