VRPlatformVRPlatform
Partner

/partner/users

List child-team users across one regional partition of the partner portfolio with their team memberships and owner accesses. Users who belong to the partner team itself are excluded. Select the partition with x-data-region.

Required scope: partner-users:read

GET
/partner/users

Authorization

apiKey
X-API-Key<token>

API key provided in dashboard

In: header

Query Parameters

search?string

Filter by user name or email

type?string

Filter by the exact user type

Value in"owner" | "user"
teamIds?string

Comma separated team ids; only return users with a membership on one of these teams

view?string

users: non-owner users with a portfolio membership; owners: owner users linked via membership or owner access; missing: users without any portfolio membership (delete candidates). Omitted returns every linked user.

Value in"users" | "owners" | "missing"
sortBy?string

Field to sort by

Value in"name" | "email" | "lastSeen" | "created"
sortDirection?string

Sort direction, defaults to asc

Value in"asc" | "desc"
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

curl -X GET "https://api.vrplatform.app/partner/users"
{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "firstName": "string",
      "lastName": "string",
      "email": "user@example.com",
      "secondaryEmails": [
        "string"
      ],
      "type": "string",
      "lastSeen": "2024-01-15T12:30:00.000+00:00",
      "createdAt": "2024-01-15T12:30:00.000+00:00",
      "memberships": [
        {
          "teamId": "a4ede8ba-7c0a-4485-8763-cbd9b282fbec",
          "teamName": "string",
          "role": "string",
          "status": "string",
          "lastInvitedAt": "2024-01-15T12:30:00.000+00:00"
        }
      ],
      "ownerAccesses": [
        {
          "teamId": "a4ede8ba-7c0a-4485-8763-cbd9b282fbec",
          "contactId": "b5ec5d98-4bee-4da1-ad24-dde86346cb1d",
          "ownerId": "4d206909-730f-409a-88f6-dcfaa8fc28cc",
          "role": "string",
          "name": "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"
    }
  ],
  "context": null
}
{
  "code": "string",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "context": null
}
{
  "code": "string",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "context": null
}
{
  "code": "string",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "context": null
}
{
  "code": "string",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "context": null
}
{
  "code": "string",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "context": null
}

/partner/users/{id} GET

Previous Page

/partner GET

Next Page