v1

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

Get client

Retrieve a specific client by ID.

gigstack Connect: Access other teams' clients using the team parameter.

get/clients/{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

Client retrieved successfully

messagestring

Example response

{
  "message": "Client retrieved successfully",
  "data": {
    "id": "client_1234567890",
    "address": {
      "country": "MEX",
      "street": "Av. Insurgentes Sur",
      "zip": "03100",
      "city": "Ciudad de México",
      "state": "CDMX",
      "exterior": "123",
      "interior": "4B",
      "municipality": "Benito Juárez",
      "neighborhood": "Del Valle"
    },
    "name": "Juan Pérez García",
    "company": "Empresa SA de CV",
    "phone": "+52 55 1234 5678",
    "email": "juan.perez@ejemplo.com",
    "bcc": [
      "admin@empresa.com"
    ],
    "metadata": {
      "custom_field": "value"
    },
    "is_valid": true,
    "from": "api",
    "legal_name": "Juan Pérez García",
    "livemode": true,
    "owner": "user_1234567890",
    "tax_id": "PEGJ800101ABC",
    "use": "P01",
    "tax_system": "601",
    "team": "team_1234567890",
    "created_at": 1677651234,
    "efos": {
      "is_valid": true
    },
    "defaults": {
      "issue_invoiceable_receipts": true
    }
  }
}