Teams
/team/guides/onboarding
Get the current team's onboarding guide state
Required scope: team-onboarding:read
Authorization
apiKey X-API-Key<token>
API key provided in dashboard
In: header
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://api.vrplatform.app/team/guides/onboarding"{
"status": "skipped",
"welcome": {
"status": "skipped",
"updatedAt": "2024-01-15T12:30:00.000+00:00"
},
"connectPms": {
"status": "skipped",
"updatedAt": "2024-01-15T12:30:00.000+00:00"
},
"connectAiAgents": {
"status": "skipped",
"updatedAt": "2024-01-15T12:30:00.000+00:00"
},
"connectBankAccounts": {
"status": "skipped",
"updatedAt": "2024-01-15T12:30:00.000+00:00"
},
"connectRamp": {
"status": "skipped",
"updatedAt": "2024-01-15T12:30:00.000+00:00"
},
"connectPaymentProcessors": {
"status": "skipped",
"updatedAt": "2024-01-15T12:30:00.000+00:00"
},
"connectAirbnb": {
"status": "skipped",
"updatedAt": "2024-01-15T12:30:00.000+00:00"
},
"addOwners": {
"status": "skipped",
"updatedAt": "2024-01-15T12:30:00.000+00:00"
},
"reportingPreferences": {
"status": "skipped",
"updatedAt": "2024-01-15T12:30:00.000+00:00"
},
"feesAndCommissions": {
"status": "skipped",
"updatedAt": "2024-01-15T12:30:00.000+00:00"
},
"ownerStatementTemplate": {
"status": "skipped",
"updatedAt": "2024-01-15T12:30:00.000+00:00"
},
"openingBalances": {
"status": "skipped",
"updatedAt": "2024-01-15T12:30:00.000+00:00"
},
"addWorkflows": {
"status": "skipped",
"updatedAt": "2024-01-15T12:30:00.000+00:00"
},
"validateAndGoLive": {
"status": "skipped",
"updatedAt": "2024-01-15T12:30:00.000+00:00"
}
}{
"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
}