TEtelgea
User Plans

Search for a user plan

Search for a user plan by email address, phone number (MSISDN), or ICCID (SIM card identifier). This endpoint is useful for looking up user plans when you only have contact identifiers.

Exactly one search parameter (email, msisdn, or iccid) must be provided.

The phone number must be in E.164 format (e.g., +4520123456).

get/v1/user-plans/search

Request

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

Query parameters

emailstring email

Email address of the user to search for

Example:user@example.com
msisdnstring

Phone number in E.164 format to search for

Example:+4520123456
iccidstring

ICCID (SIM card identifier) to search for

Example:8944500102198304826

Response

Successfully found the user plan. Returns the same detailed information as the get user plan details endpoint.

userIdstring required

UUID of the user who holds the plan.

emailstring email required

Email address of the user.

firstNamestring required

First name of the user.

lastNamestring required

Last name of the user.

status'INACTIVE' | 'PROVISIONING' | 'PORTING' | 'PORTING_FAILED' | 'ACTIVE' | 'TERMINATING' | 'TERMINATING_WITH_DELETION' required

Current status of the user plan

teamIdstring nullable required

UUID of the user's team, or null. Teams are an enterprise concept and stay null for partners.

terminationScheduledAtstring nullable required

The date this plan is scheduled to end, or null when no termination is scheduled. Set by POST /v1/user-plans/{userId}/termination.

Example response

{
  "userId": "9c1f2a6e-3b7d-4e0a-8f21-5d6c7b8a9e01",
  "email": "anna.holm@acme.example",
  "firstName": "Anna",
  "lastName": "Holm",
  "status": "ACTIVE",
  "teamId": "2f6b0d3a-8c1e-4a7f-9b2d-1e3c4d5f6a70",
  "localNumber": {
    "id": "8238c1b9-c2c0-4455-9b03-4bd787052709",
    "type": "local",
    "countryCode": "DK",
    "phoneNumber": "+4520123456",
    "state": "READY",
    "sim": {
      "iccid": "8945000000000000001",
      "activationCode": "LPA:1$SMDP.TELGEA.COM$34682-73063-9140",
      "pinOne": "1234",
      "pinTwo": "5678",
      "pukOne": "12345678",
      "pukTwo": "87654321"
    }
  },
  "travelNumber": {
    "id": "81ec0bc5-b200-436d-bb70-d563ca2348d4",
    "type": "travel",
    "phoneNumber": "+4520123456",
    "state": "READY",
    "sim": {
      "iccid": "8945000000000000001",
      "activationCode": "LPA:1$SMDP.TELGEA.COM$34682-73063-9140",
      "pinOne": "1234",
      "pinTwo": "5678",
      "pukOne": "12345678",
      "pukTwo": "87654321"
    }
  },
  "terminationScheduledAt": "2026-10-01T00:00:00.000Z"
}

Changes

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