VRPlatformVRPlatform
Me

/me

UI bootstrap call: the authenticated user plus the resolved team (embedded-session team, x-team-id header, or the oldest active membership), including placement, partner managed-team region discovery, membership accessSource (direct or partnerDerived), effective permissions, owner access, effective feature IDs, issue counts, and frontend setup context. Embedded identities use sub instead of email, so user.email is null for them.

Required scope: self:read

GET
/me

Authorization

apiKey
X-API-Key<token>

API key provided in dashboard

In: header

Query Parameters

allowTeamFallback?boolean

When the requested team is not accessible (membership removed, team deleted), resolve the default team instead of failing

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/me"
{
  "user": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "type": "admin",
    "firstName": "string",
    "lastName": "string",
    "email": "string",
    "secondaryEmails": [
      "string"
    ],
    "phone": "string",
    "partnerId": "bf408d53-df49-40a6-8455-a34bd4360901",
    "createdAt": "2024-01-15T12:30:00.000+00:00"
  },
  "team": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "slug": "string",
    "dataRegion": "ap",
    "apiBaseUrl": "http://example.com",
    "type": "propertyManager",
    "partnerId": "bf408d53-df49-40a6-8455-a34bd4360901",
    "isGeneralLedger": true,
    "status": "active",
    "isOnboarding": true,
    "createdAt": "2024-01-15T12:30:00.000+00:00",
    "defaultCurrency": "string",
    "statementStartAt": "string",
    "effectiveStatementStartAt": "string",
    "booksClosedAt": "string",
    "defaultRevenueRecognition": "checkIn",
    "longTermStayNights": 0,
    "colorPrimary": "string",
    "logo": "string",
    "settings": {
      "showVRPilotGuide": true,
      "showReservations": true,
      "showCancelledReservations": true,
      "showReservationTotal": true,
      "showOwnerCalendarBlocking": true,
      "showTaxStatements": true,
      "showTwoFactorAuth": true
    },
    "billingPartnerId": "923c9e6a-7971-4599-a964-4e4ec88578c6",
    "billingSubscriptionStatus": "string",
    "billingPaymentMethodType": "string",
    "cancelledAt": "string",
    "vriVrtPreview": {
      "lifecycle": "prepared",
      "snapshotAt": "2024-01-15T12:30:00.000+00:00",
      "currentTeamRole": "source",
      "sourceTeam": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "targetTeam": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      }
    }
  },
  "membership": {
    "accessSource": "direct",
    "role": "admin",
    "permissionBundles": [
      "ui:team-admin:v1"
    ],
    "permissions": [
      "self:read"
    ],
    "notifications": {
      "ownerStatementInReview": true,
      "ownerStatementPublished": true,
      "ownerInvited": true,
      "memberInvited": true
    }
  },
  "ownerAccess": [
    {
      "contactId": "b5ec5d98-4bee-4da1-ad24-dde86346cb1d",
      "ownerId": "4d206909-730f-409a-88f6-dcfaa8fc28cc",
      "role": "admin"
    }
  ],
  "features": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "issues": [
    {
      "code": "teamInactive",
      "count": 9007199254740991
    }
  ],
  "frontendContext": {
    "hasReservations": true,
    "reservationId": "54c41ef9-5629-4a9c-bb0d-10f615966bd0",
    "hasPms": true,
    "activePmsConnectionId": "d75da53b-d4a8-47df-bbe8-95aedaa66800",
    "hasOwnerBlockingConnection": true,
    "hasAchConnection": true,
    "hasDeposit": true,
    "depositTransactionId": "3d6fa06c-7858-46b5-97a3-815a1f5a7292",
    "hasListingNeedsReview": true,
    "listingNeedsReviewId": "29f71f6c-0beb-457e-8f94-9d075b403953",
    "hasOwners": true,
    "hasOwnerNeedsReview": true,
    "ownerNeedsReviewId": "4c8d9f85-09c3-4e03-a5a8-72e2068cc486",
    "guideOnboardingStatus": "skipped"
  },
  "partnerContext": {
    "managedTeamRegions": [
      {
        "dataRegion": "ap",
        "apiBaseUrl": "http://example.com",
        "counts": {
          "active": 9007199254740991,
          "inactive": 9007199254740991
        }
      }
    ]
  }
}
{
  "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
}

/me/teams GET

Previous Page

/me/notifications PUT

Next Page