Flows

Call flow definitions and execution

List flows

get

https://api.gomobile.iohttps://staging-api.gomobile.iohttp://localhost:3000

/flows

Authorizations

BearerAuth

AuthorizationstringRequired

API key provided by GoMobile team. Request yours at https://docs.google.com/forms/d/1F6_7OIDNq8_lWgKPyP-DudF3dvBTl31X4dqVf5St2zE

Responses

200

List of flows

application/json

401

Unauthorized

get

/flows

HTTPcURLJavaScriptPython

GET /flows HTTP/1.1
Host: api.gomobile.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": "text",
    "organizationId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "version": 1,
    "metadata": {
      "tags": [
        "text"
      ],
      "category": "text",
      "author": "text",
      "version": "text"
    },
    "graph": {
      "nodes": [
        {
          "id": "text",
          "type": "dial",
          "label": "text",
          "description": "text",
          "config": {},
          "outputs": {}
        }
      ],
      "startNodeId": "text"
    },
    "variableSchema": {
      "ANY_ADDITIONAL_PROPERTY": {
        "type": "string",
        "required": true,
        "defaultValue": null,
        "description": "text"
      }
    },
    "createdAt": "2025-12-19T15:55:28.638Z",
    "updatedAt": "2025-12-19T15:55:28.638Z"
  }
]

Create flow

post

https://api.gomobile.iohttps://staging-api.gomobile.iohttp://localhost:3000

/flows

Authorizations

BearerAuth

AuthorizationstringRequired

API key provided by GoMobile team. Request yours at https://docs.google.com/forms/d/1F6_7OIDNq8_lWgKPyP-DudF3dvBTl31X4dqVf5St2zE

Body

application/json

namestringRequired

descriptionstringOptional

Responses

201

Flow created

application/json

400

Invalid flow definition

401

Unauthorized

post

/flows

HTTPcURLJavaScriptPython

POST /flows HTTP/1.1
Host: api.gomobile.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 366

{
  "name": "text",
  "description": "text",
  "graph": {
    "nodes": [
      {
        "id": "text",
        "type": "dial",
        "label": "text",
        "description": "text",
        "config": {},
        "outputs": {}
      }
    ],
    "startNodeId": "text"
  },
  "metadata": {
    "tags": [
      "text"
    ],
    "category": "text",
    "author": "text",
    "version": "text"
  },
  "variableSchema": {
    "ANY_ADDITIONAL_PROPERTY": {
      "type": "string",
      "required": true,
      "defaultValue": null,
      "description": "text"
    }
  }
}

{
  "id": "text",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "version": 1,
  "metadata": {
    "tags": [
      "text"
    ],
    "category": "text",
    "author": "text",
    "version": "text"
  },
  "graph": {
    "nodes": [
      {
        "id": "text",
        "type": "dial",
        "label": "text",
        "description": "text",
        "config": {},
        "outputs": {}
      }
    ],
    "startNodeId": "text"
  },
  "variableSchema": {
    "ANY_ADDITIONAL_PROPERTY": {
      "type": "string",
      "required": true,
      "defaultValue": null,
      "description": "text"
    }
  },
  "createdAt": "2025-12-19T15:55:28.638Z",
  "updatedAt": "2025-12-19T15:55:28.638Z"
}

Validate flow

post

https://api.gomobile.iohttps://staging-api.gomobile.iohttp://localhost:3000

/flows/validate

Validate a flow definition without saving.

Authorizations

BearerAuth

AuthorizationstringRequired

API key provided by GoMobile team. Request yours at https://docs.google.com/forms/d/1F6_7OIDNq8_lWgKPyP-DudF3dvBTl31X4dqVf5St2zE

Body

application/json

idstringOptional

organizationIdstring · uuidOptional

namestringOptional

descriptionstringOptional

versionintegerOptional

createdAtstring · date-timeOptional

updatedAtstring · date-timeOptional

Responses

200

Validation result

application/json

401

Unauthorized

post

/flows/validate

HTTPcURLJavaScriptPython

POST /flows/validate HTTP/1.1
Host: api.gomobile.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 524

{
  "id": "text",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "version": 1,
  "metadata": {
    "tags": [
      "text"
    ],
    "category": "text",
    "author": "text",
    "version": "text"
  },
  "graph": {
    "nodes": [
      {
        "id": "text",
        "type": "dial",
        "label": "text",
        "description": "text",
        "config": {},
        "outputs": {}
      }
    ],
    "startNodeId": "text"
  },
  "variableSchema": {
    "ANY_ADDITIONAL_PROPERTY": {
      "type": "string",
      "required": true,
      "defaultValue": null,
      "description": "text"
    }
  },
  "createdAt": "2025-12-19T15:55:28.638Z",
  "updatedAt": "2025-12-19T15:55:28.638Z"
}

{
  "valid": true,
  "errors": [
    {
      "field": "text",
      "message": "text",
      "code": "text"
    }
  ]
}

Execute flow

post

https://api.gomobile.iohttps://staging-api.gomobile.iohttp://localhost:3000

/flows/execute

Execute a flow (creates outbound call and runs flow).

Authorizations

BearerAuth

AuthorizationstringRequired

API key provided by GoMobile team. Request yours at https://docs.google.com/forms/d/1F6_7OIDNq8_lWgKPyP-DudF3dvBTl31X4dqVf5St2zE

Body

application/json

flowIdstringRequired

contactIdstringRequired

fromPhonestringRequired

initialVariablesobjectOptional

Responses

200

Flow execution result

application/json

400

Invalid request

401

Unauthorized

404

Flow or contact not found

post

/flows/execute

HTTPcURLJavaScriptPython

POST /flows/execute HTTP/1.1
Host: api.gomobile.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 77

{
  "flowId": "text",
  "contactId": "text",
  "fromPhone": "text",
  "initialVariables": {}
}

{
  "callId": "text",
  "flowId": "text",
  "outcome": "completed",
  "outcomeReason": "text",
  "finalVariables": {},
  "error": {
    "type": "text",
    "message": "text",
    "code": "text",
    "nodeId": "text",
    "stack": "text"
  },
  "sessionSnapshot": {
    "callId": "text",
    "status": "text",
    "direction": "text",
    "createdAt": "2025-12-19T15:55:28.638Z",
    "answeredAt": "2025-12-19T15:55:28.638Z",
    "terminatedAt": "2025-12-19T15:55:28.638Z",
    "durationMs": 1
  },
  "timing": {
    "startedAt": "2025-12-19T15:55:28.638Z",
    "completedAt": "2025-12-19T15:55:28.638Z",
    "durationMs": 1,
    "nodeExecutionCount": 1
  }
}

Get latest flow by name

get

https://api.gomobile.iohttps://staging-api.gomobile.iohttp://localhost:3000

/flows/latest/{name}

Authorizations

BearerAuth

AuthorizationstringRequired

API key provided by GoMobile team. Request yours at https://docs.google.com/forms/d/1F6_7OIDNq8_lWgKPyP-DudF3dvBTl31X4dqVf5St2zE

Path parameters

namestringRequired

Responses

200

Flow definition

application/json

401

Unauthorized

404

Flow not found

get

/flows/latest/{name}

HTTPcURLJavaScriptPython

GET /flows/latest/{name} HTTP/1.1
Host: api.gomobile.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "version": 1,
  "metadata": {
    "tags": [
      "text"
    ],
    "category": "text",
    "author": "text",
    "version": "text"
  },
  "graph": {
    "nodes": [
      {
        "id": "text",
        "type": "dial",
        "label": "text",
        "description": "text",
        "config": {},
        "outputs": {}
      }
    ],
    "startNodeId": "text"
  },
  "variableSchema": {
    "ANY_ADDITIONAL_PROPERTY": {
      "type": "string",
      "required": true,
      "defaultValue": null,
      "description": "text"
    }
  },
  "createdAt": "2025-12-19T15:55:28.638Z",
  "updatedAt": "2025-12-19T15:55:28.638Z"
}

Get flow by ID

get

https://api.gomobile.iohttps://staging-api.gomobile.iohttp://localhost:3000

/flows/{flowId}

Authorizations

BearerAuth

AuthorizationstringRequired

API key provided by GoMobile team. Request yours at https://docs.google.com/forms/d/1F6_7OIDNq8_lWgKPyP-DudF3dvBTl31X4dqVf5St2zE

Path parameters

flowIdstringRequired

Responses

200

Flow definition

application/json

401

Unauthorized

404

Flow not found

get

/flows/{flowId}

HTTPcURLJavaScriptPython

GET /flows/{flowId} HTTP/1.1
Host: api.gomobile.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "version": 1,
  "metadata": {
    "tags": [
      "text"
    ],
    "category": "text",
    "author": "text",
    "version": "text"
  },
  "graph": {
    "nodes": [
      {
        "id": "text",
        "type": "dial",
        "label": "text",
        "description": "text",
        "config": {},
        "outputs": {}
      }
    ],
    "startNodeId": "text"
  },
  "variableSchema": {
    "ANY_ADDITIONAL_PROPERTY": {
      "type": "string",
      "required": true,
      "defaultValue": null,
      "description": "text"
    }
  },
  "createdAt": "2025-12-19T15:55:28.638Z",
  "updatedAt": "2025-12-19T15:55:28.638Z"
}

Update flow

put

https://api.gomobile.iohttps://staging-api.gomobile.iohttp://localhost:3000

/flows/{flowId}

Authorizations

BearerAuth

AuthorizationstringRequired

API key provided by GoMobile team. Request yours at https://docs.google.com/forms/d/1F6_7OIDNq8_lWgKPyP-DudF3dvBTl31X4dqVf5St2zE

Path parameters

flowIdstringRequired

Body

application/json

namestringOptional

descriptionstringOptional

Responses

200

Flow updated

application/json

401

Unauthorized

404

Flow not found

put

/flows/{flowId}

HTTPcURLJavaScriptPython

PUT /flows/{flowId} HTTP/1.1
Host: api.gomobile.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 366

{
  "name": "text",
  "description": "text",
  "graph": {
    "nodes": [
      {
        "id": "text",
        "type": "dial",
        "label": "text",
        "description": "text",
        "config": {},
        "outputs": {}
      }
    ],
    "startNodeId": "text"
  },
  "metadata": {
    "tags": [
      "text"
    ],
    "category": "text",
    "author": "text",
    "version": "text"
  },
  "variableSchema": {
    "ANY_ADDITIONAL_PROPERTY": {
      "type": "string",
      "required": true,
      "defaultValue": null,
      "description": "text"
    }
  }
}

{
  "id": "text",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "version": 1,
  "metadata": {
    "tags": [
      "text"
    ],
    "category": "text",
    "author": "text",
    "version": "text"
  },
  "graph": {
    "nodes": [
      {
        "id": "text",
        "type": "dial",
        "label": "text",
        "description": "text",
        "config": {},
        "outputs": {}
      }
    ],
    "startNodeId": "text"
  },
  "variableSchema": {
    "ANY_ADDITIONAL_PROPERTY": {
      "type": "string",
      "required": true,
      "defaultValue": null,
      "description": "text"
    }
  },
  "createdAt": "2025-12-19T15:55:28.638Z",
  "updatedAt": "2025-12-19T15:55:28.638Z"
}

Delete flow (soft)

delete

https://api.gomobile.iohttps://staging-api.gomobile.iohttp://localhost:3000

/flows/{flowId}

Authorizations

BearerAuth

AuthorizationstringRequired

API key provided by GoMobile team. Request yours at https://docs.google.com/forms/d/1F6_7OIDNq8_lWgKPyP-DudF3dvBTl31X4dqVf5St2zE

Path parameters

flowIdstringRequired

Responses

204

Flow deleted

401

Unauthorized

404

Flow not found

delete

/flows/{flowId}

HTTPcURLJavaScriptPython

DELETE /flows/{flowId} HTTP/1.1
Host: api.gomobile.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Delete flow permanently (Staff)

delete

https://api.gomobile.iohttps://staging-api.gomobile.iohttp://localhost:3000

/flows/{flowId}/permanent

Authorizations

BearerAuth

AuthorizationstringRequired

API key provided by GoMobile team. Request yours at https://docs.google.com/forms/d/1F6_7OIDNq8_lWgKPyP-DudF3dvBTl31X4dqVf5St2zE

Path parameters

flowIdstringRequired

Responses

204

Flow permanently deleted

401

Unauthorized

403

Staff access required

404

Flow not found

delete

/flows/{flowId}/permanent

HTTPcURLJavaScriptPython

DELETE /flows/{flowId}/permanent HTTP/1.1
Host: api.gomobile.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content