> ## Documentation Index > Fetch the complete documentation index at: https://docs-consumer.voucher.allride.io/llms.txt > Use this file to discover all available pages before exploring further. # Get workspace branding > Returns your Workspace Branding, including the consumer `landing` block and a render map of the images. Any member and any API key can read it. See [Landing pages](/consumer/landing-pages). **Required permissions:** none (any member or API key) · **API keys:** allowed ## OpenAPI ````yaml /openapi/consumer.v1.json get /partner/v1/branding/workspace openapi: 3.1.1 info: title: AllRide Voucher Consumer API version: 1.0.0 description: >- The Consumer API (`/consumer/v1`) and the shared Workspace API (`/partner/v1`) of the AllRide Voucher Platform for Partner Consumers: browse your catalog, redeem vouchers, manage redemption entities and Redemption Links, configure email OTP, read analytics and billing, and administer your workspace. Start with the [quickstart](https://docs-consumer.voucher.allride.io/quickstart). This document lists the sandbox server; production uses `https://api.voucher.allride.io`. contact: name: AllRide url: https://allride.io servers: - url: https://api.voucher-staging.allride.io description: Sandbox security: - apiKey: [] tags: - name: Catalog description: >- Browse the providers, voucher sets and categories AllRide makes available to you. - name: Catalog settings description: >- Turn providers and voucher sets on or off for your channels and keep your own settings and references. - name: Redemptions description: >- Redeem vouchers (single or batch), read issued codes and links, and void redemptions. - name: Redemption entities description: Your end customers or accounts, identified by your own opaque `refId`. - name: Redemption links description: >- Shareable links that let an end customer redeem on an AllRide-hosted landing page. - name: Email (SMTP and templates) description: >- Email OTP Gate settings, your SMTP configuration and the OTP email templates. - name: Analytics description: Redemption, entity and link statistics in your partner time zone. - name: Billing description: >- Billing account, contacts, payment methods, invoices (including Stornorechnungen), payments, usage and balance. - name: Pricing description: Your resolved Price Terms per voucher set and your Price Acceptances. - name: Partner description: >- Your partner record, settings, principal introspection, API access and the developer reference. - name: Members description: Users of your partner and their invitations. - name: Groups description: Groups, their permissions and the permission catalog. - name: API keys description: API keys of your partner (dashboard only). - name: Webhook endpoints description: Webhook endpoints, their secrets and the event types you can subscribe to. - name: Webhook deliveries description: The webhook delivery log and replays. - name: IP allowlist description: Source address ranges allowed to call the API. - name: Custom domains description: Your own host names for Redemption Link landing pages. - name: Workspace branding description: Workspace Branding (dashboards and landing pages) and brand assets. - name: Single sign-on description: SAML and OIDC connections for your users. - name: Audit log description: Every change made in your partner, by whom and when. paths: /partner/v1/branding/workspace: get: tags: - Workspace branding summary: Get workspace branding description: >- Returns your Workspace Branding, including the consumer `landing` block and a render map of the images. Any member and any API key can read it. See [Landing pages](/consumer/landing-pages). **Required permissions:** none (any member or API key) · **API keys:** allowed operationId: partner.workspace-branding.get responses: '200': description: OK headers: X-Request-Id: $ref: '#/components/headers/XRequestId' Idempotency-Key-Ignored: $ref: '#/components/headers/IdempotencyKeyIgnored' content: application/json: schema: $ref: '#/components/schemas/WorkspaceBrandingResponse' examples: default: summary: OK value: data: id: 37069 resource: branding partnerId: 1069 scope: workspace live: primaryColor: '#c8102e' secondaryColor: null backgroundColor: '#ffffff' surfaceColor: '#f5f5f5' textColor: '#1a1a1a' accentColor: null buttonColor: '#c8102e' buttonTextColor: '#ffffff' buttonBorderColor: null logoAssetId: 3095 logoDarkAssetId: null iconAssetId: null heroImageAssetId: null faviconAssetId: null emailLogoAssetId: null fontFamily: source-sans-3 cornerRadius: md extensions: null landing: title: de: Ihre Mobilitätsgutscheine en: Your mobility vouchers intro: de: Wählen Sie einen Anbieter. en: Choose a provider. termsUrl: >- https://www.example-transit.example.com/vouchers/terms privacyUrl: https://www.example-transit.example.com/privacy imprintUrl: https://www.example-transit.example.com/imprint supportEmail: vouchers@example.com supportUrl: null footerText: null showProviderSearch: true look: vibrant botProtection: turnstile liveRevisionNo: 3 pendingChangeRequestId: null assets: - id: 3095 resource: brand-asset kind: logo publicUrl: >- https://assets.voucher.allride.io/example-transit/3095.png width: 512 height: 128 variants: null _links: self: href: >- https://api.voucher.allride.io/partner/v1/brand-assets/3095 type: application/json assetUrls: logo: assetId: 3095 url: >- https://assets.voucher.allride.io/example-transit/3095.png width: 512 height: 128 variants: null logoDark: null icon: null hero: null favicon: null emailLogo: null createdAt: '2026-10-19T14:02:11.418Z' updatedAt: '2026-10-22T08:00:00Z' _links: self: href: >- https://api.voucher.allride.io/partner/v1/branding/workspace type: application/json '400': description: Bad Request x-error-codes: - data-failed-validation headers: X-Request-Id: $ref: '#/components/headers/XRequestId' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: data-failed-validation: summary: Data failed validation value: errors: - message: >- One or more properties or parameters are invalid; each is listed in `more.validationErrors` with its property path and violated constraint. Unknown properties and query parameters are refused as well. statusCode: 400 errorCode: data-failed-validation more: validationErrors: - property: name constraint: required message: en: This property is required. '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/InternalError' '503': $ref: '#/components/responses/ServiceUnavailable' components: headers: XRequestId: description: Request id (yours if you sent a valid `X-Request-Id`, else generated). schema: type: string IdempotencyKeyIgnored: description: '`true` when you sent `Idempotency-Key` on a method that ignores it.' schema: type: string enum: - 'true' RetryAfter: description: Seconds to wait before retrying or polling. schema: type: integer schemas: WorkspaceBrandingResponse: type: object description: Single-object envelope around a `WorkspaceBranding`. properties: data: $ref: '#/components/schemas/WorkspaceBranding' required: - data additionalProperties: false ErrorResponse: type: object description: >- Error body of every 4xx and 5xx response (`Content-Type: application/json`). properties: errors: type: array minItems: 1 items: $ref: '#/components/schemas/ErrorEntry' description: The errors; in v1 always exactly one. required: - errors additionalProperties: false WorkspaceBranding: type: object description: >- Workspace Branding: the look of your dashboards and, for consumers, your landing pages and OTP emails. properties: id: $ref: '#/components/schemas/ULong' description: Numeric id of the resource, unique per resource type. resource: type: string enum: - branding description: Always `branding`. partnerId: $ref: '#/components/schemas/ULong' description: Your partner id. scope: type: string enum: - workspace description: >- Always `workspace` here. Treat as an open set: new values may be added. live: anyOf: - $ref: '#/components/schemas/WorkspaceBrandingContent' - type: 'null' description: Current branding; `null` until the first save. liveRevisionNo: type: integer description: Number of saves. pendingChangeRequestId: type: 'null' description: Always `null` for Workspace Branding (no approval needed). assets: type: array items: $ref: '#/components/schemas/BrandAssetSummary' description: Every asset referenced by `live`. assetUrls: type: object properties: logo: anyOf: - $ref: '#/components/schemas/WorkspaceAssetView' - type: 'null' description: logo image, `null` when unset or not ready. logoDark: anyOf: - $ref: '#/components/schemas/WorkspaceAssetView' - type: 'null' description: logoDark image, `null` when unset or not ready. icon: anyOf: - $ref: '#/components/schemas/WorkspaceAssetView' - type: 'null' description: icon image, `null` when unset or not ready. hero: anyOf: - $ref: '#/components/schemas/WorkspaceAssetView' - type: 'null' description: hero image, `null` when unset or not ready. favicon: anyOf: - $ref: '#/components/schemas/WorkspaceAssetView' - type: 'null' description: favicon image, `null` when unset or not ready. emailLogo: anyOf: - $ref: '#/components/schemas/WorkspaceAssetView' - type: 'null' description: emailLogo image, `null` when unset or not ready. required: - logo - logoDark - icon - hero - favicon - emailLogo additionalProperties: false description: Render map of the referenced images. createdAt: $ref: '#/components/schemas/Instant' description: When the resource was created. updatedAt: $ref: '#/components/schemas/Instant' description: When the resource was last changed. _links: type: object description: >- Related resources you may follow (HAL style). A link is present only when you hold the target's permissions. properties: self: $ref: '#/components/schemas/Link' description: This resource. required: - self additionalProperties: false required: - id - resource - partnerId - scope - live - liveRevisionNo - pendingChangeRequestId - assets - assetUrls - createdAt - updatedAt - _links additionalProperties: false ErrorEntry: type: object description: One error. Branch on `errorCode`; ignore members you do not know. properties: message: type: string description: >- Human-readable message. For 5xx errors it is always the generic `Something went wrong on our side`. statusCode: type: integer description: The HTTP status. errorCode: type: string description: Stable kebab-case error code, listed in the error catalog. requestId: type: string description: >- 5xx only: the request id (also in the `X-Request-Id` header). Quote it when you contact support. more: type: object additionalProperties: true description: >- Additional details for some codes, for example `validationErrors` (array of `ValidationError`) or `requiredPermissions`. The members per code are listed in the error catalog. properties: validationErrors: type: array items: $ref: '#/components/schemas/ValidationError' description: Invalid properties or parameters. required: - message - statusCode - errorCode additionalProperties: true ULong: type: integer format: uint64 minimum: 0 maximum: 18446744073709552000 x-bigint: true description: >- Unsigned 64-bit integer (ids and large counters). May exceed 2^53; parse with a BigInt-safe JSON parser in JavaScript. WorkspaceBrandingContent: type: object properties: primaryColor: type: - string - 'null' pattern: ^#[0-9a-f]{6}$ description: Primary colour `#rrggbb`. secondaryColor: type: - string - 'null' pattern: ^#[0-9a-f]{6}$ description: Secondary colour. backgroundColor: type: - string - 'null' pattern: ^#[0-9a-f]{6}$ description: Background colour. surfaceColor: type: - string - 'null' pattern: ^#[0-9a-f]{6}$ description: Surface colour. textColor: type: - string - 'null' pattern: ^#[0-9a-f]{6}$ description: Text colour (AA contrast on the background). accentColor: type: - string - 'null' pattern: ^#[0-9a-f]{6}$ description: Accent colour. buttonColor: type: - string - 'null' pattern: ^#[0-9a-f]{6}$ description: Button colour. buttonTextColor: type: - string - 'null' pattern: ^#[0-9a-f]{6}$ description: Button text colour (AA contrast on the button). buttonBorderColor: type: - string - 'null' pattern: ^#[0-9a-f]{6}$ description: Button border colour. logoAssetId: anyOf: - $ref: '#/components/schemas/ULong' - type: 'null' description: Logo asset. logoDarkAssetId: anyOf: - $ref: '#/components/schemas/ULong' - type: 'null' description: Logo for dark backgrounds. iconAssetId: anyOf: - $ref: '#/components/schemas/ULong' - type: 'null' description: Icon asset. heroImageAssetId: anyOf: - $ref: '#/components/schemas/ULong' - type: 'null' description: Hero image asset. faviconAssetId: anyOf: - $ref: '#/components/schemas/ULong' - type: 'null' description: Favicon asset. emailLogoAssetId: anyOf: - $ref: '#/components/schemas/ULong' - type: 'null' description: Logo used in emails. fontFamily: type: - string - 'null' enum: - inter - roboto - open-sans - lato - source-sans-3 - system - null description: 'Font family. Treat as an open set: new values may be added.' cornerRadius: type: - string - 'null' enum: - none - sm - md - lg - full - null description: 'Corner radius. Treat as an open set: new values may be added.' extensions: anyOf: - $ref: '#/components/schemas/JsonMetadata' - type: 'null' description: Free-form extension values (keys `x-*`); scanned like every text. landing: anyOf: - $ref: '#/components/schemas/LandingBranding' - type: 'null' description: Consumer landing block; `null` until set. required: - primaryColor - secondaryColor - backgroundColor - surfaceColor - textColor - accentColor - buttonColor - buttonTextColor - buttonBorderColor - logoAssetId - logoDarkAssetId - iconAssetId - heroImageAssetId - faviconAssetId - emailLogoAssetId - fontFamily - cornerRadius - extensions - landing additionalProperties: false description: Workspace Branding content. BrandAssetSummary: type: object properties: id: $ref: '#/components/schemas/ULong' description: Asset id. resource: type: string enum: - brand-asset description: Always `brand-asset`. kind: type: string enum: - logo - logo-dark - icon - hero - favicon - email-logo description: 'Asset kind. Treat as an open set: new values may be added.' publicUrl: type: string format: uri description: Public URL. width: type: - integer - 'null' description: Width in pixels. height: type: - integer - 'null' description: Height in pixels. variants: type: - object - 'null' additionalProperties: true description: Responsive variants; `null` for now. _links: type: object properties: self: $ref: '#/components/schemas/Link' description: The asset. required: - self additionalProperties: false description: Links. required: - id - resource - kind - publicUrl - width - height - variants - _links additionalProperties: false description: A referenced brand asset. WorkspaceAssetView: type: object properties: assetId: $ref: '#/components/schemas/ULong' description: Brand asset id. url: type: string format: uri description: Public URL of the image. width: type: integer description: Width in pixels. height: type: integer description: Height in pixels. variants: type: - object - 'null' additionalProperties: true description: Responsive variants; `null` for now. required: - assetId - url - width - height - variants additionalProperties: false description: A renderable image reference. Instant: type: string format: date-time description: >- RFC 3339 timestamp in UTC with `Z`, millisecond precision, truncated: no fraction when the milliseconds are zero (`2026-11-01T00:00:00Z`), otherwise exactly three digits (`2026-10-21T17:42:10.120Z`). Inputs must carry an offset and are normalised to UTC. example: '2026-11-01T00:00:00Z' Link: type: object description: A link to a related resource. properties: href: type: string format: uri description: Absolute URL. type: type: string description: Media type of the target, usually `application/json`. required: - href - type additionalProperties: false ValidationError: type: object description: >- One invalid property or parameter of a `data-failed-validation` error (also used for item failures of batch operations and content checks). properties: property: type: string description: >- Path of the offending property in your request body (`items[2].quantity`), or the name of the query parameter, path parameter or header. constraint: type: string description: >- The violated rule as a kebab-case item code, for example `required`, `too-long`, `invalid-id`, `unknown-field`. See the validation item codes in the error catalog. params: type: object additionalProperties: true description: >- Parameters of the constraint, for example `min` and `max` for `invalid-page` or `allowed` for `invalid-sort`. value: description: The rejected value, when it is safe to return. message: type: object description: Explanation per locale. properties: en: type: string description: English message. de: type: string description: German message. required: - en additionalProperties: false required: - property - constraint - message additionalProperties: true JsonMetadata: type: object additionalProperties: true description: >- Free-form JSON object (at most 16 KiB, depth 5, 100 keys per object). The platform stores it as sent and never interprets it. Key order is not preserved. example: orderId: '8812' channel: app LandingBranding: type: object properties: title: anyOf: - $ref: '#/components/schemas/I18nText' - type: 'null' description: Landing page title (at most 80 characters per locale). intro: anyOf: - $ref: '#/components/schemas/I18nMarkdown' - type: 'null' description: >- Introduction in restricted Markdown (at most 1,000 characters per locale). termsUrl: type: - string - 'null' format: uri description: Your terms URL (https). privacyUrl: type: - string - 'null' format: uri description: >- Your privacy policy URL (https). Required before you create Redemption Links. imprintUrl: type: - string - 'null' format: uri description: >- Your imprint URL (https). Required before you create Redemption Links. supportEmail: type: - string - 'null' format: email description: Support email shown to customers. supportUrl: type: - string - 'null' format: uri description: Support URL (https). footerText: anyOf: - $ref: '#/components/schemas/I18nText' - type: 'null' description: Footer text (at most 300 characters per locale). showProviderSearch: type: boolean description: Show the provider search on the landing page. look: type: string enum: - vibrant - soft - bold - clean description: >- Landing Look: how colourful the landing pages are. Optional on write (default `vibrant`); always present on read. Treat as an open set: new values may be added. botProtection: type: string enum: - 'off' - turnstile description: >- Bot protection of your Redemption Link landing pages. `turnstile` shows the Cloudflare Turnstile widget and requires its token on the OTP request and the redeem. Optional on write (default `off`); always present on read. Treat as an open set: new values may be added. required: - title - intro - termsUrl - privacyUrl - imprintUrl - supportEmail - supportUrl - footerText - showProviderSearch - look - botProtection additionalProperties: false description: >- Consumer-only landing block of Workspace Branding. See [Landing pages](/consumer/landing-pages). I18nText: type: object description: >- Localised text: an object keyed by locale (`de`, `en`). Responses always return the full map; pick the locale on your side. Requests must include your partner's default locale. properties: de: type: string description: German text. en: type: string description: English text. additionalProperties: false example: de: 5 € Fahrguthaben en: €5 ride credit I18nMarkdown: type: object description: >- Localised restricted Markdown (paragraphs, line breaks, bold, italic, lists, headings level 3-4, https links). Render with a sanitising Markdown renderer, never as raw HTML. properties: de: type: string description: German Markdown. en: type: string description: English Markdown. additionalProperties: false example: de: Gültig für **alle** E-Scooter. en: Valid for **all** e-scooters. responses: Unauthorized: description: 'Unauthorized: the credential is missing or invalid.' x-error-codes: - unauthenticated - token-invalid - token-expired - api-key-invalid headers: X-Request-Id: $ref: '#/components/headers/XRequestId' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: unauthenticated: summary: Authentication required value: errors: - message: No credential was sent with the request. statusCode: 401 errorCode: unauthenticated token-invalid: summary: Invalid credential value: errors: - message: >- The credential cannot be verified for this surface (wrong scheme, signature or credential kind). statusCode: 401 errorCode: token-invalid token-expired: summary: Credential expired value: errors: - message: The dashboard ID token has expired. statusCode: 401 errorCode: token-expired api-key-invalid: summary: Invalid API key value: errors: - message: >- The API key is unknown, revoked, expired, past its roll grace period or belongs to the other environment (`vk_test_` against production or `vk_live_` against the sandbox). statusCode: 401 errorCode: api-key-invalid Forbidden: description: 'Forbidden: an access gate refused the request.' x-error-codes: - partner-role-missing - partner-suspended - partner-offboarded - api-access-inactive - ip-not-allowed - mfa-required - sso-required - missing-permission - reauthentication-required headers: X-Request-Id: $ref: '#/components/headers/XRequestId' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: partner-role-missing: summary: Partner role missing value: errors: - message: >- Your partner lacks the role (provider or consumer) this surface needs. statusCode: 403 errorCode: partner-role-missing more: requiredRole: consumer partner-suspended: summary: Partner suspended value: errors: - message: >- Your partner is suspended: writes are refused (billing writes from the dashboard excepted). statusCode: 403 errorCode: partner-suspended partner-offboarded: summary: Partner offboarded value: errors: - message: Your partner has been offboarded; every route is refused. statusCode: 403 errorCode: partner-offboarded api-access-inactive: summary: API access inactive value: errors: - message: >- API access of your partner is not active (not yet granted, revoked, or the partner is suspended), so API keys are refused. statusCode: 403 errorCode: api-access-inactive ip-not-allowed: summary: IP address not allowed value: errors: - message: >- The request's source address is not in your IP allowlist while enforcement is on. statusCode: 403 errorCode: ip-not-allowed mfa-required: summary: Multi-factor authentication required value: errors: - message: >- Your partner requires multi-factor authentication for dashboard users. statusCode: 403 errorCode: mfa-required sso-required: summary: Single sign-on required value: errors: - message: >- Your partner enforces single sign-on for this user's email domain. statusCode: 403 errorCode: sso-required missing-permission: summary: Missing permission value: errors: - message: >- The membership or API key lacks a permission the operation requires, including non-delegable permissions called with an API key. statusCode: 403 errorCode: missing-permission more: requiredPermissions: - create-consumer-redemptions reauthentication-required: summary: Recent sign-in required value: errors: - message: >- The operation needs a sign-in within the last 15 minutes (dashboard users only). statusCode: 403 errorCode: reauthentication-required NotFound: description: Not found. x-error-codes: - route-not-found headers: X-Request-Id: $ref: '#/components/headers/XRequestId' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: route-not-found: summary: Route not found value: errors: - message: No operation exists for this path. statusCode: 404 errorCode: route-not-found InternalError: description: Unexpected failure; quote the `requestId`. x-error-codes: - internal-error headers: X-Request-Id: $ref: '#/components/headers/XRequestId' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: internal-error: summary: Internal error value: errors: - message: Something went wrong on our side statusCode: 500 errorCode: internal-error requestId: 0c9f2ea5-fe09-463c-8f96-b6cae67800ad ServiceUnavailable: description: Temporarily unavailable; retry after `Retry-After`. x-error-codes: - service-unavailable - db-unavailable - query-timeout headers: X-Request-Id: $ref: '#/components/headers/XRequestId' Retry-After: $ref: '#/components/headers/RetryAfter' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: service-unavailable: summary: Service unavailable value: errors: - message: Something went wrong on our side statusCode: 503 errorCode: service-unavailable requestId: 0c9f2ea5-fe09-463c-8f96-b6cae67800ad db-unavailable: summary: Database unavailable value: errors: - message: Something went wrong on our side statusCode: 503 errorCode: db-unavailable requestId: 0c9f2ea5-fe09-463c-8f96-b6cae67800ad query-timeout: summary: Query timeout value: errors: - message: Something went wrong on our side statusCode: 503 errorCode: query-timeout requestId: 0c9f2ea5-fe09-463c-8f96-b6cae67800ad securitySchemes: apiKey: type: http scheme: bearer bearerFormat: vk_live__ description: >- Your API key in `Authorization: Bearer `. Use `vk_test_…` keys against the sandbox and `vk_live_…` keys against production. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.