List subprocessors

GET/workspaces/{workspace}/subprocessors

Returns your subprocessors in display order, drafts included, with how many people follow the list and your advance-notice period.

Authentication

Send an API token as a bearer token. This endpoint needs a read token, made by any member of the workspace. Create one in My account → API tokens; see scopes and roles.

Authorization: Bearer 42|bynh_pat_•••••••Header

Path parameters

workspacestringRequired
Your workspace slug, e.g. dokan.

Response

200 OK

Not paginated; meta {followers, notice_days}.

idintegerSubprocessor id.
catalog_keystring|nullCatalogue entry, if picked from it.
namestringCompany.
websitestring|nullhttps URL.
categoryenumCategory. One of hosting, network, payments, messaging, email, support, analytics, other.
purposestringWhat they do with the data.
data_categoriesenumData they handle. One of names, emails, phones, orders, payments, addresses, messages, usage.
countrystring|nullISO 3166-1 alpha-2.
country_namestring|nullCountry name.
logostring|nullCatalogue logo path.
certificationsarray<string>From the catalogue.
starts_onstring|nullYYYY-MM-DD.
ends_onstring|nullYYYY-MM-DD.
stateenumlive: on your trust center. One of draft, live.
upcomingbooleanLive with a future start date.
announced_atstring|nullWhen it first went live.
notified_countintegerFollowers notified when it went live.
dpa{id, filename, download_path}|nullSigned DPA, kept behind NDA.

Rate limits

This endpoint counts toward your general limit of 120 requests a minute. When you go over, wait for the number of seconds in Retry-After.

Errors

401The token is missing, wrong, revoked or expired.

404The token belongs to another workspace, or its owner is no longer a member.

Every error is JSON with a message. See Errors.

Next →Add a subprocessor

curl "https://api.bynh.io/api/v1/workspaces/dokan/subprocessors" \
  -H "Authorization: Bearer $BYNH_TOKEN" \
  -H "Accept: application/json"

Response200 OK

application/json

{
  "data": [
    {
      "id": 5,
      "catalog_key": "aws",
      "name": "Amazon Web Services",
      "website": "https://aws.amazon.com",
      "category": "hosting",
      "purpose": "Hosts the Dokan platform and its databases",
      "data_categories": [
        "names",
        "emails",
        "phones",
        "orders",
        "addresses"
      ],
      "country": "SA",
      "country_name": "Saudi Arabia",
      "logo": "/logos/aws.svg",
      "certifications": [
        "SOC 2",
        "ISO 27001"
      ],
      "starts_on": "2024-01-01",
      "ends_on": null,
      "state": "live",
      "upcoming": false,
      "announced_at": "2024-01-01T09:00:00+00:00",
      "notified_count": 0,
      "dpa": {
        "id": 430,
        "filename": "AWS DPA.pdf",
        "download_path": "/workspaces/dokan/documents/430/download"
      }
    }
  ],
  "meta": {
    "followers": 37,
    "notice_days": 30
  }
}

Examples use Dokan, a sample workspace. Responses are shortened where lists are long.