ValueApps
Sign inGet started
Developers/API referenceRequest access
Instructions & valuations

List instructions

GET /api/v1/instructions

Your institution’s instructions, newest first, in pages.

You need an institution key with the instructions:read scope. Your administrator makes one in Settings › API access.

Parameters

stage
string · optional
Only instructions at this workflow stage key, for example Approved.
client_id
string · optional
Only this client’s instructions, for example CL-981.
external_reference
string · optional
Find the instruction you sent with this reference.
page
integer · optional
Page number. Default 1.
page_size
integer · optional
Results per page, up to 100. Default 25.
updated_since
datetime · optional
Only records changed at or after this ISO 8601 time, for example 2026-10-27T00:00:00Z.

Try it

Sample data only; nothing is sent. Have a key? Sign in to try it on real data.

Errors

401 invalid_key
The key is missing, unknown, revoked or expired.
403 ip_not_allowed
The request came from an address the key is not allowed to use.
429 rate_limited
Too many requests this minute. Wait for Retry-After seconds.
429 quota_exceeded
The monthly allowance is used up. It resets on the first of the month.
403 wrong_key
This is a comparables key. Use an institution key for this endpoint.
403 api_not_enabled
API access isn’t switched on for your institution.
403 not_in_plan
This API isn’t part of your institution’s plan. Ask ValueApps to add it.
403 insufficient_scope
The key doesn’t have the access this call needs.