Skip to main content
GET
/
api
/
v1
/
content
/
brands
/
{brandId}
/
slugs
/
{slug}
cURL
curl --request GET \
  --url https://app.getbrandkarma.com/api/v1/content/brands/{brandId}/slugs/{slug}
{
  "id": "<string>",
  "title": "<string>",
  "slug": "<string>",
  "language": "<string>",
  "description": "<string>",
  "content": "<string>",
  "tags": [
    "<string>"
  ],
  "categoryId": "<string>",
  "category": "<string>",
  "publishedDate": "2023-11-07T05:31:56Z",
  "status": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "imageUrl": "<string>",
  "metaTitle": "<string>",
  "metaDescription": "<string>",
  "primaryKeyword": "<string>",
  "translationGroupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "isSourceLanguageDocument": true,
  "brief": "<string>",
  "internalTags": [
    "<string>"
  ],
  "keywordSearchVolume": 123,
  "keywordDifficulty": 123,
  "gscClicks": 123,
  "gscPosition": 123,
  "gscImpressions": 123
}

Path Parameters

brandId
string
required
slug
string
required

Response

OK

id
string
required

Unique identifier for the content item.

title
string
required

The display title of the content item.

slug
string
required

URL-friendly slug, unique per brand. Use this to build permalink URLs.

language
string
required

ISO 639-1 language code (e.g., "en", "de").

description
string
required

Short summary or excerpt of the content, suitable for meta descriptions or list views.

content
string
required

The full content body in HTML format.

tags
string[]
required

List of tags for filtering and grouping content.

categoryId
string
required

ID of the category this content belongs to.

category
string
required

Human-readable name of the category.

publishedDate
null | string<date-time>
required

Date the content was published. Null if not yet published.

status
string
required

Publication status: Draft, Published, or Archived.

createdAt
string<date-time>
required

Timestamp when the content was first created.

updatedAt
string<date-time>
required

Timestamp of the most recent update.

imageUrl
null | string
required

URL of the featured image, served from the BrandKarma CDN.

metaTitle
null | string
required

SEO meta title. Falls back to Title if not set.

metaDescription
null | string
required

SEO meta description. Falls back to Description if not set.

primaryKeyword
null | string
required

Primary target keyword for SEO tracking.

translationGroupId
string<uuid>
required

Groups translations of the same content together. All language variants share this ID.

isSourceLanguageDocument
boolean
required

True if this is the original language version; false if it's a translation.

brief
null | string
internalTags
null | string[]
keywordSearchVolume

Monthly search volume for the primary keyword (from SEO data provider).

keywordDifficulty

Keyword difficulty score (0-100) for the primary keyword.

gscClicks

Google Search Console clicks in the last reporting period.

gscPosition

Average Google Search Console position for this content.

gscImpressions

Google Search Console impressions in the last reporting period.