List clients

GET

https://api.gigstack.io/v2/clients

Retrieve a paginated list of clients with powerful filtering capabilities.

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

Filtering Options:

Filter by creation date using comparison operators

Filter by metadata fields using dot or underscore notation (e.g., metadata.external_id or metadata_external_id)

Request

Authorization

API Key

Add parameter in header

Authorization

Example:

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

Query Params

Responses

🟢200OK

application/json

Clients retrieved successfully

Body

🟠401Unauthorized

🟠403Forbidden

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'https://api.gigstack.io/v2/clients?team&limit&next&order_by&sort&created[gte]=1733011200&created[lte]=1735689599&metadata.{key}&page' \
--header 'Authorization: <api-key>'

Response Example

200 - Success Example

{
    "message": "Clients retrieved successfully",
    "data": [
        {
            "id": "client_1234567890",
            "name": "Juan Pérez García",
            "email": "juan.perez@ejemplo.com",
            "tax_id": "PEGJ800101ABC",
            "tax_system": "601",
            "legal_name": "Juan Pérez García",
            "address": {
                "street": "Av. Insurgentes Sur 123",
                "zip": "03100",
                "city": "Ciudad de México",
                "state": "CDMX",
                "country": "MEX"
            },
            "is_valid": true,
            "livemode": true,
            "created_at": 1677651234,
            "team": "team_1234567890",
            "owner": "user_1234567890"
        }
    ],
    "has_more": false,
    "total_results": 1
}

Modified at 2026-01-23 18:33:49

Clients API Guide

Get client