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

> Get the organisation information for the current organisation



## OpenAPI

````yaml /api-reference/specs/pay-api.yaml get /organisation/information
openapi: 3.0.3
info:
  title: FlowPayroll API
  description: >-
    API for payroll management, including payroll upload, lock, HMRC submission,
    employee management
  version: 0.1.0
servers:
  - url: https://api.sandbox.flowpayroll.ai/v1
security:
  - XAuthToken: []
    XOrgId: []
tags:
  - name: Employees
    description: >-
      Create, retrieve, update, and delete employee records, and look them up by
      NI number or payroll ID.
  - name: Starters & leavers
    description: Set and clear starter and leaver details, individually or in bulk.
  - name: Tax codes
    description: >-
      Manage employee tax codes and query the effective tax code and NI category
      on a given date.
  - name: NI & identifiers
    description: Manage NI categories, National Insurance numbers, and payroll IDs.
  - name: Student loans
    description: Start and end student and postgraduate loans.
  - name: Payroll setup
    description: Assign an employee's payroll config and set opening balances.
  - name: Payroll
  - name: Payroll lines
  - name: PayrollConfig
  - name: Pay Elements
  - name: Calculator
  - name: Payslip
  - name: RTI
  - name: YearEnd
  - name: Organisation
paths:
  /organisation/information:
    get:
      tags:
        - Organisation
      summary: Get organisation information
      description: Get the organisation information for the current organisation
      operationId: getOrganisationInformation
      responses:
        '200':
          description: The organisation information was retrieved
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - $ref: '#/components/schemas/ResponseBody'
                  - properties:
                      content:
                        type: object
                        properties:
                          data:
                            $ref: '#/components/schemas/OrganisationInformationDto'
        '500':
          description: An error occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBody'
components:
  schemas:
    ResponseBody:
      type: object
      properties:
        message:
          $ref: '#/components/schemas/MessageWithTokenResponse'
        content:
          type: object
          properties:
            data:
              type: object
              nullable: true
            metadata:
              type: object
              nullable: true
              properties:
                dateFormat:
                  type: string
                  default: yyyy-MM-dd
                dateTimeFormat:
                  type: string
                  default: yyyy-MM-ddTHH:mm:ss.fffZ
                paginationToken:
                  type: string
                  nullable: true
        validationIssues:
          type: array
          items:
            $ref: '#/components/schemas/ValidationIssue'
        messageToken:
          type: string
    OrganisationInformationDto:
      type: object
      allOf:
        - $ref: '#/components/schemas/UpdatableOrganisationInformationDto'
        - type: object
          properties:
            organisationId:
              type: string
              description: Organisation id of the organisation
              example: org_123
            createdBy:
              type: string
              description: >-
                Created by of the organisation information. This is the user who
                created the organisation information
              example: user_123
            createdDate:
              type: string
              format: date-time
              description: >-
                Created date of the organisation information. This is the date
                and time when the organisation information was created
              example: '2025-01-01T00:00:00Z'
            updatedBy:
              type: string
              description: >-
                Updated by of the organisation information. This is the user who
                updated the organisation information
              example: user_456
            updatedDate:
              type: string
              format: date-time
              description: >-
                Updated date of the organisation information. This is the date
                and time when the organisation information was updated
              example: '2025-01-02T00:00:00Z'
          required:
            - organisationId
            - createdBy
            - createdDate
            - updatedBy
            - updatedDate
    MessageWithTokenResponse:
      type: object
      properties:
        text:
          type: string
        token:
          type: string
        tokenArguments:
          type: array
          items:
            $ref: '#/components/schemas/ValidationIssueArgument'
    ValidationIssue:
      type: object
      description: >
        Field validation item. `reasonToken` is a stable snake_case key for i18n
        or custom client messages; `reason` is the default English text from the
        API.
      properties:
        field:
          type: string
          description: Dot-path of the field (e.g. name.firstName, address.line1).
        reason:
          type: string
          description: Default human-readable message.
        reasonToken:
          type: string
          description: Machine-readable error identifier (snake_case).
        reasonTokenArguments:
          type: array
          nullable: true
          items:
            $ref: '#/components/schemas/ValidationIssueArgument'
    UpdatableOrganisationInformationDto:
      type: object
      properties:
        name:
          $ref: '#/components/schemas/OrganisationNameDto'
        organisationType:
          type: string
          description: Organisation type of the organisation
          enum:
            - Parent
            - Subsidiary
            - Independent
            - Franchise
            - Branch
          example: LimitedCompany
        companyRegistrationNumber:
          type: string
          description: >-
            Company Registration Number (CRN), also known as a Companies House
            number, is a unique identifier assigned to a company when it's
            registered with Companies House. It's essentially a way to
            distinguish one company from another and verify its existence
          example: '12345678'
        businessType:
          type: string
          description: Business type of the organisation
          enum:
            - LimitedCompany
            - LimitedLiabilityPartnership
            - SoleTrader
            - Partnership
            - Charity
            - PublicSector
          example: LimitedCompany
        registredOfficeAddress:
          $ref: '#/components/schemas/AddressDto'
        correspondenceAddress:
          $ref: '#/components/schemas/AddressDto'
        companyContactDetails:
          $ref: '#/components/schemas/ContactDetailsDto'
        primaryContactDetails:
          $ref: '#/components/schemas/ContactDetailsDto'
      required:
        - name
        - organisationType
        - companyRegistrationNumber
        - businessType
        - registredOfficeAddress
        - correspondenceAddress
        - companyContactDetails
        - primaryContactDetails
        - bankAccount
    ValidationIssueArgument:
      type: object
      properties:
        name:
          type: string
        value:
          type: string
    OrganisationNameDto:
      type: object
      properties:
        legalName:
          type: string
          description: Legal name of the organisation
          example: Acme Corporation Ltd
        tradingName:
          type: string
          nullable: true
          description: Trading name of the organisation
          example: Acme Corp
    AddressDto:
      type: object
      properties:
        line1:
          type: string
          nullable: true
          example: 123 Main Street
        line2:
          type: string
          nullable: true
          example: Apt 4B
        city:
          type: string
          nullable: true
          example: London
        county:
          type: string
          nullable: true
          example: Greater London
        postcode:
          type: string
          nullable: true
          example: SW1A 1AA
        countryCode:
          type: string
          default: GB
          description: >-
            ISO 3166-1 alpha-2 country code. Defaults to "GB" when omitted or
            blank.
          example: GB
    ContactDetailsDto:
      type: object
      properties:
        name:
          type: string
          description: Name of the contact.
          example: HR Department
        email:
          type: string
          description: Email of the contact.
          example: hr@acme.com
        phone:
          type: string
          nullable: true
          description: Phone of the contact.
          example: 0161 123 4567
  securitySchemes:
    XAuthToken:
      type: apiKey
      in: header
      name: X-Auth-Token
      description: Access token obtained from OAuth2 client credentials flow
    XOrgId:
      type: apiKey
      in: header
      name: X-Org-Id
      description: >-
        Organisation to scope the request to. Required when the principal can
        access more than one organisation; optional for single-organisation
        principals (the authorizer resolves it automatically).

````