---
title: "Gets multiple users"
method: GET
path: "/users"
tags: ["User"]
---

# Gets multiple users

`GET /users`

## Request

- Base URL: `https://eliq.data-management-api.eliq.com` (the document declares no server; this is the origin it was published from)
- URL: `https://eliq.data-management-api.eliq.com/users`
- Auth: none declared
- TypeScript: <https://skmtc.dev/eliq/apis/eliq-data-management-api/docs/users/get.ts> (a function with typed inputs; its response is checked against the schema)

Users are fetched in batches of maximum 1000 users, and returned in created date order.
Using parameters after_id and limit can be used to iterate over the full user base.
Parameter created_after can also be used to fetch users after a certain date.

## Query parameters

- `after_id` string
- `limit` integer
- `created_after` string

## Response `200`

OK

- User[]
  - `id` string, nullable
  - `eliq_id` integer, nullable
  - `name` string, nullable
  - `email` string, nullable
  - `phone` string, nullable
  - `language_code` string, nullable
  - `locations` Location[], nullable
    - `id` string, nullable
    - `eliq_id` integer, nullable
    - `name` string, nullable
    - `user_id` string, nullable
    - `spot_price_region_id` string, nullable
    - `address` LocationAddress
      - `street_address` string, nullable
      - `postal_code` string, nullable
      - `city` string, nullable
      - `country_code` string, nullable
    - `geo` LocationGeo
      - `latitude` number, double, nullable
      - `longitude` number, double, nullable
    - `meters` Meter[], nullable
      - `id` string, nullable
      - `eliq_id` string, nullable
      - `location_id` string, nullable
      - `name` string, nullable
      - `model` string, nullable
      - `fuel` string, nullable
      - `type` string, nullable
      - `is_sub_meter` boolean, nullable
      - `category` string, nullable
      - `category_percentage` integer, nullable
      - `supply_start_date` string, nullable
      - `supply_end_date` string, nullable
      - `created_at_timestamp` string, nullable
      - `sync_status` string, nullable
    - `created_at_timestamp` string, nullable
    - `location_profile_type` 'residential' | 'business' | 'undefined'
  - `created_at_timestamp` string, nullable

## Other responses

- `400`: Bad Request
- `500`: Internal Server Error

---

[API](https://skmtc.dev/eliq/apis/eliq-data-management-api.md) - [All operations](https://skmtc.dev/eliq/apis/eliq-data-management-api/llms.txt) - [OpenAPI document](https://skmtc.dev/eliq/apis/eliq-data-management-api/revisions/022af911e0d0?raw)