gigstack API

Get team onboarding URL and connection status

Develop Env

https://api.gigstack.io/v2

GET

/connect/teams/{id}/onboarding

Connect

Generates a new onboarding URL for the team and returns integration connection status

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.gigstack.io/v2/connect/teams//onboarding' \
--header 'Authorization;'

Response Example

200 - Example 1

{
    "data": {
        "onboardingUrl": "http://example.com",
        "connectionStatus": {
            "sat": {
                "completed": true,
                "status": "completed"
            },
            "stripe": {
                "completed": true,
                "status": "completed"
            },
            "setupComplete": true
        },
        "teamId": "string",
        "teamAlias": "string"
    },
    "message": "string",
    "next": "string",
    "totalResults": 0,
    "hasMore": true
}

Request

Authorization

API Key

Add parameter in header

Authorization

Example:

Authorization: ********************

Path Params

string

required

ID of the resource

Responses

🟢200OK

application/json

Onboarding URL and connection status retrieved successfully

Body

data

object

OnboardingResponse

optional

onboardingUrl

string <uri>

optional

URL for team onboarding

connectionStatus

object

optional

teamId

string

optional

teamAlias

string

optional

message

string

optional

string | null

optional

totalResults

integer

optional

hasMore

boolean

optional

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

Modified at 2025-06-16 03:36:47

Update team

Get team members