> ## 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 a dataset's full field catalog



## OpenAPI

````yaml /api-reference/specs/report.json get /datasets/{name}
openapi: 3.0.1
info:
  title: Report Service
  description: Customisable reporting API for FlowPayroll.
  contact:
    name: FlowPayroll
    email: hello@flowpayroll.com
  version: v1
servers:
  - url: https://api.sandbox.flowpayroll.ai/v1/report
security:
  - X-Auth-Token: []
    X-Org-Id: []
tags:
  - name: Datasets
    description: >-
      Discover what you can query: list the available datasets and inspect each
      field catalog — types, filterability, groupability, and supported
      aggregations.
  - name: Run reports
    description: >-
      Run a report synchronously — either an inline report definition or a saved
      one — and get columns and rows back in the response.
  - name: Report definitions
    description: >-
      Save a report definition under a name so it can be re-run, exported, and
      scheduled. Create, list, retrieve, replace, and delete definitions.
  - name: Exports
    description: >-
      Queue large result sets as asynchronous exports (CSV or JSONL, up to
      5,000,000 rows) and poll for a presigned download URL.
  - name: Schedules
    description: >-
      Run a saved definition on a cron schedule and deliver the export by
      webhook or email.
  - name: Run history
    description: Audit trail of every report run — synchronous, export, and scheduled.
paths:
  /datasets/{name}:
    get:
      tags:
        - Datasets
      summary: Get a dataset's full field catalog
      operationId: getDataset
      parameters:
        - name: name
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Dataset with its queryable fields
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Dataset'
        '401':
          $ref: '#/components/responses/Unauthorised'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  schemas:
    Dataset:
      type: object
      required:
        - name
        - description
        - fields
      properties:
        name:
          type: string
        description:
          type: string
        fields:
          type: array
          items:
            $ref: '#/components/schemas/DatasetField'
    DatasetField:
      type: object
      required:
        - name
        - type
        - filterable
        - groupable
        - aggregatable
        - sensitive
      properties:
        name:
          type: string
          description: >-
            Field name; dotted names (employee.department) reach related
            entities
        type:
          type: string
          description: >-
            string | integer | decimal | date | timestamp | boolean | tags
            (array of group:name:value strings; filter with contains/isNull
            only)
        filterable:
          type: boolean
        groupable:
          type: boolean
        aggregatable:
          type: array
          items:
            type: string
            enum:
              - sum
              - avg
              - min
              - max
              - count
          description: Aggregations this field supports
        sensitive:
          type: boolean
          description: Access is recorded in the run audit trail
    ServiceError:
      type: object
      required:
        - error
        - message
      properties:
        error:
          type: string
        message:
          type: string
  responses:
    Unauthorised:
      description: No organisation context on the request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ServiceError'
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ServiceError'
  securitySchemes:
    X-Auth-Token:
      type: apiKey
      description: FlowPayroll JWT (raw token, no Bearer prefix)
      name: X-Auth-Token
      in: header
    X-Org-Id:
      type: apiKey
      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).
      name: X-Org-Id
      in: header

````