API reference

GET /v1/ivr-flows · List IVR flows

Business accounts only. Read-only: flows are built and edited in the dashboard. Mainly for looking up a flow's id, which is what override_ivr_flow takes. Any member of the business can read them. An account that isn't in a business gets a 403 with code: "not_a_business".

Request

text
GET https://api.spoofey.com/v1/ivr-flows
Query param Notes
kind inbound or outbound. Anything else is a 400 with code: "invalid_kind".
name Only the flow with exactly this name (case and surrounding spaces ignored). Not a substring search.

Example

bash
curl https://api.spoofey.com/v1/ivr-flows?kind=outbound \
  -H "Authorization: Bearer sk_live_..."

Response

All of your business's flows, most recently edited first:

json
{ "data": [ {
  "id": "9e2f1a3b-...",
  "name": "Verification code",
  "kind": "outbound",
  "status": "published",
  "version": 3,
  "numbers": ["12025559999"],
  "created_at": 1789700000000,
  "updated_at": 1789800000000
} ] }

numbers are the numbers the flow is attached to: for an inbound flow, the numbers whose calls it answers; for an outbound flow, the numbers it runs on when you call from them. status is draft or published; only a published flow can run.

Errors

Errors come back as {"error":{"message":"...","code":"..."}}. See API errors and rate limits for every status code and the rate limit.

Was this helpful?Your answer helps us improve this page.
Still stuck?Ask Spoofey AI about your exact case, or a person on our team will reply by email.
Last modified on September 25, 2026 · 1 min read
Edit