Skip to content

Twilio - Sync API

by twilio.com

HTTP BasicHTTPSPhone
Open documentation ↗

Overview

This is the public Twilio REST API.

Twilio - Sync is a phone API from twilio.com. Requests are authenticated with HTTP Basic auth. It is served over HTTPS. Its OpenAPI description documents 48 endpoints.

At a glance

Authentication
HTTP Basic
HTTPS
Yes
CORS
Unknown
Category
Phone
Base URL
https://sync.twilio.com
Version
1.42.0
Endpoints
48
Spec updated
2023-04-20

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL
curl -X GET "https://sync.twilio.com/v1/Services" \
  -H "Accept: application/json" \
  -H "Authorization: Basic BASE64_USER_PASSWORD"
JavaScript
const response = await fetch("https://sync.twilio.com/v1/Services", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "Authorization": "Basic BASE64_USER_PASSWORD",
  },
});
const data = await response.json();
console.log(data);
Python
import requests

response = requests.request(
    "GET",
    "https://sync.twilio.com/v1/Services",
    headers={
    "Accept": "application/json",
    "Authorization": "Basic BASE64_USER_PASSWORD",
    },
    timeout=30,
)
print(response.json())

Endpoints

MethodPathWhat it does
GET/v1/ServicesListService
POST/v1/ServicesCreateService
GET/v1/Services/{ServiceSid}/DocumentsListDocument
POST/v1/Services/{ServiceSid}/DocumentsCreateDocument
GET/v1/Services/{ServiceSid}/Documents/{DocumentSid}/PermissionsRetrieve a list of all Permissions applying to a Sync Document.
GET/v1/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions/{Identity}Fetch a specific Sync Document Permission.
POST/v1/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions/{Identity}Update an identity's access to a specific Sync Document.
DELETE/v1/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions/{Identity}Delete a specific Sync Document Permission.
GET/v1/Services/{ServiceSid}/Documents/{Sid}FetchDocument
POST/v1/Services/{ServiceSid}/Documents/{Sid}UpdateDocument
DELETE/v1/Services/{ServiceSid}/Documents/{Sid}DeleteDocument
GET/v1/Services/{ServiceSid}/ListsListSyncList
POST/v1/Services/{ServiceSid}/ListsCreateSyncList
GET/v1/Services/{ServiceSid}/Lists/{ListSid}/ItemsListSyncListItem
POST/v1/Services/{ServiceSid}/Lists/{ListSid}/ItemsCreateSyncListItem
GET/v1/Services/{ServiceSid}/Lists/{ListSid}/Items/{Index}FetchSyncListItem
POST/v1/Services/{ServiceSid}/Lists/{ListSid}/Items/{Index}UpdateSyncListItem
DELETE/v1/Services/{ServiceSid}/Lists/{ListSid}/Items/{Index}DeleteSyncListItem
GET/v1/Services/{ServiceSid}/Lists/{ListSid}/PermissionsRetrieve a list of all Permissions applying to a Sync List.
GET/v1/Services/{ServiceSid}/Lists/{ListSid}/Permissions/{Identity}Fetch a specific Sync List Permission.
POST/v1/Services/{ServiceSid}/Lists/{ListSid}/Permissions/{Identity}Update an identity's access to a specific Sync List.
DELETE/v1/Services/{ServiceSid}/Lists/{ListSid}/Permissions/{Identity}Delete a specific Sync List Permission.
GET/v1/Services/{ServiceSid}/Lists/{Sid}FetchSyncList
POST/v1/Services/{ServiceSid}/Lists/{Sid}UpdateSyncList
DELETE/v1/Services/{ServiceSid}/Lists/{Sid}DeleteSyncList
GET/v1/Services/{ServiceSid}/MapsListSyncMap
POST/v1/Services/{ServiceSid}/MapsCreateSyncMap
GET/v1/Services/{ServiceSid}/Maps/{MapSid}/ItemsListSyncMapItem
POST/v1/Services/{ServiceSid}/Maps/{MapSid}/ItemsCreateSyncMapItem
GET/v1/Services/{ServiceSid}/Maps/{MapSid}/Items/{Key}FetchSyncMapItem
POST/v1/Services/{ServiceSid}/Maps/{MapSid}/Items/{Key}UpdateSyncMapItem
DELETE/v1/Services/{ServiceSid}/Maps/{MapSid}/Items/{Key}DeleteSyncMapItem
GET/v1/Services/{ServiceSid}/Maps/{MapSid}/PermissionsRetrieve a list of all Permissions applying to a Sync Map.
GET/v1/Services/{ServiceSid}/Maps/{MapSid}/Permissions/{Identity}Fetch a specific Sync Map Permission.
POST/v1/Services/{ServiceSid}/Maps/{MapSid}/Permissions/{Identity}Update an identity's access to a specific Sync Map.
DELETE/v1/Services/{ServiceSid}/Maps/{MapSid}/Permissions/{Identity}Delete a specific Sync Map Permission.
GET/v1/Services/{ServiceSid}/Maps/{Sid}FetchSyncMap
POST/v1/Services/{ServiceSid}/Maps/{Sid}UpdateSyncMap
DELETE/v1/Services/{ServiceSid}/Maps/{Sid}DeleteSyncMap
GET/v1/Services/{ServiceSid}/StreamsRetrieve a list of all Streams in a Service Instance.
POST/v1/Services/{ServiceSid}/StreamsCreate a new Stream.
GET/v1/Services/{ServiceSid}/Streams/{Sid}Fetch a specific Stream.
POST/v1/Services/{ServiceSid}/Streams/{Sid}Update a specific Stream.
DELETE/v1/Services/{ServiceSid}/Streams/{Sid}Delete a specific Stream.
POST/v1/Services/{ServiceSid}/Streams/{StreamSid}/MessagesCreate a new Stream Message.
GET/v1/Services/{Sid}FetchService
POST/v1/Services/{Sid}UpdateService
DELETE/v1/Services/{Sid}DeleteService

Questions

Does the Twilio - Sync API need an API key?

Yes. The Twilio - Sync API uses HTTP Basic authentication; the documentation explains how to get credentials.

Does the Twilio - Sync API support HTTPS?

Yes, the Twilio - Sync API is served over HTTPS.

How many endpoints does the Twilio - Sync API have?

Its OpenAPI description lists 48 endpoints in version 1.42.0. All of them are shown on this page.

What are alternatives to the Twilio - Sync API?

Other Phone APIs include Twilio - Accounts, ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management, Twilio - Api, Mobility API, Telnyx API.

Compare alternatives →

Listed from APIs.guru (CC0).