v1

latestOpenAPI 3.0.3Proprietaryraw.githubusercontent.com2026-03-067260437.0 KB
Teams

Get team

Retrieve a specific team by ID.

gigstack Connect: Access other teams using the team parameter.

get/teams/{id}

Path parameters

idstring required

Query parameters

teamstring

gigstack Connect: Target team ID for multi-team access.

Requires gigstack Connect enabled on your team and shared billing account.

Example: ?team=team_xyz789

Response

Team retrieved successfully

successboolean
messagestring
timestampstring date-time

Example response

{
  "success": true,
  "data": {
    "id": "team_1234567890",
    "legal_name": "Empresa de Tecnología S.A. de C.V.",
    "address": {
      "country": "MEX",
      "street": "Av. Insurgentes Sur 456",
      "zip": "03100",
      "city": "Ciudad de México",
      "state": "CDMX",
      "exterior": "96",
      "interior": "10",
      "neighborhood": "Polanco"
    },
    "brand": {
      "alias": "Mi Empresa",
      "primary_color": "#007bff",
      "secondary_color": "#6c757d",
      "logo": "https://example.com/logo.png"
    },
    "settings": {
      "avoid_automations_on_currencies": [
        "USD",
        "EUR"
      ],
      "default_description": "Default invoice description",
      "emails": {
        "invoices_bcc": [
          "accounting@example.com"
        ],
        "avoid_test_invoice_emails": true
      },
      "override_item_description": "Custom item description",
      "uses_on_self_invoice_portal": [
        "G03",
        "S01"
      ],
      "invoice_pdf_notes": "Additional notes for PDF",
      "product_key": "81112209",
      "unit_key": "E48",
      "use": "G03",
      "automate_complement_for_ppd_invoices": true,
      "customer_portal_id": "portal_1234567890",
      "periodicity": {
        "label": "Mes",
        "value": "month"
      },
      "default_series": {
        "income": {
          "serie": "A"
        },
        "complements": {
          "serie": "P"
        },
        "credit_note": {
          "serie": "NC"
        }
      }
    },
    "tax_id": "EMP800101ABC",
    "tax_system": "601",
    "support_email": "support@empresa.com",
    "support_phone": "+52 55 1234 5678",
    "owner": "user_1234567890",
    "created_at": 1677651234,
    "sat": {
      "completed": true,
      "connected_at": 1677651234,
      "csd_expires_at": 1924991999
    },
    "members": [
      {
        "id": "user_1234567890",
        "email": "member@empresa.com",
        "role": "admin"
      }
    ],
    "integrations": {
      "stripe": {
        "category": "payments"
      },
      "mercadopago": {
        "category": "payments"
      },
      "clip": {
        "category": "payments"
      },
      "whmcs": {
        "category": "payments"
      },
      "paypal": {
        "category": "payments"
      },
      "openpay": {
        "category": "payments"
      },
      "conekta": {
        "category": "payments"
      },
      "bank": {
        "category": "payments"
      },
      "shopify": {
        "category": "payments"
      },
      "zapier": {
        "category": "payments"
      },
      "airtable": {
        "category": "payments"
      },
      "google_sheets": {
        "category": "payments"
      },
      "hilos": {
        "category": "messaging"
      }
    },
    "credit_limit": 1000,
    "used_credits": 250,
    "credit_period_start": 1677651234000,
    "metadata": {
      "custom_field": "value"
    }
  },
  "message": "Team retrieved successfully",
  "timestamp": "2026-01-12T18:00:01.845Z"
}