Skip to main content
GET
Error

Authorizations

Authorization
string
header
required

Flowyte secret API key (Authorization: Bearer flowyte_sk_live_…). Scope-gated; is scoped to your organization — a key can never reach another tenant. The listed scopes in each operation's apiKey requirement are the scopes that key must hold. The tokenUrl is nominal: keys are minted in the dashboard.

Query Parameters

q
string

Filter by phone-number substring.

Filter by coarse consent tier. A comma-separated subset of none, conversational, express (compiled to a SQL IN); an unknown value is a 400. Omit for all tiers. The outbound-ready opted-in list is consent=conversational,express&optedOut=false.

Example:

"conversational,express"

optedOut
boolean

Tri-state org-wide opt-out (suppression) filter. Omit for all contacts; true = only opted-out (suppressed) numbers; false = only reachable (NOT suppressed) numbers. Combine with consent for the outbound-ready list (consent=conversational,express&optedOut=false).

Response

CSV of the org's SMS contacts + consent.

The response is of type string.