VRPlatformVRPlatform
Partner

/partner/connections

List managed teams in one regional partition of the partner portfolio with active connections and current sync state. Supports team and company search, lifecycle, app, and connection error-state filters, pagination, and team ordering. Select the partition with x-data-region.

Required scope: teams:read

GET
/partner/connections

Authorization

apiKey
X-API-Key<token>

API key provided in dashboard

In: header

Query Parameters

search?string

Filter by team or company name

status?string
Value in"active" | "inactive" | "onboarding"
appId?string

Filter teams with an active connection to this app

isErrorState?boolean

Filter teams by whether an active connection is in error

sort?string

Sort field; prefix with - for descending order

Default"-createdAt"
Value in"name" | "-name" | "createdAt" | "-createdAt"
limit?number
Default100
Range1 <= value <= 250
page?number
Default1
Range1 <= value
offset?number
Range0 <= value

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

curl -X GET "https://staging.api.vrplatform.app/partner/connections"
{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "logo": "string",
      "createdAt": "2024-01-15T12:30:00.000+00:00",
      "status": "active",
      "isOnboarding": true,
      "connections": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "name": "string",
          "isErrorState": true,
          "app": {
            "id": "string",
            "name": "string",
            "icon": "string",
            "category": "paymentGateway"
          },
          "currentSync": {
            "status": "queued",
            "createdAt": "2024-01-15T12:30:00.000+00:00",
            "updatedAt": "2024-01-15T12:30:00.000+00:00",
            "message": "string"
          }
        }
      ]
    }
  ],
  "pagination": {
    "limit": 100,
    "page": 1,
    "total": 0,
    "totalPage": 0,
    "nextPage": 0
  }
}
{
  "code": "string",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "string",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "string",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "string",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "string",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "string",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "string",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "string",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "string",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}

/partner/billing GET

Previous Page

/partner/listings GET

Next Page