GET api/SIMs?phoneNumber={phoneNumber}

Get a specific SIM by Phone Number

Request Information

URI Parameters

Name	Description	Type	Additional information
phoneNumber	The Phone Number of the SIM to get	string	Required

Body Parameters

None.

Response Information

Resource Description

object with SIM matching the search

GetSIMResponse

Name	Description	Type	Additional information
SIMs	Array of SIMs	Collection of SIMStruct	None.
Messages	Array of messages	Collection of Message	None.
ServerInformation	Relevant information regarding the Server	ServerInformation	None.
VersionInformation	Relevant information regarding the API's version	VersionInformation	None.

Response Formats

application/json, text/json, text/html

Sample:

{
  "SIMs": [
    {
      "ID": 1,
      "SerialNumber": "sample string 2",
      "PhoneNumber": "sample string 3",
      "Plan": "sample string 4",
      "State": 0,
      "CommsInterfaceID": 1
    },
    {
      "ID": 1,
      "SerialNumber": "sample string 2",
      "PhoneNumber": "sample string 3",
      "Plan": "sample string 4",
      "State": 0,
      "CommsInterfaceID": 1
    }
  ],
  "Messages": [
    {
      "Severity": 0,
      "MessageCode": 1,
      "CodeDesc": 2,
      "MessageText": "sample string 3",
      "RecordNumber": 4
    },
    {
      "Severity": 0,
      "MessageCode": 1,
      "CodeDesc": 2,
      "MessageText": "sample string 3",
      "RecordNumber": 4
    }
  ],
  "ServerInformation": {
    "CurrentTimeUTC": "2025-11-09T21:27:47.1297755+10:00",
    "BuildDateUTC": "2025-11-09T21:27:47.1297755+10:00"
  },
  "VersionInformation": {
    "Major": 1,
    "Minor": 8,
    "Hotfix": 0,
    "Beta": true,
    "Version": "1.8.0.BETA"
  }
}