---
title: "Get a Custom Experience"
method: GET
path: "/custom_experiences/{customExperienceId}"
tags: ["Custom Experience"]
---

# Get a Custom Experience

`GET /custom_experiences/{customExperienceId}`

Retrieves a given Custom Experience.

## Path parameters

- `customExperienceId` string, uuid, required — The unique identifier for a resource.

## Response `200`

OK

- CustomExperience
  - `id` string, uuid, required
  - `name` string
  - `landing_page_disabled` boolean, required
  - `side_panel_disabled` boolean, required
  - `background_color` string, nullable, required
  - `button_color` string, nullable, required
  - `text_color` string, nullable, required
  - `text_button_color` string, nullable, required
  - `disabled_notifications` CustomExperienceDisabledNotificationsType[], required
  - `email_logo_disabled` boolean, required
  - `email_header_text_disabled` boolean, required
  - `email_footer_signature_disabled` boolean, required
  - `email_expiration_text_disabled` boolean, required
  - `recipients_activity_disabled` boolean, required
  - `download_documents_disabled` boolean, required
  - `document_navigation_disabled` boolean, required
  - `redirect_urls` CustomExperienceRedirectUrls, required
    - `success` string, uri, nullable, required
    - `error` string, uri, nullable, required
    - `decline` string, uri, nullable, required
  - `logo` string, uri, nullable, required
  - `source` 'app' | 'public_api', nullable, required — Custom Experience Source
  - `created_at` string, date-time, required

## Other responses

- `400` — Bad request
- `401` — Access unauthorized
- `403` — Access forbidden
- `404` — Resource not found
- `405` — This method is not allowed
- `429` — Too Many Requests, please try again later.
- `500` — Internal Server Error

---

[API](https://skmtc.net/yousign/apis/public-api-v3.md) · [All operations](https://skmtc.net/yousign/apis/public-api-v3/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/yousign/public-api-v3/revisions/8d258c0b45d6/schema)