Data Pools

List the members of a data pool

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.

get/v1/data-pools/{poolId}/members

Request

  • Base URL
    https://api.telgea.com
  • Auth
    API key in header x-api-key

Path parameters

poolIdstring uuid required

UUID of the data pool

Example:6b9a0c74-51d2-4e83-9f16-2a7c8d0e5b34

Response

Successfully retrieved the pool members and their usage.

poolIdstring required

UUID of the pool these members draw on.

Example response

{
  "poolId": "6b9a0c74-51d2-4e83-9f16-2a7c8d0e5b34",
  "members": [
    {
      "userId": "9c1f2a6e-3b7d-4e0a-8f21-5d6c7b8a9e01",
      "msisdn": "+4520123456",
      "numberType": "local",
      "firstName": "Anna",
      "lastName": "Holm",
      "email": "anna.holm@acme.example",
      "activationDate": "2026-09-01",
      "terminationDate": "2026-12-31",
      "usageBytes": 10485760
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.