> ## Documentation Index > Fetch the complete documentation index at: https://docs.fetchski-attract.com/llms.txt > Use this file to discover all available pages before exploring further. # Get locale path and manage clipboard > Returns the path to a locale home-page or optional document and makes the clipboard available in the given locale. Used for cross-locale navigation. ## OpenAPI ````yaml /api-reference/openapi.yaml post /@apostrophecms/i18n/locale openapi: 3.1.0 info: title: Fetchski Attract CMS API description: >- Auto-generated OpenAPI spec for this Fetchski site instance. Authenticate machine-to-machine requests with an API key by sending the header `Authorization: ApiKey `. Keys are issued in the CMS (API Keys) and carry scopes that limit them to specific actions. Each key also has its own security policy, chosen when it is created: a signing mode (token only, signed writes, or every request signed with the key’s signing secret via `X-Fetchski-Timestamp` + `X-Fetchski-Signature`), an optional network allowlist, and reads/writes-per-minute limits (429 with `Retry-After` over them). Some routes require a signature from every key — see each route. version: 1.0.0 servers: - url: https://{host}/api/v1 description: 'Your site: set `host` to its host name.' variables: host: default: acme.example security: [] tags: - name: Authentication description: >- Sign in as a person to get a bearer token or a session cookie. Integrations use an API key instead: send `Authorization: ApiKey `. - name: SDK Packages description: >- The site’s own npm registry and Composer repository for the Attract SDKs, so an app installs them with one of the site’s API keys. Point npm, pnpm, Bun or Composer at them; the SDKs never call them. - name: Pages description: 'The page tree: each page’s content, place and URL.' - name: Global Content description: Site-wide content and settings every page shares. - name: Redirects description: Old URLs and where they now send visitors. - name: Internationalization description: The site’s locales. - name: Languages description: >- The site’s languages: the main language’s name and every further language’s name, code and Public switch. A save applies at once: a new language gets its home page and its own addresses (/fr/…), and its pages are then translated with each type’s localize routes. - name: Page Templates description: >- The site’s whole-page starting arrangements. They are not pages of the site (the Pages list leaves them out for API keys): read one, then make a page from it with Pages → create and `_copyingId` (`copyingId` in the SDKs). - name: Blog Posts description: The blog’s posts, and importing them from Markdown or MDX. - name: Blog Categories description: The categories posts are filed under. - name: Authors description: The people posts are credited to. - name: Team Members description: The people the Team section shows. - name: Testimonials description: Quotes from customers. - name: FAQ Items description: Questions and their answers. - name: FAQ Categories description: The groups questions are sorted into. - name: Google Reviews description: Reviews from the business’s Google profile, synced on a schedule. - name: Instagram Posts description: Posts from the connected Instagram account, synced on a schedule. - name: Service Areas description: The places the business serves, for the service map. - name: Cookies description: The cookies the consent banner declares. - name: Media description: The Images and Files libraries, and their tags. - name: Videos description: The Videos library. - name: Image Folders description: The folders that organize the Images library. - name: File Folders description: The folders that organize the Files library. - name: Video Folders description: The folders that organize the Videos library. - name: Photo Albums description: Hand-picked, ordered sets of photos for galleries. - name: Photo Feeds description: >- Feeds that collect photos from a connected photo source into the Images library on a schedule. - name: Attachments description: Uploading files and cropping images. - name: Fetchski Media description: >- Read-only discovery over the Images and Videos libraries: find what to reference in an MDX blog import, or which file to use, with its URLs. - name: Forms description: The site’s forms and their fields. - name: Form Submissions description: >- What visitors sent through the site’s forms. Submissions hold personal details: give a key `forms:read` only where it is needed. - name: Conversion Events description: >- The conversion event log — one record per conversion, with its attribution and consent snapshot and its delivery to each ad platform. Read it incrementally, post facts from other systems (a reservation purchase, a lead outcome), and adjust them (refunds, cancellations). One event ID travels everywhere as the platforms’ de-duplication key. - name: Visitor Attribution description: >- Per-visitor attribution on this site: first touch, last ad or campaign touch, and the ad platforms’ browser IDs. The join other systems use to attach a purchase to the marketing-site journey that led to it. - name: Ads Metrics description: >- Aggregates for dashboards: ad-click landings and conversions, by day, platform, campaign and more. - name: Conversions description: >- Conversion definitions — the visitor actions (a lead, a call click, a booking, a purchase) this site reports to the ad platforms, each with a row per platform. Managed by administrators in the CMS. - name: Webhooks description: >- Push notifications of form submissions and conversion-event changes to the site’s Webhook Destinations — signed with each destination’s own secret, retried for a day, at-least-once. Set destinations up in the CMS (Webhook Destinations, for people granted “Manage webhook destinations”): URL, events, optional filters and custom headers, and the signing secret shown once. - name: Request Log description: >- The page views the site captured (Connections → Tracking → Request log), and the query parameters on them: campaign tags and ad click IDs. paths: /@apostrophecms/i18n/locale: post: tags: - Internationalization summary: Get locale path and manage clipboard description: >- Returns the path to a locale home-page or optional document and makes the clipboard available in the given locale. Used for cross-locale navigation. operationId: switchLocale parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/LocaleRequest' examples: basic_locale_switch: summary: Basic locale switch to home page value: locale: fr with_context_doc: summary: Switch locale for specific document value: locale: fr contextDocId: cloydg3ka0005qcls5vmg8sb9 with_clipboard: summary: Cross-domain switch with clipboard value: locale: fr contextDocId: cloydg3ka0005qcls5vmg8sb9 clipboard: exampleClipboardContent responses: '200': description: Locale path retrieved successfully content: application/json: schema: $ref: '#/components/schemas/SwitchLocaleResponse' examples: same_hostname: summary: Same hostname response value: redirectTo: /fr/page-slug different_hostname: summary: Different hostname response value: redirectTo: >- https://fr.example.com/french-example-page?aposCrossDomainSessionToken=generated_token '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' security: - ApiKeyAuth: [] - BearerAuth: [] x-codeSamples: - lang: typescript label: TypeScript source: >- import { createSiteClient } from '@fetchski/attract-cms-sdk'; const site = createSiteClient(); const switchLocale = await site.internationalization().switchLocale({ locale: 'fr' }); - lang: php label: Laravel source: >- use Fetchski\AttractCmsLaravel\Facades\Attract; $switchLocale = Attract::internationalization()->switchLocale(locale: 'fr'); components: schemas: LocaleRequest: type: object required: - locale properties: locale: type: string description: Target locale code example: fr contextDocId: type: string description: Optional document ID for the path example: cloydg3ka0005qcls5vmg8sb9 clipboard: type: string description: Optional clipboard content for cross-domain situations example: exampleClipboardContent title: LocaleRequest SwitchLocaleResponse: oneOf: - $ref: '#/components/schemas/SameHostnameResponse' - $ref: '#/components/schemas/DifferentHostnameResponse' SameHostnameResponse: type: object additionalProperties: false required: - redirectTo properties: redirectTo: type: string description: Path to redirect to within same hostname pattern: ^/(?!/).* example: /fr/page-slug title: SameHostnameResponse DifferentHostnameResponse: type: object additionalProperties: false required: - redirectTo properties: redirectTo: type: string format: uri description: Full URL to redirect to with cross-domain session token pattern: ^[A-Za-z][A-Za-z0-9+.-]*:// example: >- https://fr.example.com/french-example-page?aposCrossDomainSessionToken=generated_token title: DifferentHostnameResponse ApiError: type: object description: >- An error answer: the error’s name, a message saying what is wrong, and details by error. required: - name properties: name: type: string description: >- The error’s name: `invalid`, `required`, `unauthorized`, `forbidden`, `notfound`, `conflict`, `locked`, `tooManyRequests`, `error` (a server failure)… message: type: string description: What is wrong, and how to fix it. data: type: object additionalProperties: true description: >- Details, by error: `errors` (one entry per field problem, each with its `path`), `retryAfter` (seconds, on 429), `permission`… responses: BadRequest: description: 'The request is not valid: `message` says what to change.' content: application/json: schema: $ref: '#/components/schemas/ApiError' Unauthorized: description: The credential is missing or not accepted. content: application/json: schema: $ref: '#/components/schemas/ApiError' Forbidden: description: The caller may not do this. content: application/json: schema: $ref: '#/components/schemas/ApiError' securitySchemes: ApiKeyAuth: type: apiKey in: header name: Authorization description: >- Paste your API key as the CMS showed it: `fsk___` (issued under API Keys). `ApiKey ` in front of it works too. Leave it empty to read as the public. BearerAuth: type: http scheme: bearer description: >- A person’s bearer token, from **Signing in (people)** → `POST /@apostrophecms/login/login`. Apps use an API key instead. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.