AutoQueryable Syntax

Many of our end points support AutoQueryable syntax. The maximum number of items returned by a query is limited to 250. The following query returns a list of companies that you have access to, ordered by name. The output is wrapped with additional information containing the total count of companies that you have access to. (Typically you will have access to only one company).

https://api.cellhire.com/api/company?wrapWith=total-count&orderBy=name (opens in a new tab)

Please note that although we do provide a method for you to get a list of SIMs or an individual SIM, the response will contain only very basic information about the SIM. If you want to check what bars or features are in place, you will need to submit a SIM status request instead. See section 3 for how to create a job submission. It should be rare that you would ever need to call the endpoints below but we include some examples for completeness and to illustrate how AutoQueryable syntax works. To return 100 SIMs, ordered by serial number, skipping the first 200 SIMs:

https://api.cellhire.com/api/company/your_company_number/sim?orderBy=serialNumber&skip=200&take=100&wrapWith=total-count,count (opens in a new tab)

If you need to fetch an individual SIM, we recommend the following query for maximum efficiency:

https://api.cellhire.com/api/sim/1234567890 (opens in a new tab)

However, it is also possible to return similar results using query syntax: https://api.cellhire.com/api/sim?serialNumber=1234567890 (opens in a new tab)