Version
GET

Read the latest export

/v1/me/export in the Me API.

curl https://api.subscriby.net/v1/me/export -H "Authorization: Bearer $SUBSCRIBY_TOKEN"

The caller's most recent export, whatever its state; 404 RESOURCE_NOT_FOUND when none was ever requested. Poll it after a POST until status is ready, then download the zip from download_url, a signed link that works until download_url_expires_at; every read of a ready export mints a fresh link. The archive itself is removed at expires_at, after which status reads expired and a new export must be requested.

  • status is queued, building, ready, failed or expired; only ready carries download_url.
  • reason is manual for a request from Settings or this endpoint, deletion for the archive a scheduled account deletion builds on its own.
GET
/v1/me/export

Requires ability

The token must hold this ability, or the call is refused with 403.

Runs the same action from an agent, behind the same ability.

Authorization

bearerToken
AuthorizationBearer <token>

A personal access token minted on the dashboard under Settings, then Tokens, sent as Authorization: Bearer sbt_live_…. The token carries the abilities each endpoint lists under Requires ability and is frozen to one team.

In: header

Responses

200OK

The export.

401Unauthorized

The request carries no bearer token, or one that is revoked, malformed, or minted for another environment (an sbt_test_ token on production).

403Forbidden

The token is valid but does not carry the ability this endpoint requires; error.context.required_ability names the one to grant. An endpoint that also checks who owns a row or which tier the account is on answers FORBIDDEN, TEAM_TIER_REQUIRED or CONNECTOR_TIER_REQUIRED with the same status, and says so in its own description.

429Too many requests

The token has spent its 300 requests a minute or 10,000 an hour; Retry-After says when the next one is accepted.

How is this guide?

Last updated on