> ## Documentation Index
> Fetch the complete documentation index at: https://docs.flowpayroll.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get the brand the app shows for an organisation

> Whose brand applies to this organisation: its managing account if that account has white label and has published a brand, else its owning account on the same terms, else Flow Payroll's. When an account's brand applies, `publishedBrandPath` is where its published files are served on the app's own address (`/_brand-of/{customerId}/`, holding `theme.css` and `logos/logo.svg`); it is null when Flow Payroll's brand applies. `brandRevision` changes on every publish.



## OpenAPI

````yaml /api-reference/specs/administration.json get /organisations/{organisationId}/resolved-branding
openapi: 3.0.1
info:
  title: Administration API
  description: >-
    Manage your Flow Payroll account: the organisations it owns, the people who
    can sign in to it, the API tokens it holds, its brand, and a feed of recent
    administration activity. Every resource is scoped to the account your
    credentials belong to, so no request ever names a customer and the
    `X-Org-Id` header is not used.
  version: v1
servers:
  - url: https://api.sandbox.flowpayroll.ai/v1/administration
security:
  - X-Auth-Token: []
tags:
  - name: Customer
    description: >-
      Your account: the customer every other resource on this API belongs to.
      Read it and rename it.
  - name: Organisations
    description: >-
      The organisations your account owns: list them with headcounts and your
      access to each, get one in full, and add one or several at a time.
  - name: Users
    description: >-
      The people who can sign in to your account: list, invite (one or many),
      resend invitations, and manage each person's direct grants and
      account-wide access.
  - name: API tokens
    description: >-
      The client credentials your integrations authenticate with: create (the
      secret is shown once), rename, rotate, revoke, and manage which
      organisations each token reaches.
  - name: Activity
    description: Recent administration actions in your account, newest first.
paths:
  /organisations/{organisationId}/resolved-branding:
    get:
      tags:
        - Organisations
      summary: Get the brand the app shows for an organisation
      description: >-
        Whose brand applies to this organisation: its managing account if that
        account has white label and has published a brand, else its owning
        account on the same terms, else Flow Payroll's. When an account's brand
        applies, `publishedBrandPath` is where its published files are served on
        the app's own address (`/_brand-of/{customerId}/`, holding `theme.css`
        and `logos/logo.svg`); it is null when Flow Payroll's brand applies.
        `brandRevision` changes on every publish.
      operationId: GetOrganisationResolvedBranding
      parameters:
        - name: organisationId
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/OrganisationResolvedBrandingResponseResponseBody
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectResponseBody'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectResponseBody'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectResponseBody'
components:
  schemas:
    OrganisationResolvedBrandingResponseResponseBody:
      type: object
      properties:
        message:
          $ref: '#/components/schemas/MessageWithTokenResponse'
        content:
          $ref: >-
            #/components/schemas/OrganisationResolvedBrandingResponseContentResponse
        validationIssues:
          type: array
          items:
            $ref: '#/components/schemas/ValidationIssue'
          nullable: true
      additionalProperties: false
    ObjectResponseBody:
      type: object
      properties:
        message:
          $ref: '#/components/schemas/MessageWithTokenResponse'
        content:
          $ref: '#/components/schemas/ObjectContentResponse'
        validationIssues:
          type: array
          items:
            $ref: '#/components/schemas/ValidationIssue'
          nullable: true
      additionalProperties: false
    MessageWithTokenResponse:
      type: object
      properties:
        text:
          type: string
        token:
          type: string
        tokenArguments:
          type: array
          items:
            $ref: '#/components/schemas/ValidationIssueArgument'
          nullable: true
      additionalProperties: false
    OrganisationResolvedBrandingResponseContentResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/OrganisationResolvedBrandingResponse'
        metadata:
          $ref: '#/components/schemas/ContentMetadataResponse'
      additionalProperties: false
    ValidationIssue:
      type: object
      properties:
        field:
          type: string
        reason:
          type: string
        reasonToken:
          type: string
        reasonTokenArguments:
          type: array
          items:
            $ref: '#/components/schemas/ValidationIssueArgument'
          nullable: true
      additionalProperties: false
    ObjectContentResponse:
      type: object
      properties:
        data:
          nullable: true
        metadata:
          $ref: '#/components/schemas/ContentMetadataResponse'
      additionalProperties: false
    ValidationIssueArgument:
      type: object
      properties:
        name:
          type: string
        value:
          nullable: true
      additionalProperties: false
    OrganisationResolvedBrandingResponse:
      type: object
      properties:
        organisationId:
          type: string
        source:
          enum:
            - Flow
            - Customer
          type: string
          description: Whose brand a resolution produced.
        customerId:
          type: string
          description: The account whose brand applies; null when Source is `Flow`.
          nullable: true
        brandRevision:
          type: string
          description: That account's published revision; null for Flow.
          nullable: true
        publishedBrandPath:
          type: string
          description: >-
            `/_brand-of/{customerId}/`, the account's published brand folder on
            the same origin (`theme.css`,
                        `logos/logo.svg`, ...); null when Flow's brand applies.
          nullable: true
        productName:
          type: string
        hasLogo:
          type: boolean
          description: >-
            Whether that folder holds `logos/logo.svg`; false for Flow and for
            an account with no logo.
        poweredByFlow:
          type: boolean
        appShowsProductName:
          type: boolean
        loadingStyle:
          enum:
            - Spinner
            - Icon
            - Animation
          type: string
          description: What the app shows while it waits, for an account's own brand.
        dark:
          $ref: '#/components/schemas/BrandDarkVersionsResponse'
        support:
          $ref: '#/components/schemas/BrandSupportResponse'
      additionalProperties: false
      description: >-
        Which brand the app shows for an organisation on Flow's own host, after
        the server's resolution (managing

        account, else owner, each only when entitled and published, else Flow).
        No links that expire: the browser reads

        the published files from PublishedBrandPath on its own origin.
    ContentMetadataResponse:
      type: object
      properties:
        dateFormat:
          type: string
        dateTimeFormat:
          type: string
        paginationToken:
          type: string
          nullable: true
      additionalProperties: false
    BrandDarkVersionsResponse:
      type: object
      properties:
        logo:
          type: boolean
        icon:
          type: boolean
        loadingAnimation:
          type: boolean
      additionalProperties: false
      description: >-
        Which of the brand's files have a version for a dark background. The
        light one is used for any that do not.
    BrandSupportResponse:
      type: object
      properties:
        supportUrl:
          type: string
          description: The brand's own help website; null when it has none.
          nullable: true
        supportEmail:
          type: string
          description: >-
            The address people write to for help; null when the brand gives
            none.
          nullable: true
        helpLinksFallback:
          enum:
            - Hide
            - FlowGuides
          type: string
          description: What a help link does when SupportUrl is null.
      additionalProperties: false
  securitySchemes:
    X-Auth-Token:
      type: apiKey
      description: FlowPayroll JWT (raw token, no Bearer prefix)
      name: X-Auth-Token
      in: header

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.