Skip to main content
GET
/
api
/
v1
/
teams
/
{team_id}
/
onboarding
Get Onboarding
curl --request GET \
  --url https://api.example.com/api/v1/teams/{team_id}/onboarding \
  --header 'Authorization: Bearer <token>'
{
  "step": "<string>",
  "connections": [
    {
      "provider": "<string>",
      "label": "<string>",
      "required": false,
      "type": "oauth",
      "connected": false,
      "fields": [
        {
          "key": "<string>",
          "label": "<string>",
          "type": "text",
          "placeholder": "",
          "help": "",
          "default": ""
        }
      ]
    }
  ],
  "cycle_configured": false,
  "loops_configured": false,
  "lifecycle_type": "cyclical",
  "requires_brand": "optional",
  "chat_enabled": true,
  "cycle_start_mode": "<string>",
  "trigger_types": [
    "<string>"
  ],
  "trigger_mode": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
team_id
string<uuid>
required

Response

Successful Response

​
step
string
required
​
connections
ConnectionRequirement · object[]
​
cycle_configured
boolean
default:false
​
loops_configured
boolean
default:false
​
lifecycle_type
string
default:cyclical
​
requires_brand
string
default:optional
​
chat_enabled
boolean
default:true
​
cycle_start_mode
string | null
​
trigger_types
string[]
​
trigger_mode
string | null