> ## Documentation Index
> Fetch the complete documentation index at: https://docs.y.uno/llms.txt
> Use this file to discover all available pages before exploring further.
# Retrieve a Provider's Instruction Override
> Returns the custom connection instructions stored for one provider — the focused read an editor loads before saving.
Returns the custom connection instructions you have stored for this provider — the focused read an editor loads before saving.
A provider with no override answers `404`. Use [Retrieve a Provider Overlay](/reference/organizations/whitelabel/retrieve-provider), which never 404s, when you want the overlay whether or not an override exists.
A field you do not override is **absent** — not `null`, not an empty list. Absent means "keep the Yuno catalogue's value"; present-and-empty means "replace it with nothing".
### Path Parameters
Yuno catalogue provider id in UPPER\_SNAKE\_CASE. Case-insensitive — normalized to upper case.
### Response
Yuno catalogue provider id, normalized to upper case.
Connection steps replacing the catalogue's. Each step accepts `step`, `text`, `text_link`, `link`, `type`, `has_sub_instructions`, `sub_instructions_type` and `sub_instructions` (nested up to 3 levels). `text` and `text_link` are either a plain string or a language map such as `{"EN": "...", "ES": "..."}`.
Grouped setup steps replacing the catalogue's. Each group accepts `title`, `order`, `instructions_type` and `instructions` (the same step shape).
Documentation link replacing the catalogue's. Always https.
Display name replacing the catalogue's. Only Yuno-owned providers can carry one.
ISO 8601 timestamp — when the override was first written.
ISO 8601 timestamp — when the override was last written.
The dashboard user who created it. Overrides written through this API carry the all-zero sentinel, meaning "written through the API" rather than by a person in the Dashboard.
The dashboard user who last updated it, with the same sentinel rule as `created_by`.
```bash cURL theme={"theme":{"light":"github-dark","dark":"github-dark-dimmed"}}
curl -X GET 'https://api.y.uno/v1/whitelabel/providers/STRIPE/instructions' \
-H 'public-api-key: ' \
-H 'private-secret-key: '
```
```json 200 OK theme={"theme":{"light":"github-dark","dark":"github-dark-dimmed"}}
{
"provider_id": "STRIPE",
"more_info_url": "https://docs.example.com/stripe",
"instructions": [
{
"step": 1,
"text": { "EN": "Open your Stripe dashboard.", "ES": "Abre tu panel de Stripe." },
"type": "TEXT"
},
{
"step": 2,
"text": "Copy the secret API key and paste it below.",
"text_link": "Where do I find my key?",
"link": "https://docs.example.com/stripe#api-keys",
"type": "LINK"
}
],
"setup_instructions": [
{
"title": "Before you start",
"order": 1,
"instructions_type": "TEXT",
"instructions": [
{ "step": 1, "text": "Make sure your Stripe account is activated." }
]
}
],
"created_at": "2026-09-02T13:54:13Z",
"updated_at": "2026-09-02T13:54:13Z",
"created_by": "00000000-0000-0000-0000-000000000000",
"updated_by": "00000000-0000-0000-0000-000000000000"
}
```
```json 404 — no override theme={"theme":{"light":"github-dark","dark":"github-dark-dimmed"}}
{
"title": "Not Found",
"status": 404,
"detail": "No instruction override for provider STRIPE"
}
```
```json 400 Bad Request theme={"theme":{"light":"github-dark","dark":"github-dark-dimmed"}}
{
"code": "VALIDATION_ERROR",
"messages": ["provider_id is invalid"]
}
```
### Errors
| HTTP | Envelope | When |
| ----- | ------------------- | ------------------------------------------ |
| `400` | `VALIDATION_ERROR` | `provider_id` is not a valid catalogue id. |
| `401` | `NOT_AUTHENTICATED` | Missing or invalid API keys. |
| `404` | problem+json | This provider has no instruction override. |
## OpenAPI
````yaml openapi/organizations/whitelabel/retrieve-provider-instructions.json GET /whitelabel/providers/{provider_id}/instructions
openapi: 3.1.0
info:
title: White-label Providers API - Retrieve Instructions
version: 1.0.0
servers:
- url: https://api-sandbox.y.uno/v1
- url: https://api.eu.y.uno/v1
security:
- sec0: []
sec1: []
paths:
/whitelabel/providers/{provider_id}/instructions:
get:
summary: Retrieve a Provider's Instruction Override
description: >-
Returns the custom connection instructions you have stored for this
provider — the focused read an editor loads before saving. A provider
with no override answers `404`; use `GET
/v1/whitelabel/providers/{provider_id}`, which never 404s, when you want
the overlay whether or not one exists.
A field you do not override is absent, not null and not an empty list:
absent means "keep the Yuno catalogue's value", present-and-empty means
"replace it with nothing".
operationId: retrieve-whitelabel-provider-instructions
parameters:
- name: provider_id
in: path
required: true
description: >-
Yuno catalogue provider id in UPPER_SNAKE_CASE. Case-insensitive;
normalized to upper case.
schema:
type: string
example: STRIPE
responses:
'200':
description: The stored override.
content:
application/json:
schema:
type: object
properties:
provider_id:
type: string
description: Yuno catalogue provider id, UPPER_SNAKE_CASE.
example: STRIPE
instructions:
type: array
description: Connection steps replacing the catalogue's.
items:
type: object
additionalProperties: true
description: >-
One instruction step. Accepts `step`, `text`,
`text_link`, `link`, `type`, `has_sub_instructions`,
`sub_instructions_type` and `sub_instructions` (nested
up to 3 levels). `text` and `text_link` are either a
plain string or a language map such as `{"EN": "...",
"ES": "..."}`. Every `link` must be https.
setup_instructions:
type: array
description: Grouped setup steps replacing the catalogue's.
items:
type: object
additionalProperties: true
description: >-
One setup group. Accepts `title`, `order`,
`instructions_type` and `instructions` (the same step
shape).
more_info_url:
type: string
format: uri
description: >-
Documentation link replacing the catalogue's, when
overridden. Always https.
example: https://docs.example.com/stripe
name:
type: string
description: >-
Display name replacing the catalogue's, when overridden.
Only Yuno-owned providers can carry one.
example: Acme Risk
created_at:
type: string
format: date-time
readOnly: true
description: When the override was first written.
example: '2026-09-02T13:54:13Z'
updated_at:
type: string
format: date-time
readOnly: true
description: When the override was last written.
example: '2026-09-02T13:54:13Z'
created_by:
type: string
format: uuid
readOnly: true
description: >-
The dashboard user who created it. Overrides written
through this API carry the all-zero sentinel
`00000000-0000-0000-0000-000000000000`, meaning "written
through the API" rather than by a person in the dashboard.
example: 00000000-0000-0000-0000-000000000000
updated_by:
type: string
format: uuid
readOnly: true
description: >-
The dashboard user who last updated it, with the same
sentinel rule as `created_by`.
example: 00000000-0000-0000-0000-000000000000
'400':
description: Invalid provider_id.
content:
application/json:
schema:
type: object
properties:
code:
type: string
example: VALIDATION_ERROR
messages:
type: array
items:
type: string
example:
- provider_id is invalid
'401':
description: Unauthorized — invalid or missing API keys.
content:
application/json:
schema:
type: object
properties:
code:
type: string
example: NOT_AUTHENTICATED
messages:
type: array
items:
type: string
example:
- Not authenticated
'404':
description: This provider has no instruction override.
content:
application/json:
schema:
type: object
properties:
type:
type: string
example: about:blank
title:
type: string
example: Not Found
status:
type: integer
example: 404
detail:
type: string
example: No instruction override for provider STRIPE
components:
securitySchemes:
sec0:
type: apiKey
in: header
name: PUBLIC-API-KEY
x-default:
sec1:
type: apiKey
in: header
name: PRIVATE-SECRET-KEY
x-default:
````