gigstack Connect API Guide

Access and manage resources across multiple teams within the same billing account. gigstack Connect enables authorized teams to work with resources from other teams seamlessly.

📋 Overview

gigstack Connect is a powerful feature that allows teams with special permissions to access and manage resources (clients, invoices, payments, etc.) across multiple teams that share the same billing account. This is ideal for franchises, multi-entity businesses, and service providers managing multiple client accounts.

🔑 Key Features

Multi-Team Access - Access resources across teams

Unified Management - Manage multiple teams from one API key

Billing Account Scope - Limited to teams in same billing account

Global Availability - Works on all 35+ API endpoints

Seamless Integration - Simple query parameter addition

Security Controls - Permission-based access

🚀 How It Works

Simply add the team query parameter to ANY endpoint to access another team's resources:

✅ Requirements

gigstack Connect Enabled - Your API key's team must have gigstack Connect enabled

Shared Billing - Target team must share the same billing account

Team Exists - Target team must be valid and active

Proper Permissions - Your role must allow the requested action

📚 Usage Examples

Accessing Clients Across Teams

Managing Invoices Across Teams

Processing Payments for Other Teams

Managing Services Across Teams

Team Settings Management

🎯 Use Cases

1. Franchise Management

Manage multiple franchise locations from a central account:

2. Multi-Entity Corporation

Handle invoicing for different business entities:

3. Accounting Service Provider

Manage multiple client companies:

4. Consolidated Operations

Perform bulk operations across teams:

🔒 Security & Permissions

Access Control

Only teams with gigstack Connect enabled can use this feature

Target teams must be in the same billing account

User permissions apply to cross-team operations

Audit logs track all cross-team actions

Permission Requirements

Action	Required Role
Read resources	Viewer or higher
Create resources	Member or higher
Update resources	Member or higher
Delete resources	Admin or higher
Manage team settings	Admin or higher

⚠️ Error Responses

Not a Master Team

{
    "message": "Unauthorized",
    "error": "Unauthorized, not a master team"
}

Solution: Your team needs gigstack Connect enabled. Contact support.

Team Not Found

{
    "message": "Team not found",
    "error": "The specified team does not exist"
}

Solution: Verify the team ID is correct and active.

No Matched Teams

{
    "message": "Unauthorized",
    "error": "Unauthorized, no matched teams"
}

Solution: Target team must share the same billing account.

Insufficient Permissions

{
    "message": "Access denied",
    "error": "Your role does not allow this action on the target team"
}

Solution: Your user role must allow the requested action.

💡 Best Practices

Cache Team IDs - Store frequently accessed team IDs

Batch Operations - Group operations by team for efficiency

Error Handling - Implement robust error handling for cross-team ops

Audit Trail - Log all cross-team operations

Permission Checks - Verify permissions before bulk operations

Rate Limiting - Be mindful of rate limits when accessing multiple teams

Consistent Naming - Use clear naming conventions for cross-team resources

📊 Performance Considerations

Rate Limits

Standard rate limits apply per API key

Cross-team requests count toward your quota

Consider caching frequently accessed data

Optimization Tips

🔗 Complete Endpoint Support

gigstack Connect works with ALL endpoints:

Core Resources

✅ /clients - Client management

✅ /services - Service catalog

✅ /invoices/income - Invoice creation and management

✅ /payments - Payment processing

✅ /teams - Team configuration

✅ /users - User management

Additional Operations

✅ /clients/validate/{id} - Validate client fiscal info

✅ /clients/customerportal - Customer portal access

✅ /invoices/{id}/files - Invoice file retrieval

✅ /payments/{id}/paid - Mark payments as paid

✅ /payments/{id}/refund - Process refunds

✅ /teams/{id}/settings - Team settings management

✅ /teams/{id}/series - Invoice series configuration

✅ All other endpoints in the API

🚀 Getting Started

Step 1: Verify gigstack Connect Status

Step 2: List Available Teams

Step 3: Test Cross-Team Access

Step 4: Implement in Your Application

Need help with gigstack Connect? Check our support documentation or contact support@gigstack.io

gigstack Connect API Guide

📋 Overview#

🔑 Key Features#

🚀 How It Works#

✅ Requirements#

📚 Usage Examples#

Accessing Clients Across Teams#

Managing Invoices Across Teams#

Processing Payments for Other Teams#

Managing Services Across Teams#

Team Settings Management#

🎯 Use Cases#

1. Franchise Management#

2. Multi-Entity Corporation#

3. Accounting Service Provider#

4. Consolidated Operations#

🔒 Security & Permissions#

Access Control#

Permission Requirements#

⚠️ Error Responses#

Not a Master Team#

Team Not Found#

No Matched Teams#

Insufficient Permissions#

💡 Best Practices#

📊 Performance Considerations#

Rate Limits#

Optimization Tips#

🔗 Complete Endpoint Support#

Core Resources#

Additional Operations#

🚀 Getting Started#

Step 1: Verify gigstack Connect Status#

Step 2: List Available Teams#

Step 3: Test Cross-Team Access#

Step 4: Implement in Your Application#