Publishing

List a blog category’s locales

The locales this document exists in.

Access: an API key with content:blog-categories:read (or a master above it: content:blog-categories:all, content:all, admin:all) reads the published documents; drafts (a draft _id) need content:blog-categories:write (or a master above it). A signed-in person reads as far as their own permissions allow, and anyone else reads the published documents’ public fields.

Rate limit: the key’s own reads-per-minute limit, set when the key is created (default 600); over it, 429 with Retry-After.

GET

blog-category

{_id}

locales

cURL

curl --request GET \
  --url https://{host}/api/v1/blog-category/{_id}/locales \
  --header 'Authorization: <api-key>'

import { createSiteClient } from '@fetchski/attract-cms-sdk';

const site = createSiteClient();
const documentLocales = await site.blogCategories().getBlogCategoryLocales({ id: 'clx8m2k4p0000a1b2c3d4e5f6' });

{
  "results": [
    {}
  ]
}

{
  "name": "<string>",
  "message": "<string>",
  "data": {}
}

{
  "name": "<string>",
  "message": "<string>",
  "data": {}
}

{
  "name": "<string>",
  "message": "<string>",
  "data": {}
}

{
  "name": "<string>",
  "message": "<string>",
  "data": {}
}

{
  "name": "<string>",
  "message": "<string>",
  "data": {}
}

Authorizations

Authorization

string

header

required

Paste your API key as the CMS showed it: fsk_<site>_<key id>_<secret> (issued under API Keys). ApiKey in front of it works too. Leave it empty to read as the public.

Scopes

content:blog-categories:read

Path Parameters

_id

string

required

The document’s _id: a full id names its own locale and mode (the draft’s …:en:draft, the published one’s …:en:published; no aposMode needed), a bare aposDocId takes the request’s (aposLocale, aposMode).

Response

Its locales.

The locales the document exists in.

results

object[]

required

One entry per locale the document exists in.

cURL

curl --request GET \
  --url https://{host}/api/v1/blog-category/{_id}/locales \
  --header 'Authorization: <api-key>'

import { createSiteClient } from '@fetchski/attract-cms-sdk';

const site = createSiteClient();
const documentLocales = await site.blogCategories().getBlogCategoryLocales({ id: 'clx8m2k4p0000a1b2c3d4e5f6' });

{
  "results": [
    {}
  ]
}

{
  "name": "<string>",
  "message": "<string>",
  "data": {}
}

{
  "name": "<string>",
  "message": "<string>",
  "data": {}
}

{
  "name": "<string>",
  "message": "<string>",
  "data": {}
}

{
  "name": "<string>",
  "message": "<string>",
  "data": {}
}

{
  "name": "<string>",
  "message": "<string>",
  "data": {}
}

Get started

How the API works

Pages & Site

Content

Media

Forms

Ads & Conversions

Analytics

Signing in (people)

List a blog category’s locales

Authorizations

Scopes

Path Parameters

Response