Sync from the server

GET

/api/v1/sync

const url = 'https://example.com/api/v1/sync?limit=50&include=all&include_own=false';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://example.com/api/v1/sync?limit=50&include=all&include_own=false' \
  --header 'Authorization: Bearer <token>'

Fetch actions taken since the specified last sync time

Authorizations

bearerAuth

Parameters

Query Parameters

since

string format: date-time

The most recent update timestamp to fetch data from

limit

number format: int64

default: 50

The number of results to include per page

include

string

default: all

Allowed values: all subscriptions

The entities to include in the response. Defaults to all

include_own

boolean

Whether to include updates made by the requesting device. Defaults to false

Responses

200

Sync requested successfully

application/json

object

results

required

Array<object>

An object containing action information

object

type

required

The type of entity targeted by an action

string

Allowed values: subscription

action

required

The action being taken on the target

string

action_id

required

A client-generated UUID identifier for the action

string format: uuid

occurred_at

required

The UTC timestamp of when the action was undertaken on the client

string format: date-time

data

required

Any of:

object

object

sync_id

The server-generated synchronization ID for the subscription

string format: uuid

guid

required

The guid field as found in the podcast’s RSS feed

string

feed_url

required

The canonical address of the podcast RSS feed

string format: url

subscribed_at

required

The UTC timestamp at which the user subscribed to the feed

string format: date-time

unsubscribed_at

The UTC timestamp at which the user unsubscribed from the feed

string format: date-time

Example

{
  "results": [
    {
      "type": "subscription",
      "data": {
        "sync_id": "4648b4d7-90bf-497c-a5e7-8383d1083d76",
        "guid": "677ea490-690e-51cb-8b43-755df6c55270",
        "feed_url": "https://example.com/feed1",
        "subscribed_at": "2026-07-11T15:30:00.1Z"
      }
    }
  ]
}

401

Access token is invalid

application/json

Generic error object

object

error

required

The error message

string

description

required

The error description

string

Example

{
  "error": "Unauthorized",
  "description": "The supplied access token is invalid"
}

500

Internal server error

application/json

Generic error object

object

error

required

The error message

string

description

required

The error description

string

Example

{
  "error": "Internal server error",
  "description": "The server encountered an error while processing the request"
}