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

# List newer reports

> Lists the newer reports the company's plan includes, with their views, formats, periods, limits and filters, in the company's language. Admins, operators and the company key may call it; workers get 403 permission_denied. jobs, form-answers and visit-report need a Dispatch plan (403 on a Location plan). Same {data, error, meta} envelope; errors here use the codes invalid_request (400), permission_denied (403) and internal_error (500).



## OpenAPI

````yaml v1/openapi.json GET /reports/catalog
openapi: 3.1.0
info:
  title: Hellotracks REST API
  version: '1'
  description: >-
    Plain REST resources over HTTPS, for tools, automations and services. The ht
    command line is built on it.
  contact:
    email: api@hellotracks.com
servers:
  - url: https://api.hellotracks.com/v1
security:
  - ApiKey: []
tags:
  - name: Sign-up and sign-in
    description: >-
      Create a company or get an API key by an emailed code, without a key; and
      check which account a key belongs to.
  - name: Company
    description: The company the API key belongs to, with its settings and teams.
  - name: Members
    description: 'The people in the company: admins, operators and workers.'
  - name: API keys
    description: 'The company''s API keys: list, create, revoke and delete.'
  - name: Jobs
    description: 'Jobs: work at a location on a date, assigned to a member.'
  - name: Places
    description: 'Places: customer sites and other saved locations with a check-in radius.'
  - name: Zones
    description: 'Zones: the company''s geofences.'
  - name: Routing
    description: Route optimization for one member's day.
  - name: ETA pages
    description: >-
      Live ETA pages (eta.page links) that show a job's recipient when the
      worker arrives.
  - name: Maps
    description: Rendered maps as GeoJSON, and public map share links.
  - name: Timesheets
    description: Clock-in and clock-out entries of members, with totals, and editing them.
  - name: Forms
    description: >-
      Form templates, submitted forms, attachments for file and image fields,
      and forms linked to places and jobs.
  - name: Alerts
    description: >-
      Alert rules (configs) that watch members, places and zones, and the alerts
      (instances) they raised.
  - name: Reports
    description: >-
      Reports: the newer reporting API (catalog, preview, run, saved) and the
      older one (types, generate, jobs, uploads, recurring).
  - name: Webhooks
    description: URLs Hellotracks calls when jobs, check-ins, clock-ins or alerts happen.
paths:
  /reports/catalog:
    get:
      tags:
        - Reports
      summary: List newer reports
      description: >-
        Lists the newer reports the company's plan includes, with their views,
        formats, periods, limits and filters, in the company's language. Admins,
        operators and the company key may call it; workers get 403
        permission_denied. jobs, form-answers and visit-report need a Dispatch
        plan (403 on a Location plan). Same {data, error, meta} envelope; errors
        here use the codes invalid_request (400), permission_denied (403) and
        internal_error (500).
      operationId: listReportCatalog
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Envelope'
                properties:
                  data:
                    type: object
                    properties:
                      reports:
                        type: array
                        items:
                          $ref: '#/components/schemas/ReportCatalogEntry'
              example:
                data:
                  reports:
                    - id: timesheet
                      title: Timesheet
                      question: How long did everyone work?
                      views:
                        - id: perPerson
                          title: Per person
                        - id: entries
                          title: Entries
                      scopes:
                        - people
                      formats:
                        - xlsx
                        - pdf
                        - csv
                        - json
                      defaultFormat: xlsx
                      defaultPeriod: lastWeek
                      periods:
                        - today
                        - yesterday
                        - thisWeek
                        - lastWeek
                        - thisMonth
                        - lastMonth
                        - last7Days
                        - last30Days
                      maxDays: 120
                      replacesClassic:
                        - timesheet
                      csvIgnoresView: false
                      filters: []
                      columns: true
                error: null
                meta:
                  path: /v1/reports/catalog
                  method: GET
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
components:
  schemas:
    Envelope:
      type: object
      properties:
        data:
          description: The payload.
        error:
          type: 'null'
        meta:
          $ref: '#/components/schemas/Meta'
    ReportCatalogEntry:
      type: object
      description: One of the newer reports.
      properties:
        id:
          type: string
          enum:
            - team-week
            - jobs
            - place-visits
            - timesheet
            - mileage
            - alerts
            - form-answers
            - visit-report
        title:
          type: string
          description: In the company's language.
        question:
          type: string
          description: The question the report answers.
        views:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              title:
                type: string
          description: >-
            team-week: summary; jobs: list, route; place-visits: perPlace,
            perPerson, visits; timesheet: perPerson, entries; mileage:
            perPerson, trips; alerts: perRule, list; form-answers: list;
            visit-report: job.
        scopes:
          type: array
          items:
            type: string
            enum:
              - people
              - places
              - job
              - form
          description: >-
            What a request may narrow: people (who), places, one job (jobId),
            one form (options.formId).
        formats:
          type: array
          items:
            type: string
            enum:
              - pdf
              - xlsx
              - csv
              - json
        defaultFormat:
          type: string
          enum:
            - pdf
            - xlsx
            - csv
            - json
        defaultPeriod:
          type: string
          description: Empty for visit-report.
        periods:
          type: array
          items:
            type: string
            enum:
              - today
              - yesterday
              - thisWeek
              - lastWeek
              - thisMonth
              - lastMonth
              - last7Days
              - last30Days
          description: Empty when the report has no period (visit-report).
        maxDays:
          type: integer
          description: >-
            Longest period in days; 0 = no period. team-week and jobs 92, the
            others 120.
        replacesClassic:
          type: array
          items:
            type: string
          description: Older report types (GET /reports/types) this report replaces.
        csvIgnoresView:
          type: boolean
        filters:
          type: array
          description: >-
            Record filters, sent comma-separated in options.<key> (jobs:
            options.status = open,done,issue,rejected).
          items:
            type: object
            properties:
              key:
                type: string
              title:
                type: string
              choices:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                    title:
                      type: string
        columns:
          type: boolean
          description: >-
            Whether columns can be picked with options.columns (jobs,
            form-answers, place-visits, mileage, timesheet).
    Meta:
      type: object
      properties:
        path:
          type: string
          description: The request path, without /v1.
          example: /jobs
        method:
          type: string
          example: GET
    ErrorEnvelope:
      type: object
      properties:
        data:
          type: 'null'
        error:
          $ref: '#/components/schemas/Error'
        meta:
          $ref: '#/components/schemas/Meta'
    Error:
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: string
          description: Stable error code for programs.
          enum:
            - invalid_request
            - invalid_format
            - invalid_data
            - invalid_api_key
            - unknown_user
            - authentication_failed
            - forbidden
            - not_found
            - already_exists
            - throttled
            - not_ready
            - clock_invalid
            - force_logout
            - internal_error
            - unknown_error
        message:
          type: string
          description: Why it failed, for people.
  responses:
    Unauthorized:
      description: The API key is missing or invalid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          example:
            data: null
            error:
              code: invalid_api_key
              message: Invalid Hellotracks API key.
            meta:
              path: /jobs
              method: GET
    Forbidden:
      description: The key may not do this.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          example:
            data: null
            error:
              code: forbidden
              message: No permission.
            meta:
              path: /jobs
              method: GET
    TooManyRequests:
      description: Too many requests; slow down.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          example:
            data: null
            error:
              code: throttled
              message: Too many requests.
            meta:
              path: /jobs
              method: GET
    ServerError:
      description: Hellotracks failed; retry later.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          example:
            data: null
            error:
              code: internal_error
              message: Hellotracks API is temporarily unavailable.
            meta:
              path: /jobs
              method: GET
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: API-Key
      description: >-
        Your API key, from More → API & Integrations in the dashboard, or from
        ht signup / ht auth login.

````

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