Twilio

Twilio Studio v1

This is the public Twilio REST API.

Communication#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

This is the public Twilio REST API.

Endpoints 20

StudioV1Engagement

  • GETRetrieve a list of all Engagements for the Flow./v1/Flows/:FlowSid/Engagements?PageSize=1&Page=0&PageToken=stringRetrieve a list of all Engagements for the Flow.
  • POSTTriggers a new Engagement for the Flow/v1/Flows/:FlowSid/EngagementsTriggers a new Engagement for the Flow
  • GETRetrieve an Engagement/v1/Flows/:FlowSid/Engagements/:SidRetrieve an Engagement
  • DELETEDelete this Engagement and all Steps relating to it./v1/Flows/:FlowSid/Engagements/:SidDelete this Engagement and all Steps relating to it.

StudioV1EngagementContext

  • GETRetrieve the most recent context for an Engagement./v1/Flows/:FlowSid/Engagements/:EngagementSid/ContextRetrieve the most recent context for an Engagement.

StudioV1Execution

  • GETRetrieve a list of all Executions for the Flow./v1/Flows/:FlowSid/Executions?DateCreatedFrom=2024-01-01T00:00:00Z&DateCreatedTo=2024-01-01T00:00:00Z&PageSize=1&Page=0&PageToken=stringRetrieve a list of all Executions for the Flow.
  • POSTTriggers a new Execution for the Flow/v1/Flows/:FlowSid/ExecutionsTriggers a new Execution for the Flow
  • GETRetrieve an Execution/v1/Flows/:FlowSid/Executions/:SidRetrieve an Execution
  • POSTUpdate the status of an Execution to `ended`./v1/Flows/:FlowSid/Executions/:SidUpdate the status of an Execution to ended.
  • DELETEDelete the Execution and all Steps relating to it./v1/Flows/:FlowSid/Executions/:SidDelete the Execution and all Steps relating to it.

StudioV1ExecutionContext

  • GETRetrieve the most recent context for an Execution./v1/Flows/:FlowSid/Executions/:ExecutionSid/ContextRetrieve the most recent context for an Execution.

StudioV1ExecutionStep

  • GETRetrieve a list of all Steps for an Execution./v1/Flows/:FlowSid/Executions/:ExecutionSid/Steps?PageSize=1&Page=0&PageToken=stringRetrieve a list of all Steps for an Execution.
  • GETRetrieve a Step./v1/Flows/:FlowSid/Executions/:ExecutionSid/Steps/:SidRetrieve a Step.

StudioV1ExecutionStepContext

  • GETRetrieve the context for an Execution Step./v1/Flows/:FlowSid/Executions/:ExecutionSid/Steps/:StepSid/ContextRetrieve the context for an Execution Step.

StudioV1Flow

  • GETRetrieve a list of all Flows./v1/Flows?PageSize=1&Page=0&PageToken=stringRetrieve a list of all Flows.
  • GETRetrieve a specific Flow./v1/Flows/:SidRetrieve a specific Flow.
  • DELETEDelete a specific Flow./v1/Flows/:SidDelete a specific Flow.

StudioV1Step

  • GETRetrieve a list of all Steps for an Engagement./v1/Flows/:FlowSid/Engagements/:EngagementSid/Steps?PageSize=1&Page=0&PageToken=stringRetrieve a list of all Steps for an Engagement.
  • GETRetrieve a Step./v1/Flows/:FlowSid/Engagements/:EngagementSid/Steps/:SidRetrieve a Step.

StudioV1StepContext

  • GETRetrieve the context for an Engagement Step./v1/Flows/:FlowSid/Engagements/:EngagementSid/Steps/:StepSid/ContextRetrieve the context for an Engagement Step.

API details

Base URL
https://studio.twilio.com
Authentication
HTTP Basic authentication (username and password)
Operations
20 operations on 14 pathsGET 14POST 3DELETE 3
Main resources
StudioV1Execution 5StudioV1Engagement 4StudioV1Flow 3StudioV1ExecutionStep 2StudioV1Step 2StudioV1EngagementContext 1StudioV1ExecutionContext 1StudioV1ExecutionStepContext 1StudioV1StepContext 1
Response formats
application/json
Description format
OpenAPI 3.0.1, API version 1.0.0

How to test the Twilio Studio v1 in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Twilio Studio v1 collection, without the publisher's secrets.
  3. Add your credentialsThis API uses HTTP Basic authentication (username and password). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Retrieve a list of all Engagements for the Flow.” (GET /v1/Flows/:FlowSid/Engagements?PageSize=1&Page=0&PageToken=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Twilio Studio v1?

This is the public Twilio REST API. It is listed under Communication and has 20 endpoints.

Who publishes the Twilio Studio v1?

It is listed from Twilio's public API description (an OpenAPI document), not published by Twilio on Swastik Codes. Anyone who controls twilio.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Twilio Studio v1?

Requests go to https://studio.twilio.com. Endpoint paths are added to this base URL.

How do I authenticate with the Twilio Studio v1?

With HTTP Basic authentication (username and password).

How many endpoints does the Twilio Studio v1 have?

20 operations on 14 paths (14 GET, 3 POST, 3 DELETE). The largest groups are StudioV1Execution, StudioV1Engagement, StudioV1Flow, StudioV1ExecutionStep.

Is forking the Twilio Studio v1 free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.