Teams
/teams/lookup
Look up teams by name
Authorization
apiKey X-API-Key<token>
API key provided in dashboard
In: header
Query Parameters
name*string
Length
1 <= lengthstatus?string
Value in
"active" | "inactive" | "deleted" | "onboarding"limit?number
Default
100Range
1 <= value <= 250page?number
Default
1Range
1 <= valueResponse Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://api.vrplatform.app/teams/lookup?name=string"{
"data": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"defaultCurrency": "string",
"longTermStayNights": 0,
"defaultRevenueRecognition": "checkIn",
"migratedFromTenantId": "cc45f885-c973-4e0e-8e0d-b63cf61a5091",
"historicalStatementsImportedAt": "2024-01-15T12:30:00.000+00:00",
"name": "string",
"slug": "string",
"statementAddress": {
"full": "string",
"line1": "string",
"line2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"stateCode": "string",
"countryCode": "string"
},
"billingAddress": {
"full": "string",
"line1": "string",
"line2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"stateCode": "string",
"countryCode": "string"
},
"phone": "string",
"email": "string",
"supportEmail": "string",
"taxId": "string",
"partner": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
},
"billingPartner": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
},
"companyName": "string",
"type": "partner",
"status": "active",
"billingSubscriptionStatus": "string",
"billingPlan": "string",
"billingPaymentMethodType": "string",
"billingCustomerId": "string",
"colorPrimary": "string",
"createdAt": "2024-01-15T12:30:00.000+00:00",
"updatedAt": "2024-01-15T12:30:00.000+00:00",
"trialUntil": "string",
"cancelledAt": "string",
"isOnboarding": true,
"issues": [
{
"code": "unassignedAccount",
"severity": "error",
"context": {
"accountIds": [
"string"
]
}
}
],
"isGeneralLedger": true,
"isOpex": true,
"booksClosedAt": "string",
"logo": "string",
"statementStartAt": "string",
"effectiveStatementStartAt": "string",
"settings": {
"showReservations": true,
"showCancelledReservations": true,
"showReservationTotal": true,
"showOwnerCalendarBlocking": true,
"showTaxStatements": true,
"showTwoFactorAuth": true
},
"ownerPortalShowDraftStatements": true,
"members": [
{
"userId": "string",
"email": "string",
"role": "string",
"name": "string",
"firstName": "string"
}
],
"extractableConnections": {
"property1": {
"connections": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"appId": "string",
"urlExample": "string",
"allowConfirmationCode": true
}
]
},
"property2": {
"connections": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"appId": "string",
"urlExample": "string",
"allowConfirmationCode": true
}
]
}
},
"enabledFeatures": [
{
"featureId": "317f79d2-08bf-4d22-9731-b2b5e1f0a085",
"status": "all"
}
]
}
],
"pagination": {
"limit": 100,
"page": 1,
"total": 0,
"totalPage": 0,
"nextPage": 0
}
}{
"code": "string",
"message": "string",
"issues": [
{
"message": "string"
}
],
"context": null
}{
"code": "string",
"message": "string",
"issues": [
{
"message": "string"
}
],
"context": null
}{
"code": "string",
"message": "string",
"issues": [
{
"message": "string"
}
],
"context": null
}{
"code": "string",
"message": "string",
"issues": [
{
"message": "string"
}
],
"context": null
}{
"code": "string",
"message": "string",
"issues": [
{
"message": "string"
}
],
"context": null
}