Twilio

Twilio Sync 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 48

SyncV1Document

  • GETFetchDocument/v1/Services/:ServiceSid/Documents/:Sid
  • POSTUpdateDocument/v1/Services/:ServiceSid/Documents/:Sid
  • DELETEDeleteDocument/v1/Services/:ServiceSid/Documents/:Sid
  • GETListDocument/v1/Services/:ServiceSid/Documents?PageSize=1&Page=0&PageToken=string
  • POSTCreateDocument/v1/Services/:ServiceSid/Documents

SyncV1DocumentPermission

  • GETFetch a specific Sync Document Permission./v1/Services/:ServiceSid/Documents/:DocumentSid/Permissions/:IdentityFetch a specific Sync Document Permission.
  • POSTUpdate an identity's access to a specific Sync Document./v1/Services/:ServiceSid/Documents/:DocumentSid/Permissions/:IdentityUpdate an identity's access to a specific Sync Document.
  • DELETEDelete a specific Sync Document Permission./v1/Services/:ServiceSid/Documents/:DocumentSid/Permissions/:IdentityDelete a specific Sync Document Permission.
  • GETRetrieve a list of all Permissions applying to a Sync Document./v1/Services/:ServiceSid/Documents/:DocumentSid/Permissions?PageSize=1&Page=0&PageToken=stringRetrieve a list of all Permissions applying to a Sync Document.

SyncV1Service

  • GETFetchService/v1/Services/:Sid
  • POSTUpdateService/v1/Services/:Sid
  • DELETEDeleteService/v1/Services/:Sid
  • GETListService/v1/Services?PageSize=1&Page=0&PageToken=string
  • POSTCreateService/v1/Services

SyncV1StreamMessage

  • POSTCreate a new Stream Message./v1/Services/:ServiceSid/Streams/:StreamSid/MessagesCreate a new Stream Message.

SyncV1SyncList

  • GETFetchSyncList/v1/Services/:ServiceSid/Lists/:Sid
  • POSTUpdateSyncList/v1/Services/:ServiceSid/Lists/:Sid
  • DELETEDeleteSyncList/v1/Services/:ServiceSid/Lists/:Sid
  • GETListSyncList/v1/Services/:ServiceSid/Lists?PageSize=1&Page=0&PageToken=string
  • POSTCreateSyncList/v1/Services/:ServiceSid/Lists

SyncV1SyncListItem

  • GETFetchSyncListItem/v1/Services/:ServiceSid/Lists/:ListSid/Items/:Index
  • POSTUpdateSyncListItem/v1/Services/:ServiceSid/Lists/:ListSid/Items/:Index
  • DELETEDeleteSyncListItem/v1/Services/:ServiceSid/Lists/:ListSid/Items/:Index
  • GETListSyncListItem/v1/Services/:ServiceSid/Lists/:ListSid/Items?Order=asc&From=from&Bounds=inclusive&PageSize=1&Page=0&PageToken=string
  • POSTCreateSyncListItem/v1/Services/:ServiceSid/Lists/:ListSid/Items

SyncV1SyncListPermission

  • GETFetch a specific Sync List Permission./v1/Services/:ServiceSid/Lists/:ListSid/Permissions/:IdentityFetch a specific Sync List Permission.
  • POSTUpdate an identity's access to a specific Sync List./v1/Services/:ServiceSid/Lists/:ListSid/Permissions/:IdentityUpdate an identity's access to a specific Sync List.
  • DELETEDelete a specific Sync List Permission./v1/Services/:ServiceSid/Lists/:ListSid/Permissions/:IdentityDelete a specific Sync List Permission.
  • GETRetrieve a list of all Permissions applying to a Sync List./v1/Services/:ServiceSid/Lists/:ListSid/Permissions?PageSize=1&Page=0&PageToken=stringRetrieve a list of all Permissions applying to a Sync List.

SyncV1SyncMap

  • GETFetchSyncMap/v1/Services/:ServiceSid/Maps/:Sid
  • POSTUpdateSyncMap/v1/Services/:ServiceSid/Maps/:Sid
  • DELETEDeleteSyncMap/v1/Services/:ServiceSid/Maps/:Sid
  • GETListSyncMap/v1/Services/:ServiceSid/Maps?PageSize=1&Page=0&PageToken=string
  • POSTCreateSyncMap/v1/Services/:ServiceSid/Maps

SyncV1SyncMapItem

  • GETFetchSyncMapItem/v1/Services/:ServiceSid/Maps/:MapSid/Items/:Key
  • POSTUpdateSyncMapItem/v1/Services/:ServiceSid/Maps/:MapSid/Items/:Key
  • DELETEDeleteSyncMapItem/v1/Services/:ServiceSid/Maps/:MapSid/Items/:Key
  • GETListSyncMapItem/v1/Services/:ServiceSid/Maps/:MapSid/Items?Order=asc&From=from&Bounds=inclusive&PageSize=1&Page=0&PageToken=string
  • POSTCreateSyncMapItem/v1/Services/:ServiceSid/Maps/:MapSid/Items

SyncV1SyncMapPermission

  • GETFetch a specific Sync Map Permission./v1/Services/:ServiceSid/Maps/:MapSid/Permissions/:IdentityFetch a specific Sync Map Permission.
  • POSTUpdate an identity's access to a specific Sync Map./v1/Services/:ServiceSid/Maps/:MapSid/Permissions/:IdentityUpdate an identity's access to a specific Sync Map.
  • DELETEDelete a specific Sync Map Permission./v1/Services/:ServiceSid/Maps/:MapSid/Permissions/:IdentityDelete a specific Sync Map Permission.
  • GETRetrieve a list of all Permissions applying to a Sync Map./v1/Services/:ServiceSid/Maps/:MapSid/Permissions?PageSize=1&Page=0&PageToken=stringRetrieve a list of all Permissions applying to a Sync Map.

SyncV1SyncStream

  • GETFetch a specific Stream./v1/Services/:ServiceSid/Streams/:SidFetch a specific Stream.
  • POSTUpdate a specific Stream./v1/Services/:ServiceSid/Streams/:SidUpdate a specific Stream.
  • DELETEDelete a specific Stream./v1/Services/:ServiceSid/Streams/:SidDelete a specific Stream.
  • GETRetrieve a list of all Streams in a Service Instance./v1/Services/:ServiceSid/Streams?PageSize=1&Page=0&PageToken=stringRetrieve a list of all Streams in a Service Instance.
  • POSTCreate a new Stream./v1/Services/:ServiceSid/StreamsCreate a new Stream.

API details

Base URL
https://sync.twilio.com
Authentication
HTTP Basic authentication (username and password)
Operations
48 operations on 21 pathsGET 20POST 18DELETE 10
Main resources
SyncV1Document 5SyncV1Service 5SyncV1SyncList 5SyncV1SyncListItem 5SyncV1SyncMap 5SyncV1SyncMapItem 5SyncV1SyncStream 5SyncV1DocumentPermission 4SyncV1SyncListPermission 4SyncV1SyncMapPermission 4
Response formats
application/json
Description format
OpenAPI 3.0.1, API version 1.0.0

How to test the Twilio Sync 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 Sync 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 “FetchDocument” (GET /v1/Services/:ServiceSid/Documents/:Sid), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Twilio Sync v1?

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

Who publishes the Twilio Sync 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 Sync v1?

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

How do I authenticate with the Twilio Sync v1?

With HTTP Basic authentication (username and password).

How many endpoints does the Twilio Sync v1 have?

48 operations on 21 paths (20 GET, 18 POST, 10 DELETE). The largest groups are SyncV1Document, SyncV1Service, SyncV1SyncList, SyncV1SyncListItem.

Is forking the Twilio Sync 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.