Sync API documentation

Jul 29, 2025

Change #ae5e8001

1.0.0

Breaking

Compare

23 structure changes including:

23 Modifications

Modified 23 Breaking

GET /v1/Services

Response
200 response Modified
- application/json content type Modified
  - services property Modified
    - reachability_debouncing_window property Modified
      - Type went from integer | null to integer
        Breaking
  - meta property Modified
    - next_page_url, previous_page_url properties Modified
      - Type went from string(uri) to string(uri) | null
Query
Page, PageToken query parameters Added

GET /v1/Services/{ServiceSid}/Documents

Response
200 response Modified
- application/json content type Modified
  - documents property Modified
    - data property Modified
      - Type is now object | null
  - meta property Modified
    - next_page_url, previous_page_url properties Modified
      - Type went from string(uri) to string(uri) | null
Query
Page, PageToken query parameters Added

GET /v1/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions

Response
200 response Modified
- application/json content type Modified
  - meta property Modified
    - next_page_url, previous_page_url properties Modified
      - Type went from string(uri) to string(uri) | null
Query
Page, PageToken query parameters Added

GET /v1/Services/{ServiceSid}/Documents/{Sid}

Response
200 response Modified
- application/json content type Modified
  - data property Modified
    - Type is now object | null

GET /v1/Services/{ServiceSid}/Lists

Response
200 response Modified
- application/json content type Modified
  - meta property Modified
    - next_page_url, previous_page_url properties Modified
      - Type went from string(uri) to string(uri) | null
Query
Page, PageToken query parameters Added

GET /v1/Services/{ServiceSid}/Lists/{ListSid}/Items

Response
200 response Modified
- application/json content type Modified
  - items property Modified
    - index property Modified
      - Type went from integer | null to integer
        Breaking
    - data property Modified
      - Type is now object | null
  - meta property Modified
    - next_page_url, previous_page_url properties Modified
      - Type went from string(uri) to string(uri) | null
Query
Page, PageToken query parameters Added

GET /v1/Services/{ServiceSid}/Lists/{ListSid}/Items/{Index}

Response
200 response Modified
- application/json content type Modified
  - index property Modified
    - Type went from integer | null to integer
      Breaking
  - data property Modified
    - Type is now object | null

GET /v1/Services/{ServiceSid}/Lists/{ListSid}/Permissions

Response
200 response Modified
- application/json content type Modified
  - meta property Modified
    - next_page_url, previous_page_url properties Modified
      - Type went from string(uri) to string(uri) | null
Query
Page, PageToken query parameters Added

GET /v1/Services/{ServiceSid}/Maps

Response
200 response Modified
- application/json content type Modified
  - meta property Modified
    - next_page_url, previous_page_url properties Modified
      - Type went from string(uri) to string(uri) | null
Query
Page, PageToken query parameters Added

GET /v1/Services/{ServiceSid}/Maps/{MapSid}/Items

Response
200 response Modified
- application/json content type Modified
  - items property Modified
    - data property Modified
      - Type is now object | null
  - meta property Modified
    - next_page_url, previous_page_url properties Modified
      - Type went from string(uri) to string(uri) | null
Query
Page, PageToken query parameters Added

GET /v1/Services/{ServiceSid}/Maps/{MapSid}/Items/{Key}

Response
200 response Modified
- application/json content type Modified
  - data property Modified
    - Type is now object | null

GET /v1/Services/{ServiceSid}/Maps/{MapSid}/Permissions

Response
200 response Modified
- application/json content type Modified
  - meta property Modified
    - next_page_url, previous_page_url properties Modified
      - Type went from string(uri) to string(uri) | null
Query
Page, PageToken query parameters Added

GET /v1/Services/{ServiceSid}/Streams

Response
200 response Modified
- application/json content type Modified
  - meta property Modified
    - next_page_url, previous_page_url properties Modified
      - Type went from string(uri) to string(uri) | null
Query
Page, PageToken query parameters Added

GET /v1/Services/{Sid}

Response
200 response Modified
- application/json content type Modified
  - reachability_debouncing_window property Modified
    - Type went from integer | null to integer
      Breaking

POST /v1/Services

Response
201 response Modified
- application/json content type Modified
  - reachability_debouncing_window property Modified
    - Type went from integer | null to integer
      Breaking

POST /v1/Services/{ServiceSid}/Documents

Response
201 response Modified
- application/json content type Modified
  - data property Modified
    - Type is now object | null

POST /v1/Services/{ServiceSid}/Documents/{Sid}

Response
200 response Modified
- application/json content type Modified
  - data property Modified
    - Type is now object | null

POST /v1/Services/{ServiceSid}/Lists/{ListSid}/Items

Response
201 response Modified
- application/json content type Modified
  - index property Modified
    - Type went from integer | null to integer
      Breaking
  - data property Modified
    - Type is now object | null

POST /v1/Services/{ServiceSid}/Lists/{ListSid}/Items/{Index}

Response
200 response Modified
- application/json content type Modified
  - index property Modified
    - Type went from integer | null to integer
      Breaking
  - data property Modified
    - Type is now object | null

POST /v1/Services/{ServiceSid}/Maps/{MapSid}/Items

Response
201 response Modified
- application/json content type Modified
  - data property Modified
    - Type is now object | null

POST /v1/Services/{ServiceSid}/Maps/{MapSid}/Items/{Key}

Response
200 response Modified
- application/json content type Modified
  - data property Modified
    - Type is now object | null

POST /v1/Services/{ServiceSid}/Streams/{StreamSid}/Messages

Response
201 response Modified
- application/json content type Modified
  - data property Modified
    - Type is now object | null

POST /v1/Services/{Sid}

Response
200 response Modified
- application/json content type Modified
  - reachability_debouncing_window property Modified
    - Type went from integer | null to integer
      Breaking

May 24, 2022

Change #1bc72ee4

1.29.1

Breaking

Compare

13 structure changes including:

13 Modifications

Modified 13 Breaking

GET /v1/Services/{ServiceSid}/Documents

Response
200 response Modified
- documents property Modified

GET /v1/Services/{ServiceSid}/Documents/{Sid}

Response
200 response Modified
- data property Modified

GET /v1/Services/{ServiceSid}/Lists/{ListSid}/Items

Response
200 response Modified
- items property Modified

GET /v1/Services/{ServiceSid}/Lists/{ListSid}/Items/{Index}

Response
200 response Modified
- data property Modified

GET /v1/Services/{ServiceSid}/Maps/{MapSid}/Items

Response
200 response Modified
- items property Modified

GET /v1/Services/{ServiceSid}/Maps/{MapSid}/Items/{Key}

Response
200 response Modified
- data property Modified

POST /v1/Services/{ServiceSid}/Documents

Body
content type Modified
- Data property Modified
Response
201 response Modified
- data property Modified

POST /v1/Services/{ServiceSid}/Documents/{Sid}

Body
content type Modified
- Data property Modified
Response
200 response Modified
- data property Modified

POST /v1/Services/{ServiceSid}/Lists/{ListSid}/Items

Body
content type Modified
- Data property Modified
Response
201 response Modified
- data property Modified

POST /v1/Services/{ServiceSid}/Lists/{ListSid}/Items/{Index}

Body
content type Modified
- Data property Modified
Response
200 response Modified
- data property Modified

POST /v1/Services/{ServiceSid}/Maps/{MapSid}/Items

Body
content type Modified
- Data property Modified
Response
201 response Modified
- data property Modified

POST /v1/Services/{ServiceSid}/Maps/{MapSid}/Items/{Key}

Body
content type Modified
- Data property Modified
Response
200 response Modified
- data property Modified

POST /v1/Services/{ServiceSid}/Streams/{StreamSid}/Messages

Body
content type Modified
- Data property Modified
Response
201 response Modified
- data property Modified

Apr 19, 2021

Change #35c88037

1.13.0

Compare

Do not miss any Sync API changes, ever again

Changelog

API structure has changed

API structure has changed

API documentation has been created