---
title: "List the members of a data pool"
method: GET
path: "/v1/data-pools/{poolId}/members"
tags: ["Data Pools"]
---

# List the members of a data pool

`GET /v1/data-pools/{poolId}/members`

## Request

- Base URL: `https://api.telgea.com`
- URL: `https://api.telgea.com/v1/data-pools/{poolId}/members`
- Auth: API key in header `x-api-key`

Retrieves every user drawing on a data pool, with the data each has taken from it.

Use this to attribute a pool's consumption to individual customers. `usageBytes` is the member's usage across all their lines, repeated on each of their rows, so count it once per `userId` rather than summing the rows.

A pool belonging to another organization answers `404`, not `403`.

**Scope:** `pools:read`.

## Path parameters

- `poolId` string, uuid, required: UUID of the data pool

## Response `200`

Successfully retrieved the pool members and their usage.

- ListPoolMembersResponse
  - `poolId` string, required: UUID of the pool these members draw on.
  - `members` PoolMember[], required: Every line drawing on this pool.
    - `userId` string, required: UUID of the user drawing on the pool
    - `msisdn` string, nullable, required: Phone number in E.164 format
    - `numberType` 'local' | 'travel' | 'null', nullable, required: Which line draws on the pool
    - `firstName` string, nullable, required: First name of the user holding the line, or null.
    - `lastName` string, nullable, required: Last name of the user holding the line, or null.
    - `email` string, nullable, required: Email address of the user holding the line, or null.
    - `activationDate` string, required: Date the member joined the pool (YYYY-MM-DD)
    - `terminationDate` string, nullable, required: Date the member left the pool (YYYY-MM-DD). Null while the line is still drawing on it.
    - `usageBytes` number, required: Bytes the member has drawn from the pool across all their lines. A member with several lines is listed once per line, each row carrying the same total, so add it once per userId.

## Other responses

- `400`: Request failed schema validation, or was refused by a business rule
- `401`: Missing or invalid API key in the X-API-Key header
- `403`: Insufficient permissions to view data pools
- `404`: No data pool in your organization has this id
- `429`: The API key has used its request quota for the current window. `Retry-After` says how many seconds until it resets.
- `500`: Internal server error. Contact support if this persists.

---

[API](https://skmtc.dev/telgea/apis/telgea-api.md) - [All operations](https://skmtc.dev/telgea/apis/telgea-api/llms.txt) - [OpenAPI document](https://skmtc.dev/telgea/apis/telgea-api/revisions/4e8f8c04fe9e?raw)