Connect
Connect
Overview
Endpoints
POST /v2/connect/teams
Request Body
{
"name": "Development Team Alpha",
"description": "Main development team for Project Alpha",
"industry": "Technology",
"teamSize": "10-50",
"country": "MX",
"settings": {
"currency": "MXN",
"timezone": "America/Mexico_City",
"language": "es",
"fiscalYear": "calendar"
},
"onboarding": {
"completed": false,
"steps": [
"team_setup",
"payment_integration",
"client_setup",
"invoice_configuration"
]
},
"metadata": {
"parentOrganization": "org_123",
"department": "Engineering",
"costCenter": "DEV001"
}
}
Parameters
Parameter | Type | Required | Description |
---|---|---|---|
name | string | Yes | Team name |
description | string | No | Team description |
industry | string | No | Industry classification |
teamSize | string | No | Team size category |
country | string | No | Primary country (ISO code) |
settings | object | No | Team configuration settings |
onboarding | object | No | Onboarding process configuration |
metadata | object | No | Additional team information |
Response
{
"data": {
"id": "team_789",
"name": "Development Team Alpha",
"description": "Main development team for Project Alpha",
"industry": "Technology",
"teamSize": "10-50",
"country": "MX",
"status": "active",
"settings": {
"currency": "MXN",
"timezone": "America/Mexico_City",
"language": "es",
"fiscalYear": "calendar"
},
"onboarding": {
"completed": false,
"currentStep": "team_setup",
"progress": 0,
"steps": [
"team_setup",
"payment_integration",
"client_setup",
"invoice_configuration"
]
},
"metadata": {
"parentOrganization": "org_123",
"department": "Engineering",
"costCenter": "DEV001"
},
"createdAt": "2024-01-15T10:30:00.000Z",
"updatedAt": "2024-01-15T10:30:00.000Z"
},
"message": "Team created successfully"
}
GET /v2/connect/teams
Query Parameters
Parameter | Type | Description |
---|---|---|
limit | number | Number of results to return (default: 20, max: 100) |
offset | number | Number of results to skip |
status | string | Filter by team status |
industry | string | Filter by industry |
country | string | Filter by country |
onboarded | boolean | Filter by onboarding completion status |
Response
{
"data": [
{
"id": "team_789",
"name": "Development Team Alpha",
"description": "Main development team for Project Alpha",
"industry": "Technology",
"status": "active",
"country": "MX",
"onboarding": {
"completed": false,
"progress": 25
},
"createdAt": "2024-01-15T10:30:00.000Z"
}
],
"message": "Teams retrieved successfully",
"totalResults": 1,
"hasMore": false,
"next": null
}
GET /v2/connect/teams/{teamId}
PUT /v2/connect/teams/{teamId}
DELETE /v2/connect/teams/{teamId}
Onboarding Management
POST /v2/connect/teams/{teamId}/onboarding/complete-step
Request Body
{
"step": "payment_integration",
"data": {
"paymentProvider": "stripe",
"webhookUrl": "https://team.example.com/webhooks/gigstack",
"testMode": false
}
}
GET /v2/connect/teams/{teamId}/onboarding
Response
{
"data": {
"teamId": "team_789",
"completed": false,
"currentStep": "payment_integration",
"progress": 50,
"steps": [
{
"id": "team_setup",
"name": "Team Setup",
"completed": true,
"completedAt": "2024-01-15T10:30:00.000Z"
},
{
"id": "payment_integration",
"name": "Payment Integration",
"completed": false,
"required": true,
"description": "Set up payment processing for your team"
},
{
"id": "client_setup",
"name": "Client Setup",
"completed": false,
"required": false,
"description": "Add your first clients"
},
{
"id": "invoice_configuration",
"name": "Invoice Configuration",
"completed": false,
"required": true,
"description": "Configure invoice templates and settings"
}
]
},
"message": "Onboarding status retrieved successfully"
}
Team Member Management
POST /v2/connect/teams/{teamId}/members
Request Body
{
"email": "user@example.com",
"role": "admin",
"permissions": [
"payments.create",
"payments.read",
"invoices.create",
"invoices.read",
"clients.create",
"clients.read"
],
"inviteMessage": "Welcome to our team! You've been invited to join our GigStack workspace."
}
GET /v2/connect/teams/{teamId}/members
PUT /v2/connect/teams/{teamId}/members/{memberId}
DELETE /v2/connect/teams/{teamId}/members/{memberId}
Team Integrations
POST /v2/connect/teams/{teamId}/integrations
Request Body
{
"type": "webhook",
"name": "Team Payment Notifications",
"configuration": {
"url": "https://team.example.com/webhooks/payments",
"events": ["payment.completed", "invoice.paid"],
"secret": "team_webhook_secret"
},
"isActive": true
}
GET /v2/connect/teams/{teamId}/integrations
Code Examples
Create and Configure a Team
Manage Team Members
Set Up Team Integrations
Team Permissions System
Permission Levels
Role | Description | Default Permissions |
---|---|---|
owner | Full team control | All permissions |
admin | Administrative access | All except team deletion and billing |
manager | Team and resource management | Create/read/update resources, manage members |
developer | Development and integration | API access, webhook management, read resources |
user | Basic access | Read-only access to assigned resources |
Available Permissions
Permission | Description |
---|---|
team.read | View team information |
team.update | Update team settings |
team.delete | Delete team |
members.read | View team members |
members.invite | Invite team members |
members.remove | Remove team members |
payments.create | Create payments |
payments.read | View payments |
payments.update | Update payments |
invoices.create | Create invoices |
invoices.read | View invoices |
invoices.update | Update invoices |
clients.create | Create clients |
clients.read | View clients |
clients.update | Update clients |
integrations.read | View integrations |
integrations.create | Create integrations |
integrations.update | Update integrations |
White-Label Solutions
Custom Branding
Error Handling
Best Practices
1.
2.
3.
4.
5.
6.
Next Steps
Modified at 2025-06-11 05:01:26