Sign in
StudioV2Flow

Retrieve a specific Flow.

Retrieve a specific Flow.

get/v2/Flows/{Sid}

Path parameters

Sidstring required

The SID of the Flow resource to fetch.

Response

OK

sidstring nullable

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

account_sidstring nullable

The SID of the Account that created the Flow resource.

author_sidstring nullable

The SID of the User that created or last updated the Flow.

friendly_namestring nullable

The string that you assigned to describe the Flow.

{"stackTrail":"components:schemas:studio.v2.flow:properties:definition","oasType":"schema","type":"unknown","description":"JSON representation of flow definition.","nullable":true}
status'draft' | 'published'

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

revisioninteger

The latest revision number of the Flow's definition.

commit_messagestring nullable

Description of change made in the revision.

validboolean nullable

Boolean if the flow definition is valid.

date_createdstring date-time nullable

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

date_updatedstring date-time nullable

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

webhook_urlstring uri nullable
urlstring uri nullable

The absolute URL of the resource.

linksobject nullable

The URLs of the Flow's nested resources.

Changes

Changed in 5 of the 50 revisions of this API.63

  • v2cbcd359438901See the full diff
    • ○

      added the optional property author_sid to the response with the 200 status

      response-optional-property-added

  • v288ca5d3cb0bb3See the full diff
    • ▲

      the definition response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • ▲

      the errors/items/ response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • ▲

      the warnings/items/ response's property type/format changed from object/ to / for status 200

      response-property-type-changed

  • v2d6e7767d27a53See the full diff
    • ▲

      the definition response's property type/format changed from / to object/ for status 200

      response-property-type-changed

    • ▲

      the errors/items/ response's property type/format changed from / to object/ for status 200

      response-property-type-changed

    • ▲

      the warnings/items/ response's property type/format changed from / to object/ for status 200

      response-property-type-changed

  • v220f88e4a96ce1See the full diff
    • ○

      the revision response's property default value 0 was added for the status 200

      response-property-default-value-added

  • v2531843bd1ac81See the full diff
    • ○

      api tag StudioV2Flow added

      api-tag-added