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

get

/workspaces/me

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://app.recontent.app/public/workspaces/me' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

{
  "id": "text",
  "key": "text",
  "name": "text",
  "createdAt": "2025-02-22T08:28:56.642Z",
  "updatedAt": "2025-02-22T08:28:56.642Z"
}

The workspace

List languages by workspace or project

get

/languages

Authorizations

Query parameters

projectIdstring

Project ID

pageinteger

Page number

pageSizeinteger

Page size

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://app.recontent.app/public/languages' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

{
  "pagination": {
    "page": 1,
    "pageSize": 1,
    "pagesCount": 1,
    "itemsCount": 1
  },
  "items": [
    {
      "id": "text",
      "workspaceId": "text",
      "locale": "text",
      "name": "text",
      "createdAt": "2025-02-22T08:28:56.642Z",
      "updatedAt": "2025-02-22T08:28:56.642Z"
    }
  ]
}

List of languages

List projects

get

/projects

Authorizations

Query parameters

pageinteger

Page number

pageSizeinteger

Page size

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://app.recontent.app/public/projects' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

{
  "pagination": {
    "page": 1,
    "pageSize": 1,
    "pagesCount": 1,
    "itemsCount": 1
  },
  "items": [
    {
      "id": "text",
      "workspaceId": "text",
      "name": "text",
      "description": "text",
      "masterRevisionId": "text",
      "createdAt": "2025-02-22T08:28:56.642Z",
      "updatedAt": "2025-02-22T08:28:56.642Z"
    }
  ]
}

List of projects

Get project by ID

get

/projects/{id}

Authorizations

Path parameters

idstringrequired

Project ID

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://app.recontent.app/public/projects/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

{
  "id": "text",
  "workspaceId": "text",
  "name": "text",
  "description": "text",
  "masterRevisionId": "text",
  "createdAt": "2025-02-22T08:28:56.642Z",
  "updatedAt": "2025-02-22T08:28:56.642Z"
}

The project

List phrases by revision

get

/phrases

Authorizations

Query parameters

revisionIdstring

Revision ID

pageinteger

Page number

pageSizeinteger

Page size

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://app.recontent.app/public/phrases' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

{
  "pagination": {
    "page": 1,
    "pageSize": 1,
    "pagesCount": 1,
    "itemsCount": 1
  },
  "items": [
    {
      "id": "text",
      "key": "text",
      "revisionId": "text",
      "projectId": "text",
      "workspaceId": "text",
      "createdAt": "2025-02-22T08:28:56.642Z",
      "updatedAt": "2025-02-22T08:28:56.642Z"
    }
  ]
}

List of phrases

Get phrase by ID

get

/phrases/{id}

Authorizations

Path parameters

idstringrequired

Phrase ID

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://app.recontent.app/public/phrases/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

{
  "id": "text",
  "key": "text",
  "revisionId": "text",
  "projectId": "text",
  "workspaceId": "text",
  "createdAt": "2025-02-22T08:28:56.642Z",
  "updatedAt": "2025-02-22T08:28:56.642Z",
  "translations": [
    {
      "id": "text",
      "languageId": "text",
      "content": "text",
      "createdAt": "2025-02-22T08:28:56.642Z",
      "updatedAt": "2025-02-22T08:28:56.642Z"
    }
  ]
}

The phrase

Export phrases

post

/phrase-exports

Authorizations

Body

revisionIdstringrequired

languageIdstringrequired

containsTagIdsstring[]

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://app.recontent.app/public/phrase-exports' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"revisionId":"text","languageId":"text","containsTagIds":[null]}'

200

200

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

Exported phrases

List possible locales

get

/possible-locales

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://app.recontent.app/public/possible-locales' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

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

List of possible locales

List email templates by project

get

/email-templates

Authorizations

Query parameters

projectIdstringrequired

Project ID

pageinteger

Page number

pageSizeinteger

Page size

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://app.recontent.app/public/email-templates?projectId=text' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

{
  "pagination": {
    "page": 1,
    "pageSize": 1,
    "pagesCount": 1,
    "itemsCount": 1
  },
  "items": [
    {
      "id": "text",
      "projectId": "text",
      "workspaceId": "text",
      "key": "text",
      "description": "text",
      "createdAt": "2025-02-22T08:28:56.642Z",
      "updatedAt": "2025-02-22T08:28:56.642Z"
    }
  ]
}

List of email templates

Export email templates

post

/email-template-exports

Authorizations

Body

idstringrequired

formatstring · enumrequired

Options: mjml, html

languageIdsstring[]

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://app.recontent.app/public/email-template-exports' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"id":"text","format":"mjml","languageIds":[null]}'

200

200

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

Exported email template