Retrieve a specific Flow.

GET /v2/Flows/{Sid}

Studio flows

Retrieve a specific Flow.

Path parameters

  • Sid string Required

    The SID of the Flow resource to fetch.

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^FW[0-9a-fA-F]{32}$.

Responses

  • 200 application/json

    OK

    Hide headers attributes Show headers attributes
    • Access-Control-Allow-Origin string

      Specify the origin(s) allowed to access the resource

    • Access-Control-Allow-Methods string

      Specify the HTTP methods allowed when accessing the resource

    • Access-Control-Allow-Headers string

      Specify the headers allowed when accessing the resource

    • Access-Control-Allow-Credentials boolean

      Indicates whether the browser should include credentials

    • Access-Control-Expose-Headers string

      Headers exposed to the client

    Hide response attributes Show response attributes object
    • sid string | null

      The unique string that we created to identify the Flow resource.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^FW[0-9a-fA-F]{32}$.

    • account_sid string | null

      The SID of the Account that created the Flow resource.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

    • friendly_name string | null

      The string that you assigned to describe the Flow.

    • definition

      JSON representation of flow definition.

    • status string

      The status of the Flow. Can be: draft or published.

      Values are draft or published.

    • revision integer

      The latest revision number of the Flow's definition.

      Default value is 0.

    • commit_message string | null

      Description of change made in the revision.

    • valid boolean | null

      Boolean if the flow definition is valid.

    • errors array | null

      List of error in the flow definition.

    • warnings array | null

      List of warnings in the flow definition.

    • date_created string(date-time) | null

      The date and time in GMT when the resource was created specified in ISO 8601 format.

    • date_updated string(date-time) | null

      The date and time in GMT when the resource was last updated specified in ISO 8601 format.

    • webhook_url string(uri) | null
    • url string(uri) | null

      The absolute URL of the resource.

GET /v2/Flows/{Sid}
curl \
 --request GET 'https://studio.twilio.com/v2/Flows/{Sid}' \
 --user "username:password"
Response examples (200)
{
  "sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "url": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "links": {
    "revisions": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Revisions",
    "executions": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions",
    "test_users": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TestUsers"
  },
  "valid": true,
  "errors": [],
  "status": "published",
  "revision": 1,
  "warnings": [],
  "definition": {
    "initial_state": "Trigger"
  },
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "webhook_url": "http://webhooks.twilio.com/v1/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "date_created": "2017-11-06T12:00:00Z",
  "date_updated": null,
  "friendly_name": "Test Flow",
  "commit_message": "commit"
}