Skip to main content
GET
/
orchestrations
cURL
curl --request GET \
  --url https://api.otim.com/orchestrations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "direction": "from",
  "statuses": [
    "pending"
  ],
  "perPage": 10,
  "page": 0
}
'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "fromUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "ephemeralWalletAddress": "<string>",
    "instructions": {
      "ids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "completionIds": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ]
    },
    "metadata": {},
    "status": "pending",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "numRuns": 0,
    "toUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "payerAddress": "<string>",
    "dueDate": "2023-11-07T05:31:56Z",
    "maxRuns": 10
  }
]
Get orchestrations for a user, filtered by direction and optional status.

Authorizations

​
Authorization
string
header
required

JWT token for API authentication

Body

application/json
​
direction
enum<string>
required

Direction to filter orchestrations

Available options:
from,
to
​
statuses
enum<string>[] | null

Optional statuses to filter by

Orchestration status

Available options:
pending,
inProgress,
paid,
cancelled,
draft
​
perPage
integer<int8> | null

Number of records per page

Example:

10

​
page
integer<int16> | null

Page number

Example:

0

Response

200 - application/json

Orchestrations retrieved successfully

​
id
string<uuid>
required

Unique identifier for the orchestration

​
fromUserId
string<uuid>
required

Unique identifier for the user creating the orchestration

​
ephemeralWalletAddress
string<address>
required

Address of the ephemeral wallet that will sweep the funds

​
instructions
object
required

Instructions associated with the orchestration

​
metadata
object
required

Orchestration metadata as arbitrary JSON

​
status
enum<string>
required

Orchestration status

Available options:
pending,
inProgress,
paid,
cancelled,
draft
​
createdAt
string<date-time>
required

Timestamp when the orchestration was created

​
updatedAt
string<date-time>
required

Timestamp when the orchestration was last updated

​
numRuns
integer<uint64>
required

Number of times the orchestration has been executed

Example:

0

​
toUserId
string<uuid> | null

Optional user id of the payee to connect the orchestration to

​
payerAddress
string<address> | null

Address of the payer

​
dueDate
string<date-time> | null

Due date of the orchestration

​
maxRuns
integer<uint64> | null

Maximum number of times the orchestration can be executed

Example:

10