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

# Get Users

> Returns a paginated list of users



## OpenAPI

````yaml /openapi.json get /sites/{site}/users
openapi: 3.1.0
info:
  title: tinyanalytics API
  version: 1.0.0
  description: >-
    The tinyanalytics HTTP API. Read your analytics, manage sites and goals, and
    drive feature flags, experiments, and surveys. Every call is authenticated
    with an API key sent as `Authorization: Bearer <key>`.
servers:
  - url: https://dash.tinyanalytics.io/api
security:
  - bearerAuth: []
tags:
  - name: sites
    x-group: Sites
    description: >-
      Read and update a site, its tracking config, its exclusions, and its
      private link.
  - name: organizations
    x-group: Organizations
    description: >-
      List the organizations you belong to and the sites inside them, and create
      new sites.
  - name: overview
    x-group: Overview
    description: Headline metrics, time series, and dimension breakdowns for a site.
  - name: events
    x-group: Events
    description: Custom events, their property breakdowns, and the live event log.
  - name: errors
    x-group: Errors
    description: JavaScript errors captured from your site, grouped by error name.
  - name: goals
    x-group: Goals
    description: >-
      Define, measure, and manage conversion goals matched on a page path or
      event name.
  - name: funnels
    x-group: Funnels
    description: Build and measure multi-step conversion funnels, including step drop-off.
  - name: revenue
    x-group: Revenue
    description: Revenue totals and breakdowns from the revenue you attach to events.
  - name: performance
    x-group: Performance
    description: Core Web Vitals for a site, over time and broken down by dimension.
  - name: sessions
    x-group: Sessions
    description: The session list and the full pageview and event timeline of one session.
  - name: users
    x-group: Users
    description: The identified-user list and one user's profile, activity, and sessions.
  - name: user-traits
    x-group: User Traits
    description: Read and write the traits attached to an identified user.
  - name: segments
    x-group: Segments
    description: Saved filter sets you can apply across reports.
  - name: cohorts
    x-group: Cohorts
    description: Behavioral cohorts defined by the actions visitors took.
  - name: groups
    x-group: Groups
    description: Group analytics — accounts, companies, or workspaces a user belongs to.
  - name: catalog
    x-group: Catalog
    description: >-
      The inventory of event names, event properties, and traits seen on a site,
      with their descriptions and verified marks.
  - name: bots
    x-group: Bots
    description: Bot and AI-crawler traffic, including the per-layer detection counts.
  - name: alerts
    x-group: Alerts
    description: Threshold alerts that notify you when a metric moves.
  - name: annotations
    x-group: Annotations
    description: Dated notes drawn on your dashboard charts to mark what changed.
  - name: surveys
    x-group: Surveys
    description: In-product surveys and their responses.
  - name: feature-flags
    x-group: Feature Flags
    description: Feature flags, their rollout rules, and flag evaluation for a given user.
  - name: experiments
    x-group: Experiments
    description: A/B experiments built on feature flags, and their results.
  - name: dashboards
    x-group: Dashboards
    description: Custom dashboards and the widgets on them.
  - name: custom-query
    x-group: Custom Query
    description: Run read-only SQL against your site's analytics data.
  - name: reports
    x-group: Reports
    description: Scheduled email report subscriptions, including sending one on demand.
  - name: search-console
    x-group: Search Console
    description: Google Search Console search analytics for a connected site.
  - name: uptime-monitors
    x-group: Uptime — Monitors
    description: HTTP and TCP uptime monitors and their check history.
  - name: uptime-channels-incidents
    x-group: Uptime — Channels & Incidents
    description: >-
      Uptime notification channels and the incidents raised against your
      monitors.
  - name: retention-journeys
    x-group: Retention & Journeys
    description: Cohort retention curves and the page-to-page paths visitors take.
paths:
  /sites/{site}/users:
    get:
      tags:
        - users
      summary: Get Users
      description: Returns a paginated list of users
      operationId: get-sites-site-users
      parameters:
        - name: site
          in: path
          required: true
          description: Site ID.
          schema:
            type: integer
        - name: start_date
          description: Start of the range, as `YYYY-MM-DD`.
          schema:
            type: string
            format: date
          in: query
          required: false
        - name: end_date
          description: End of the range, as `YYYY-MM-DD`.
          schema:
            type: string
            format: date
          in: query
          required: false
        - name: time_zone
          description: IANA time zone used to bucket the range, e.g. `America/New_York`.
          schema:
            type: string
            example: America/New_York
          in: query
          required: false
        - name: filters
          description: >-
            JSON-encoded array of filter objects, each `{ dimension, op, value
            }` where `value` is an array. Example:
            `[{"dimension":"country","op":"equals","value":["US"]}]`.
          schema:
            type: string
          in: query
          required: false
        - name: page
          in: query
          required: false
          description: 'Example: 1.'
          schema:
            type: integer
        - name: page_size
          in: query
          required: false
          description: 'Example: 10.'
          schema:
            type: integer
        - name: sort_by
          in: query
          required: false
          schema:
            type: string
            enum:
              - first_seen
              - last_seen
              - pageviews
              - sessions
              - events
        - name: sort_order
          in: query
          required: false
          schema:
            type: string
            enum:
              - asc
              - desc
        - name: identified_only
          in: query
          required: false
          schema:
            type: string
            enum:
              - 'true'
              - 'false'
        - name: search
          in: query
          required: false
          description: 'Example: Search users.'
          schema:
            type: string
        - name: search_field
          in: query
          required: false
          schema:
            type: string
            enum:
              - username
              - name
              - email
              - user_id
      responses:
        '200':
          description: Success.
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  responses:
    Unauthorized:
      description: Missing or invalid API key.
    Forbidden:
      description: The key is valid but its owner cannot access this site.
    RateLimited:
      description: Too many requests. Retry after a pause.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        An API key created in your account settings, sent as `Authorization:
        Bearer <key>`.

````

## Related topics

- [Identify Users Across Sessions and Devices](/docs/user-identification-analytics.md)
- [Stripe Revenue Analytics Integration](/docs/stripe-revenue-analytics.md)
- [User Analytics](/docs/user-analytics.md)