REST API

The Recontent.app API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

Authentication

The Recontent.app API uses API keys to authenticate requests. You can view and manage your API keys in your workspace integrations settings.

API keys are sent for each request in an Authorization header. If your API key is 123456, each request must send the following header: Authorization: Bearer 123456.

Get workspace associated with API key

GEThttps://app.recontent.app/public/workspaces/me

Response

200

The workspace

Body

application/json

id*string

key*string

name*string

createdAt*string (date-time)

updatedAt*string (date-time)

Request

JavaScriptCurlPython

const response = await fetch('https://app.recontent.app/public/workspaces/me', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "id": "text",
  "key": "text",
  "name": "text",
  "createdAt": "2024-10-16T08:57:15.837Z",
  "updatedAt": "2024-10-16T08:57:15.837Z"
}

List languages by workspace or project

GEThttps://app.recontent.app/public/languages

Query parameters

Response

200

List of languages

Body

application/json

pagination*Pagination (object)

items*array of Language (object)

Request

JavaScriptCurlPython

const response = await fetch('https://app.recontent.app/public/languages', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "pagination": {},
  "items": [
    {
      "id": "text",
      "workspaceId": "text",
      "locale": "text",
      "name": "text",
      "createdAt": "2024-10-16T08:57:15.837Z",
      "updatedAt": "2024-10-16T08:57:15.837Z"
    }
  ]
}

List projects

GEThttps://app.recontent.app/public/projects

Query parameters

Response

200

List of projects

Body

application/json

pagination*Pagination (object)

items*array of Project (object)

Request

JavaScriptCurlPython

const response = await fetch('https://app.recontent.app/public/projects', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "pagination": {},
  "items": [
    {
      "id": "text",
      "workspaceId": "text",
      "name": "text",
      "description": "text",
      "masterRevisionId": "text",
      "createdAt": "2024-10-16T08:57:15.837Z",
      "updatedAt": "2024-10-16T08:57:15.837Z"
    }
  ]
}

Get project by ID

GEThttps://app.recontent.app/public/projects/{id}

Path parameters

id*string

Project ID

Response

200

The project

Body

application/json

id*string

workspaceId*string

name*string

description*nullable string

masterRevisionId*string

createdAt*string (date-time)

updatedAt*string (date-time)

Request

JavaScriptCurlPython

const response = await fetch('https://app.recontent.app/public/projects/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "id": "text",
  "workspaceId": "text",
  "name": "text",
  "description": "text",
  "masterRevisionId": "text",
  "createdAt": "2024-10-16T08:57:15.837Z",
  "updatedAt": "2024-10-16T08:57:15.837Z"
}

List phrases by revision

GEThttps://app.recontent.app/public/phrases

Query parameters

Response

200

List of phrases

Body

application/json

pagination*Pagination (object)

items*array of PhraseItem (object)

Request

JavaScriptCurlPython

const response = await fetch('https://app.recontent.app/public/phrases', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "pagination": {},
  "items": [
    {
      "id": "text",
      "key": "text",
      "revisionId": "text",
      "projectId": "text",
      "workspaceId": "text",
      "createdAt": "2024-10-16T08:57:15.837Z",
      "updatedAt": "2024-10-16T08:57:15.837Z"
    }
  ]
}

Get phrase by ID

GEThttps://app.recontent.app/public/phrases/{id}

Path parameters

id*string

Phrase ID

Response

200

The phrase

Body

application/json

id*string

key*string

revisionId*string

projectId*string

workspaceId*string

translations*array of object

createdAt*string (date-time)

updatedAt*string (date-time)

Request

JavaScriptCurlPython

const response = await fetch('https://app.recontent.app/public/phrases/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "id": "text",
  "key": "text",
  "revisionId": "text",
  "projectId": "text",
  "workspaceId": "text",
  "translations": [
    {
      "id": "text",
      "languageId": "text",
      "content": "text",
      "createdAt": "2024-10-16T08:57:15.837Z",
      "updatedAt": "2024-10-16T08:57:15.837Z"
    }
  ],
  "createdAt": "2024-10-16T08:57:15.837Z",
  "updatedAt": "2024-10-16T08:57:15.837Z"
}

Export phrases

POSThttps://app.recontent.app/public/phrase-exports

Body

application/json

revisionId*string

languageId*string

containsTagIdsarray of string

Response

200

Exported phrases

Body

application/json

language*object

data*object

Request

JavaScriptCurlPython

const response = await fetch('https://app.recontent.app/public/phrase-exports', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "revisionId": "text",
      "languageId": "text"
    }),
});
const data = await response.json();

Response

200

{
  "language": {
    "id": "text",
    "name": "text",
    "locale": "text"
  },
  "data": {
    "dashboard.title": "Welcome back!",
    "dashboard.description": "Visualize your payments & subscriptions"
  }
}

List possible locales

GEThttps://app.recontent.app/public/possible-locales

Response

200

List of possible locales

Body

application/json

items*array of object

Request

JavaScriptCurlPython

const response = await fetch('https://app.recontent.app/public/possible-locales', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "items": [
    {
      "key": "text",
      "label": "text"
    }
  ]
}

List email templates by project

GEThttps://app.recontent.app/public/email-templates

Query parameters

Response

200

List of email templates

Body

application/json

pagination*Pagination (object)

items*array of EmailTemplate (object)

Request

JavaScriptCurlPython

const response = await fetch('https://app.recontent.app/public/email-templates?projectId=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "pagination": {},
  "items": [
    {
      "id": "text",
      "projectId": "text",
      "workspaceId": "text",
      "key": "text",
      "description": "text",
      "createdAt": "2024-10-16T08:57:15.837Z",
      "updatedAt": "2024-10-16T08:57:15.837Z"
    }
  ]
}

Export email templates

POSThttps://app.recontent.app/public/email-template-exports

Body

application/json

id*string

languageIdsarray of string

format*enum

mjmlhtml

Response

200

Exported email template

Body

application/json

key*string

default*object

translations*array of object

Request

JavaScriptCurlPython

const response = await fetch('https://app.recontent.app/public/email-template-exports', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": "text",
      "format": "mjml"
    }),
});
const data = await response.json();

Response

200

{
  "key": "text",
  "default": {
    "content": "text"
  },
  "translations": [
    {
      "language": {
        "id": "text",
        "name": "text",
        "locale": "text"
      },
      "content": "text"
    }
  ]
}