> ## 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 an organisation

> The full record for one organisation, read from the system that owns it, so the names, type and references are authoritative. `callerAccess.granted` says whether you can act on it. `employees` carries headcounts that trail the payroll by seconds and, for leavers, by up to a day — fine for a headline figure, never a figure to file or pay on.

404 for an organisation that belongs to another account and for one that does not exist; the two are deliberately indistinguishable.

To see who can reach it, call `GET /users?organisationId={organisationId}`.



## OpenAPI

````yaml /api-reference/specs/administration.json get /organisations/{organisationId}
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}:
    get:
      tags:
        - Organisations
      summary: Get an organisation
      description: >-
        The full record for one organisation, read from the system that owns it,
        so the names, type and references are authoritative.
        `callerAccess.granted` says whether you can act on it. `employees`
        carries headcounts that trail the payroll by seconds and, for leavers,
        by up to a day — fine for a headline figure, never a figure to file or
        pay on.


        404 for an organisation that belongs to another account and for one that
        does not exist; the two are deliberately indistinguishable.


        To see who can reach it, call `GET
        /users?organisationId={organisationId}`.
      operationId: GetOrganisation
      parameters:
        - name: organisationId
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrganisationDetailResponseResponseBody'
        '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:
    OrganisationDetailResponseResponseBody:
      type: object
      properties:
        message:
          $ref: '#/components/schemas/MessageWithTokenResponse'
        content:
          $ref: '#/components/schemas/OrganisationDetailResponseContentResponse'
        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
    OrganisationDetailResponseContentResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/OrganisationDetailResponse'
        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
    OrganisationDetailResponse:
      type: object
      properties:
        organisationId:
          type: string
          description: >-
            The organisation's identifier. Send it as `X-Org-Id` on requests to
            the other Flow Payroll APIs.
        legalName:
          type: string
          description: The registered legal name.
          nullable: true
        tradingName:
          type: string
          description: The trading name, when one is recorded.
          nullable: true
        organisationType:
          enum:
            - Branch
            - Franchise
            - Independent
            - Parent
            - Subsidiary
          type: string
          description: >-
            One of `Branch`, `Franchise`, `Independent`, `Parent` or
            `Subsidiary`.
          nullable: true
        companyRegistrationNumber:
          type: string
          description: The Companies House registration number, when recorded.
          nullable: true
        payeReference:
          type: string
          description: The employer PAYE reference, once payroll has been set up.
          nullable: true
        employees:
          $ref: '#/components/schemas/EmployeeCountsResponse'
        callerAccess:
          $ref: '#/components/schemas/CallerAccessResponse'
      additionalProperties: false
      description: One organisation in full, read from the system that owns its record.
    ContentMetadataResponse:
      type: object
      properties:
        dateFormat:
          type: string
        dateTimeFormat:
          type: string
        paginationToken:
          type: string
          nullable: true
      additionalProperties: false
    EmployeeCountsResponse:
      type: object
      properties:
        totalEmployeeCount:
          type: integer
          description: On the books, whether or not they have left.
          format: int32
        activeEmployeeCount:
          type: integer
          description: On the books and not left.
          format: int32
        leaverEmployeeCount:
          type: integer
          description: On the books and left.
          format: int32
      additionalProperties: false
      description: >-
        Headcounts for an organisation. They trail the payroll by seconds and,
        for leavers, by up to a day:

        a headline figure, never one to file or pay on.
    CallerAccessResponse:
      type: object
      properties:
        granted:
          type: boolean
          description: >-
            Whether you can act on this organisation. There is nothing else to
            say about it: everybody who

            reaches an organisation may do everything in it.
      additionalProperties: false
      description: What you can do with an organisation.
  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.