List Locales

curl --request GET \
  --url https://api-{dc}.moengage.com/v5/locales \
  --header 'Authorization: Basic <encoded-value>'

{
  "response_id": "9f2c1b7a-4d3e-4a08-b5c6-1e7d02f43a91",
  "type": "locales",
  "data": [
    {
      "id": "65f1a2b3c4d5e6f7a8b9c0d1",
      "name": "es-MX",
      "custom_segment_id": "66041f7de3b1c24a9d5f8e02",
      "campaign_count": 12,
      "created_at": "2026-05-01T09:12:00Z",
      "updated_at": "2026-07-10T11:45:30Z"
    },
    {
      "id": "65f1a2b3c4d5e6f7a8b9c0d2",
      "name": "pt-BR",
      "custom_segment_id": "66041f7de3b1c24a9d5f8e03",
      "campaign_count": 4,
      "created_at": "2026-05-04T14:20:11Z",
      "updated_at": "2026-06-18T08:03:47Z"
    }
  ],
  "pagination": {
    "has_more": true,
    "next_cursor": "eyJsYXN0X2lkIjoiNjVmMWEyYjNjNGQ1ZTZmN2E4YjljMGQyIn0="
  }
}

{
  "error": {
    "code": "INVALID_REQUEST",
    "message": "Use either 'name' or 'id', not both.",
    "target": "id",
    "details": [
      {
        "code": "INVALID_PARAMETER_COMBINATION",
        "target": "id",
        "message": "The 'id' parameter cannot be combined with 'name'."
      }
    ]
  },
  "response_id": "9f2c1b7a-4d3e-4a08-b5c6-1e7d02f43a91"
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Missing or invalid authentication credentials.",
    "target": "Authorization"
  },
  "response_id": "9f2c1b7a-4d3e-4a08-b5c6-1e7d02f43a91"
}

{
  "error": {
    "code": "FORBIDDEN",
    "message": "This API key does not have the scope required to read locales.",
    "target": "Authorization"
  },
  "response_id": "9f2c1b7a-4d3e-4a08-b5c6-1e7d02f43a91"
}

{
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "Workspace rate limit exceeded. Retry after 30 seconds."
  },
  "response_id": "9f2c1b7a-4d3e-4a08-b5c6-1e7d02f43a91"
}

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "An unexpected error occurred while processing the request. Retry the request, and quote `response_id` if you contact MoEngage Support."
  },
  "response_id": "9f2c1b7a-4d3e-4a08-b5c6-1e7d02f43a91"
}

GET

locales

List Locales

curl --request GET \
  --url https://api-{dc}.moengage.com/v5/locales \
  --header 'Authorization: Basic <encoded-value>'

{
  "response_id": "9f2c1b7a-4d3e-4a08-b5c6-1e7d02f43a91",
  "type": "locales",
  "data": [
    {
      "id": "65f1a2b3c4d5e6f7a8b9c0d1",
      "name": "es-MX",
      "custom_segment_id": "66041f7de3b1c24a9d5f8e02",
      "campaign_count": 12,
      "created_at": "2026-05-01T09:12:00Z",
      "updated_at": "2026-07-10T11:45:30Z"
    },
    {
      "id": "65f1a2b3c4d5e6f7a8b9c0d2",
      "name": "pt-BR",
      "custom_segment_id": "66041f7de3b1c24a9d5f8e03",
      "campaign_count": 4,
      "created_at": "2026-05-04T14:20:11Z",
      "updated_at": "2026-06-18T08:03:47Z"
    }
  ],
  "pagination": {
    "has_more": true,
    "next_cursor": "eyJsYXN0X2lkIjoiNjVmMWEyYjNjNGQ1ZTZmN2E4YjljMGQyIn0="
  }
}

{
  "error": {
    "code": "INVALID_REQUEST",
    "message": "Use either 'name' or 'id', not both.",
    "target": "id",
    "details": [
      {
        "code": "INVALID_PARAMETER_COMBINATION",
        "target": "id",
        "message": "The 'id' parameter cannot be combined with 'name'."
      }
    ]
  },
  "response_id": "9f2c1b7a-4d3e-4a08-b5c6-1e7d02f43a91"
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Missing or invalid authentication credentials.",
    "target": "Authorization"
  },
  "response_id": "9f2c1b7a-4d3e-4a08-b5c6-1e7d02f43a91"
}

{
  "error": {
    "code": "FORBIDDEN",
    "message": "This API key does not have the scope required to read locales.",
    "target": "Authorization"
  },
  "response_id": "9f2c1b7a-4d3e-4a08-b5c6-1e7d02f43a91"
}

{
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "Workspace rate limit exceeded. Retry after 30 seconds."
  },
  "response_id": "9f2c1b7a-4d3e-4a08-b5c6-1e7d02f43a91"
}

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "An unexpected error occurred while processing the request. Retry the request, and quote `response_id` if you contact MoEngage Support."
  },
  "response_id": "9f2c1b7a-4d3e-4a08-b5c6-1e7d02f43a91"
}

Authorizations

Authorization

string

header

required

Authentication is done via Basic Auth. This requires a base64-encoded string of your credentials in the format username:password.

Username: Use your MoEngage Workspace ID (also known as the App ID). Find it in the MoEngage dashboard at Settings > Account > API keys.
Password: Use an API key from Settings > Account > API keys.

Refer to API Key Dashboard for details on creating and managing API keys.

Headers

X-MOE-Request-Id

string<uuid>

Client-supplied trace ID (UUID v4). Echoed back in the X-MOE-Request-Id response header and returned unchanged as response_id in the body. When you omit this header, MoEngage generates a 12-character hexadecimal identifier instead. Quote it when contacting MoEngage Support.

Query Parameters

name

string

Exact locale name. Use either name or id, not both.

string

Locale ID — a bare 24-character hexadecimal ObjectId, with no resource prefix. Pass it exactly as returned in data[].id. Use either name or id, not both.

limit

integer

default:20

Page size. Max 20 per page.

Required range: x <= 20

cursor

string

Opaque pagination cursor from a previous response.

Response

Locale list

response_id

string

Unique identifier for this response. Echoes the X-MOE-Request-Id header you sent, returned unchanged. When you omit it, MoEngage generates a 12-character hexadecimal identifier. Quote it when contacting MoEngage Support.

Example:

"9f2c1b7a-4d3e-4a08-b5c6-1e7d02f43a91"

type

enum<string>

The resource type contained in data. Always locales for this endpoint.

Available options:

locales

data

object[]

The locales matching your filters, up to limit per page.

Show child attributes

pagination

object

Cursor pagination state for this page of results.

Show child attributes