Skip to main content
Gomobile home page
Search...
⌘K
Discord
Get API Key
Get API Key
Search...
Navigation
Flow
Get apiflows 1
Documentation
API Reference
Changelog
Help Center
Users
GET
Get current user profile with organization
Contacts
GET
Get all contacts for organization with pagination
POST
Create a new contact
GET
Get contact by ID with custom attributes
PUT
Update contact
DEL
Delete contact (soft delete)
POST
Bulk upsert contacts
Custom Attributes
GET
Get all custom attributes for organization
POST
Create custom attribute
GET
Get custom attribute by ID
PUT
Update custom attribute
DEL
Delete custom attribute
Call Flows
POST
Upload audio file
GET
List all audio files
GET
Stream audio file
PUT
Update audio metadata
DEL
Delete audio file
GET
Get audio metadata
GET
Get audio with relations
GET
Generate playback URL
GET
Get audios by usage type
Recordings
GET
List recordings
GET
Stream recording
DEL
Delete recording
GET
Download recording
GET
Get recording metadata
GET
List recordings by call
Dictionaries
GET
Get all dictionaries for the organization
POST
Create a dictionary for the organization
GET
Get a dictionary by ID
DEL
Delete a dictionary
GET
Get all entries for a dictionary
POST
Add an entry to a dictionary
GET
Get a dictionary entry by key
DEL
Remove an entry from a dictionary
Auth
POST
Post apiauthrefresh
POST
Post apiauthlogout
POST
Post apiauthlogout all
POST
Post apiauthsessions
POST
Post apiauthrevoke session
API Keys
GET
Get all API keys
POST
Create a new API key
GET
Get an API key by ID
PUT
Update an API key
DEL
Delete an API key
Audiences
GET
Get all audiences for organization with pagination
POST
Create a new audience
GET
Get audience by ID
PUT
Update audience
DEL
Delete audience
GET
Get contacts in audience
POST
Add contacts to audience
Credits
GET
Get credit balance for current organization
GET
Get credit transaction history for current organization
SMS
POST
Send a single SMS to a contact
Sender IDs
GET
Get sender IDs available to the current organization
SMS Programs
GET
Get all SMS programs for organization
POST
Create a new SMS program
GET
Get SMS program by ID
PUT
Update SMS program
DEL
Delete SMS program
POST
Launch SMS program
POST
Cancel SMS program
DIDs
GET
Get DIDs available to the current organization
Contact Ingestion
POST
Upload a CSV or Excel file for contact ingestion
POST
Validate uploaded data with column mappings
GET
Get paginated validation results
POST
Execute the contact import
Agent Studio
GET
List all agents
POST
Create a new agent
GET
Get agent by ID
DEL
Delete agent (soft delete)
PATCH
Update agent
POST
Activate agent
POST
Archive agent
POST
Restore archived agent
POST
Test agent (playground)
GET
List resolution criteria for an agent
POST
Add a resolution criterion to an agent
DEL
Delete a resolution criterion
PATCH
Update a resolution criterion
GET
Get resolution metrics for an agent
Agent Studio - Conversations
GET
List conversations for an agent
POST
Start a new conversation with an agent
GET
Get conversation details
GET
Get conversation messages
POST
Send a message to a conversation
POST
Send a message and stream the response (SSE)
POST
End a conversation
Knowledge Base
GET
List knowledge bases
POST
Create a new knowledge base
GET
Get knowledge base by ID
DEL
Delete knowledge base and all associated data
PATCH
Update knowledge base
GET
List documents in a knowledge base
POST
Upload a document to the knowledge base
GET
Get document details
DEL
Delete a document and its vectors
Flow
GET
Get apiflows
POST
Post apiflows
GET
Get apiflows 1
PUT
Put apiflows
DEL
Delete apiflows
GET
Get apiflowslatest
POST
Post apiflowsvalidate
POST
Post apiflowsexecute
Call Requests
POST
Request an ad-hoc call
DEL
Cancel a queued call
Programs
GET
List all programs for the organization
POST
Create a new program
GET
Get program details
DEL
Delete a program
PATCH
Update a program
POST
Launch a program execution
GET
List all executions for a program
GET
List contact triggers for a live program
Program Executions
GET
List all executions for the organization
GET
Get execution details
DEL
Cancel an execution
PATCH
Pause a running execution
PATCH
Resume a paused execution
CallReport
GET
Get apicall reportcall
GET
Get apicall report
ProgramReport
GET
Get apiprogram execution report
GET
Get apiprogram execution reportcalls
GET
Get apiprogram execution reportbreakdown
GET
Get apiprogram execution reportnode stats
GET
Get apiprogram execution reportbilling
GET
Get apiprogram execution reportconnect agent
GET
Get apiprogram execution reportexport
GET
Get apiprogram execution reportcallsexport
cURL
cURL
curl
--request
GET
\
--url
http://localhost:3000/api/flows/{flowId}
Flow
Get apiflows 1
GET
/
api
/
flows
/
{flowId}
Try it
cURL
cURL
curl
--request
GET
\
--url
http://localhost:3000/api/flows/{flowId}
Path Parameters
flowId
string
required
Response
200 - undefined
Post apiflows
Put apiflows
⌘I