> ## 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. # List the organisations you can see > Both kinds of organisation: the account's own, in name order, then any you reach as a **guest** of another business. `accessType` on each row says which — `Customer` or `Guest` — and the `accessType` query parameter filters to one kind. One page holds one kind, so follow the token to exhaustion to see both. `search` matches the start of an organisation's name and applies to the account's own. The account's own list is **not** only the ones you can reach. `callerAccess.granted` on each row says whether you can act on that organisation. An administrator who runs 12 of an account's 40 organisations still needs to know the other 28 exist, so the list includes them and marks them. A guest organisation is managed by its own account: you can open it, never administer it here. Paginated: `pageSize` (default 50, at most 100) and `paginationToken`. Follow the token until it is absent — a page is never the whole list while a token is present. To find who can reach one of the account's organisations, call `GET /users?organisationId={organisationId}`. ## OpenAPI ````yaml /api-reference/specs/administration.json get /organisations 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: get: tags: - Organisations summary: List the organisations you can see description: >- Both kinds of organisation: the account's own, in name order, then any you reach as a **guest** of another business. `accessType` on each row says which — `Customer` or `Guest` — and the `accessType` query parameter filters to one kind. One page holds one kind, so follow the token to exhaustion to see both. `search` matches the start of an organisation's name and applies to the account's own. The account's own list is **not** only the ones you can reach. `callerAccess.granted` on each row says whether you can act on that organisation. An administrator who runs 12 of an account's 40 organisations still needs to know the other 28 exist, so the list includes them and marks them. A guest organisation is managed by its own account: you can open it, never administer it here. Paginated: `pageSize` (default 50, at most 100) and `paginationToken`. Follow the token until it is absent — a page is never the whole list while a token is present. To find who can reach one of the account's organisations, call `GET /users?organisationId={organisationId}`. operationId: GetOrganisations parameters: - name: search in: query schema: type: string - name: pageSize in: query schema: type: string - name: paginationToken in: query schema: type: string - name: accessType in: query description: >- Customer for the account's own, Guest for guest access, absent for both. schema: enum: - Customer - Guest type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/OrganisationListResponseResponseBody' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ObjectResponseBody' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ObjectResponseBody' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ObjectResponseBody' components: schemas: OrganisationListResponseResponseBody: type: object properties: message: $ref: '#/components/schemas/MessageWithTokenResponse' content: $ref: '#/components/schemas/OrganisationListResponseContentResponse' 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 OrganisationListResponseContentResponse: type: object properties: data: $ref: '#/components/schemas/OrganisationListResponse' 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 OrganisationListResponse: type: object properties: organisations: type: array items: $ref: '#/components/schemas/OrganisationSummaryResponse' description: The page, in name order. paginationToken: type: string description: >- Null on the last page. Follow it until it is absent. Also published at `content.metadata.paginationToken`, which is the location to prefer. nullable: true additionalProperties: false description: A page of organisations. ContentMetadataResponse: type: object properties: dateFormat: type: string dateTimeFormat: type: string paginationToken: type: string nullable: true additionalProperties: false OrganisationSummaryResponse: 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 employees: $ref: '#/components/schemas/EmployeeCountsResponse' callerAccess: $ref: '#/components/schemas/CallerAccessResponse' accessType: enum: - Customer - Guest type: string description: >- `Customer` for an organisation this account owns; `Guest` for one owned by another business that you reach by invitation. A guest organisation is managed by its own account: you can open it, never administer it here. additionalProperties: false description: One organisation as it appears in your account's list. 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.