Skip to main content
GET
Search SAT unit keys

Authorizations

Authorization
string
header
required

Authentication Method: HTTP Bearer token.

The runtime requires the literal Bearer prefix — a bare token in the Authorization header is rejected with 401 unauthorized.

Header Format: Authorization: Bearer YOUR_API_KEY

Your API key is a JWT. Live keys operate on live data (livemode: true); test keys operate on isolated test data (livemode: false).

Get your key at: app.gigstack.pro/settings?tab=api

Errors: credential failures are answered by the authentication layer with a raw { "message": … } body, not the standardized envelope — 401 for a missing, malformed or expired token, 403 for a revoked key or a plan without API access. See the Unauthorized and AuthForbidden responses.

Query Parameters

team
string

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

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

Also requires the multipleIssuerAccounts feature on your plan. Requests targeting a team other than the one your API key belongs to return 403 without it.

Only API keys can use it: an OAuth access token sent with another team's id is rejected with 403 Team mismatch with OAuth token.

Optional — omit it entirely unless you are acting on another team. It deliberately carries no example value so generated snippets do not emit ?team=undefined; when the parameter is absent, the team is derived from your API key.

Example: ?team=team_xyz789

q
string
required

Search query text (primary parameter). Searches across relevant fields depending on the collection (e.g., client name, email, payment ID, description, metadata). The query parameter is also accepted as a backward-compatible alternative.

query
string

Alternative to q, kept for backward compatibility. If both are provided, q takes precedence.

limit
integer
default:10

Maximum number of items to return (default 10, max 100)

Required range: 1 <= x <= 100
page
integer
default:1

Page number for pagination (default 1)

Required range: x >= 1
fields
string[]

Comma-separated list of fields to include in the response

Response

Unit keys searched successfully

message
string
required
Example:

"Unit keys searched successfully"

data
object[]
required
found
integer
required

Total number of results found

Example:

4

page
integer
required

Current page number

Example:

1

per_page
integer
required

Number of results per page

Example:

10

success
boolean
required
Example:

true

timestamp
integer<int64>
required
Example:

1704067200000