List election withdrawals

List the account's election withdrawal requests.

Sorted by created_at descending, then withdrawal_id.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length between 1 and 256

The account ID or account number.

Query Params
string
length between 1 and 64

Filter to withdrawals against this election.

string
length between 1 and 64

Filter to withdrawals against this corporate action.

status
array of objects

Filter to withdrawals in any of the given states. Repeat the parameter to supply more than one. A value this service does not recognise matches nothing rather than being rejected.

status
string
length between 1 and 256

Exact match on the reference_id you supplied when creating the record. Returns zero or one result. Use it to recover a record whose create response you lost.

int64
0 to 2900000000000

Lower bound, inclusive, on creation time.

int64
0 to 2900000000000

Upper bound, inclusive, on creation time.

int64
0 to 2900000000000

Inclusive lower bound on updated_at. Returns every record touched at or after this instant, including changes Clear Street operations made rather than you. This is the parameter to poll on: created_at never changes, so filtering on it will not surface a status transition.

A record may be returned again on a later poll; deduplicate on the record's own identifier together with updated_at.

int32
1 to 1000
Defaults to 25

Number of records to return per page.

string
length between 1 and 2048

Opaque cursor returned as next_page_token from a previous page. Omit to fetch the first page.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Choose an example:
application/json
application/problem+json