Skip to main content
GET
List orders

Authorizations

Authorization
string
header
required

Create an API token using sf tokens create or at https://sfcompute.com/account/api-keys.

Query Parameters

id
string[]

Filter by order ID (repeatable).

Pattern: ordr_[0-9a-zA-Z_-]{1,21}
pool
string

Filter by pool. A resource path like 'sfc:pool:acme:prod:my-pool' or an ID. Resource paths are human-readable but not stable - they change when resources are renamed or moved. IDs are stable and permanent.

Pattern: (pool_[0-9a-zA-Z_-]{1,21})|(sfc:pool:[a-zA-Z0-9._-]+(:[a-zA-Z0-9._-]+){2,2})
Example:

"pool_k3R-nX9vLm7Qp2Yw5Jd8F"

workspace
string

Scope the listing to a single workspace (ID, resource path, or name). Ignored when pool is given (the pool already names its workspace). Without either, the list spans the whole organization and requires an org-level Order:List grant. A resource path like 'sfc:workspace:acme:my-workspace' or an ID. Resource paths are human-readable but not stable - they change when resources are renamed or moved. IDs are stable and permanent.

Pattern: (wksp_[0-9a-zA-Z_-]{1,21})|(sfc:workspace:[a-zA-Z0-9._-]+(:[a-zA-Z0-9._-]+){1,1})
Example:

"wksp_k3R-nX9vLm7Qp2Yw5Jd8F"

side
enum<string>
Available options:
sell,
buy
status
enum<string>[]

Filter by status (repeatable).

The status of an order in the system.

pending = not resolved/processed yet.

filled = order executed.

partially_filled = the order matched part of its requested capacity and remains active for the remainder.

standing = the order is waiting for a match.

cancelled = the order was cancelled either automatically (not a standing order and didn't immediately fill, or current time past end_at) or by explicit cancellation.

rejected = validation/system error occurred.

Available options:
pending,
filled,
partially_filled,
rejected,
cancelled,
standing
created_after
integer<int64>

Unix timestamp.

Example:

1738972800

created_before
integer<int64>

Unix timestamp.

Example:

1738972800

procurement
string

Filter to one procurement's orders (ID or resource path). Without it, the list omits procurement orders. A resource path like 'sfc:procurement:acme:prod:my-procurement' or an ID. Resource paths are human-readable but not stable - they change when resources are renamed or moved. IDs are stable and permanent.

Pattern: (proc_[0-9a-zA-Z_-]{1,21})|(sfc:procurement:[a-zA-Z0-9._-]+(:[a-zA-Z0-9._-]+){2,2})
Example:

"proc_k3R-nX9vLm7Qp2Yw5Jd8F"

deployment

Filter to one deployment's orders (ID or resource path). Without it, the list omits deployment-managed orders. A resource path like 'sfc:deployment:acme:prod:my-deployment' or an ID. Resource paths are human-readable but not stable - they change when resources are renamed or moved. IDs are stable and permanent.

Pattern: (depl_[0-9a-zA-Z_-]{1,21})|(sfc:deployment:[a-zA-Z0-9._-]+(:[a-zA-Z0-9._-]+){2,2})
Example:

"depl_k3R-nX9vLm7Qp2Yw5Jd8F"

sort_by
enum<string>
default:-created_at

Prefix with - for descending.

Available options:
created_at,
-created_at,
start_at,
-start_at
limit
integer<u-int32>
default:50
Required range: 1 <= x <= 200
starting_after
string

Set to the response's cursor to fetch the next page.

Pattern: ^ordrc_[A-Za-z0-9_-]+$
Example:

"ordrc_gqXR7s0Kj5mHvE2wNpLc4Q"

ending_before
string

Set to the response's cursor to fetch the previous page.

Pattern: ^ordrc_[A-Za-z0-9_-]+$
Example:

"ordrc_gqXR7s0Kj5mHvE2wNpLc4Q"

Response

Paginated list of orders.

object
string
default:list
required
read-only
Allowed value: "list"
has_more
boolean
required
data
object[]
required
cursor
null | string

Pass as starting_after or ending_before to paginate.

Pattern: ^ordrc_[A-Za-z0-9_-]+$
Example:

"ordrc_gqXR7s0Kj5mHvE2wNpLc4Q"