VRPlatformVRPlatform
Operations

/operations

List asynchronous operations owned by the requesting team. Pass initiatedBy=me to return operations attributed to the authenticated user. Filters, counts, and cursor pagination use the same requester scope as GET /operations/{id}.

Required scope: operations:read

GET
/operations

Authorization

apiKey
X-API-Key<token>

API key provided in dashboard

In: header

Query Parameters

resourceType?string
Value in"bank-rule" | "connection" | "contact" | "file" | "flow" | "listing" | "recurring-fee" | "recurring-transaction-template" | "reservation" | "statement" | "team" | "transaction" | "webhook"
resourceId?string
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid
type?string
Value in"ach-verification" | "bank-rule-run" | "calendar-block" | "calendar-unblock" | "connection-archive" | "connection-connect" | "connection-extract" | "connection-sync" | "csv-import" | "csv-import-preview" | "export" | "flow-run" | "historical-gl-import" | "historical-statement-import" | "listing-journal-refresh" | "plaid-initial-sync" | "pms-cutover" | "pms-cutover-preview" | "provider-payment" | "provider-payment-recovery" | "recurring-transaction-run" | "reservation-journal-refresh" | "team-delete" | "team-demo-data" | "team-duplicate" | "team-initialize" | "transaction-journal-refresh" | "vri-statement-import" | "vri-team-migration" | "webhook-test"
status?string
Value in"queued" | "running" | "completed" | "failed"
createdAtFrom?string

Timestamp string with date, time, milliseconds, and timezone.

Formatdate-time
createdAtTo?string

Timestamp string with date, time, milliseconds, and timezone.

Formatdate-time
initiatedBy?string
cursor?string

Opaque pagination cursor returned by a previous response. Pass it back unchanged.

Formatvrp-opaque-cursor
limit?integer
Default50
Range1 <= value <= 100

Header Parameters

x-data-region?string

Selects the regional data partition for this regional collection read. It does not change the authenticated team context.

Value in"ap" | "crunchy" | "eu" | "hostaway" | "us"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.vrplatform.app/operations"
{
  "items": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "type": "ach-verification",
      "status": "queued",
      "resource": {
        "type": "bank-rule",
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "role": "source",
        "url": "http://example.com"
      },
      "failure": {
        "code": "csvBlankHeader",
        "message": "CSV contains a blank header"
      },
      "initiator": {
        "type": "user",
        "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"
      },
      "createdAt": "2024-01-15T12:30:00.000+00:00",
      "startedAt": "2024-01-15T12:30:00.000+00:00",
      "finishedAt": "2024-01-15T12:30:00.000+00:00"
    }
  ],
  "counts": {
    "total": 9007199254740991,
    "queued": 9007199254740991,
    "running": 9007199254740991,
    "completed": 9007199254740991,
    "failed": 9007199254740991
  },
  "total": 9007199254740991,
  "nextCursor": "string"
}
{
  "code": "AUDIT_CURSOR_EXPIRED",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "AUDIT_CURSOR_EXPIRED",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "AUDIT_CURSOR_EXPIRED",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "AUDIT_CURSOR_EXPIRED",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "AUDIT_CURSOR_EXPIRED",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "AUDIT_CURSOR_EXPIRED",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "AUDIT_CURSOR_EXPIRED",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "MISDIRECTED_REQUEST",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": {
    "teamId": "a4ede8ba-7c0a-4485-8763-cbd9b282fbec",
    "dataRegion": "ap",
    "apiBaseUrl": "http://example.com"
  }
}
{
  "code": "AUDIT_CURSOR_EXPIRED",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "AUDIT_CURSOR_EXPIRED",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "AUDIT_CURSOR_EXPIRED",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}

/operations/{id} GET

Previous Page

/sources/{id}/download GET

Next Page