TEtelgea
User Plans

List all user plans

Retrieves a paginated list of user plans in your organization. A user plan represents the association between a user and their telecommunications resources (SIM cards, phone numbers, data plans).

Use filters to narrow results by user, team, or plan status. Supports pagination for large datasets.

get/v1/user-plans

Request

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

Query parameters

pageinteger

Page to return, starting at 1.

Example:1
pageSizeinteger

Items per page, at most 100. Defaults to 50.

Example:50
orderBy'firstName' | 'localPhoneNumber' | 'status' | 'teamName'

Field to sort by. Defaults to the order the plans were created in.

Example:firstName
orderDirection'asc' | 'desc'

Sort direction. Only meaningful together with orderBy.

Example:asc

Response

Successfully retrieved user plans. Returns a paginated list with total count and plan details.

pageinteger required

The page these items came from.

pageSizeinteger required

Items per page, as requested.

itemsCountinteger required

Total items across all pages. Divide by pageSize to get the number of pages.

Example response

{
  "page": 1,
  "pageSize": 50,
  "itemsCount": 142,
  "items": [
    {
      "id": "f7a8b9c0-d1e2-3456-f789-012345678901",
      "userId": "9c1f2a6e-3b7d-4e0a-8f21-5d6c7b8a9e01",
      "firstName": "Anna",
      "lastName": "Holm",
      "email": "anna.holm@acme.example",
      "status": "ACTIVE",
      "localPhoneNumber": "+4520123456",
      "teamId": "2f6b0d3a-8c1e-4a7f-9b2d-1e3c4d5f6a70",
      "teamName": "Field Sales"
    }
  ]
}

Changes

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