Methods

AddAutoEnrollmentGroupsForAddIn (...)

Adds auto-enrollment groups for a Device Add-In on a specific database. Devices in the listed groups will be auto-enrolled in the Add-In going forward, in line with MyGeotab's auto-enrollment behaviour. Only reseller users can call this method. Use GetAvailableAutoEnrollmentGroups to discover valid group IDs for a database. Groups already configured for the Add-In are accepted by MyGeotab and treated as a no-op for that group. is required: null, empty, or entries that are null/whitespace will be rejected with a MyAdminException.

MyGeotab groups are hierarchical. Adding a parent group ID implicitly includes all of its descendant (child) groups — devices in any child group will also be auto-enrolled. Pass only the highest-level group ID needed; there is no need to enumerate child groups individually.

AddEditCustomerAsync (...)

Adds or edits a customer.

Authenticate (...)

Authenticates the user and returns the required API Key and Session ID, used for all subsequent API calls. If too much time has elapsed between subsequent API calls, calling other methods will throw a SessionExpiredException. When this occurs, call Authenticate to obtain a new session ID. Session ID expires after one week.

BlockAddIn (...)

Blocks a Device Add-In on a specific database. Clears any auto-enrollment configuration (including auto-enrollment groups), unenrolls every currently enrolled device, then sets the Add-In status to Blocked in MyGeotab and MyAdmin. Only reseller users can call this method. This is the same operation exposed by the L1 Device Add-In Management UI's "Block" action; it is intended for programmatic blocking without visiting the MyAdmin UI. Use UnblockAddIn to reverse this operation and restore the Add-In to the Active state.

Idempotent: if the Add-In is already Blocked the call returns Success=true without re-issuing MyGeotab calls or unenrollment work.

CalculateVinOemEligibilities (...)

Checks whether the given vehicles are eligible for OEM telematics support in the specified region.

CancelDeviceTerminationAsync (...)

Submits requests to cancel pending terminations for the provided devices.

CancelOrder (...)

Cancels an order at anytime before or after completion. If the order has already shipped an RMA request will be automaticly generated and a returns of ApiRmaRequest objects is return otherwise a null result is return. If orderId is specified the order is canceled by orderId and forAccount, otherwise specify forAccount with purchaseOrderNo to cancel order.

ChangeDeviceBillingPlan (...)

Submits a request to change the billing plan (ApiDevicePlan) for the provided device.

ChangeDeviceBillingPlanBulkAsync (...)

Submits a request to change the billing plan (ApiDevicePlan) for the provided devices.

CreateRmaRequest (...)

Creates an RMA request and returns a ApiRmaRequest.

DeactivateAddIn (...)

Deactivates a Device Add-In on a specific database. Clears any auto-enrollment configuration (including auto-enrollment groups), unenrolls every currently enrolled device, then sets the Add-In status to Inactive in MyGeotab and MyAdmin. Only reseller users can call this method. This is the same operation exposed by the L1 Device Add-In Management UI's "Deactivate" action; it is intended for programmatic deactivation without visiting the MyAdmin UI. Re-activation is not part of this API — use the existing install/enrollment APIs to re-enable the Add-In on the database.

Idempotent: if the Add-In is already Inactive the call returns Success=true without re-issuing MyGeotab calls or unenrollment work.

EditUserContact (...)

Adds or updates a user contact. The ApiUserContact must contain a valid country name and where applicable, a valid state name. Exceptions will be thrown if the country or state is invalid. A valid list of countries can be retrieved by calling GetCountries. A valid list of states for a country can be retrieved by calling GetStates - if no states are returned, then any state name will be accepted for that country. The ApiUserContact parameter must contain a ApiUserCompany. If the company does not already exist, the ID field should be set to 0 and a new company will be created. If the ID is greater than zero, the existing company will be updated. The ApiUserCompany must contain a ApiAccount with a valid account ID.

EnrollAllDevicesFromAddIn (...)

Enrolls all eligible devices in a database into a Device Add-In. The work is queued for background processing; per-device results are not returned synchronously. Only reseller users can call this method.

EnrollDeviceFromAddIn (...)

Enrolls one or more devices into a Device Add-In. Handles billing account resolution and rate plan assignment automatically. Only reseller users can call this method.

ForceChangePasswordForUsersAsync (...)

API to bulk update ForceChangePassword for users

GetAttachmentBinary (...)

Get the byte array of the Attachment

GetAvailableAutoEnrollmentGroups (...)

Returns the auto-enrollment groups available for selection when configuring a Device Add-In on a database. Use this before calling the Add/Remove auto-enrollment groups APIs to discover the set of valid group IDs for a database. Only reseller users can call this method. Groups are database-scoped in MyGeotab and are not constrained by Add-In — every group in the database is a valid auto-enrollment candidate for any Add-In installed on that database, so no solutionId is required.

GetAvailableProducts (...)

Returns an array of ApiProductAndPricing available to an account.

GetBundleComponentsAsync (...)

Returns the bundle template(s) and available component products for an account. When bundleProductCode is provided, returns the template for that specific bundle. When bundleProductCode is empty or null, returns all available bundle templates for the account. Use the returned component IDs and available product codes when constructing ApiBundleComponentSelection entries for the PostOrder method. Product entries include compatibility hints for constructing valid device, harness, and install-service combinations; PostOrder remains the final validation authority. Each template's ProductDependencies lists required products that PostOrder automatically adds, zero-priced, when a retained product needs them. A product is omitted from the results when one of its required products cannot be ordered by the account. Only available when the PostOrderApiBundleSupport feature flag is enabled.

GetCountries (...)

Returns a list of valid country names.

GetCurrentDeviceDatabases (...)

Returns an array of ApiDeviceDatabaseExtended containing devices and their current databases and VINs (if available) for the specified account. The result set is limited to 1000 records. If the result set contains 1000 records, call GetCurrentDeviceDatabases again passing the Id of the last record in the current set as the nextId parameter.

GetCustomersAsync (...)

Gets a list of customers for the provided filters. Returns in pages of 50 records.

GetDatabaseTransactions (...)

Returns an array of ApiDatabaseTransaction objects for any database-level plans (eg. Data Connector, Data Science Package) for the given period and filters. Supports offset pagination when called via the v3 endpoint.

GetDeviceAddInDetails (...)

Returns device-level enrollment details for a specific Add-In and database. Provides a Level 2 view: one entry per device with enrollment status, plan, and billing details.

GetDeviceAddInEnrollmentAuditLogs (...)

Returns enrollment audit logs for an Add-In on a database. Newest events first. when no paginationContext is provided, returns up to MaxApiPageSize rows in a single response (optimised for "download all" workflows). Explicitly set perPage to paginate; perPage is capped at MaxApiPageSize. If a page returns exactly MaxApiPageSize rows, request the next page until you receive fewer.

Example — fetch up to MaxApiPageSize rows:

GetDeviceAddIns (...)

Returns a list of Device Add-Ins for a given account, with optional filters by database, Add-In name/solution ID, and status. Provides a Level 1 view: one entry per Add-In per database, including enrolled device counts and auto-enrollment details.

GetDeviceContractAutoRequests (...)

Gets the device contract request history for the given user and account.

GetDeviceContractCreditTransactions (...)

Returns an array of ApiDeviceContractCreditTransaction objects for the given period and filters.

GetDeviceContractEarlyTerminationFees (...)

Returns an array of ApiDeviceContractEarlyTerminationFee objects representing early termination fee charges for the given billing period.

GetDeviceContractTransactions (...)

Returns an array of ApiDeviceContractTransaction objects for the given period and filters. If nextId is specified, the result set is limited to 1000 records. To obtain the first set of records, pass 0 into nextId. If the result set contains 1000 records, call GetDeviceContractTransactions again passing the Id of the last record in the current result set as the nextId parameter.

GetDeviceContracts (...)

Returns an array of ApiDeviceContract. This method returns all contracts that are active within the specified date range, filtered based on other parameters.

GetDeviceContractsByPage (...)

Returns an array of ApiDeviceContract. This method returns all contracts that are active within the specified date range, filtered based on other parameters. The result set is limited to 1000 records. To obtain the first set of records, pass 0 into nextId. If the result set contains 1000 records, call GetDeviceContracts again passing the Id of the last record in the current result set as the nextId parameter. This method returns device contracts that are active during the specified date range.

GetDeviceDatabaseNamesAsync (...)

Returns an array of ApiDeviceDatabaseOwnerShared containing devices and their owner databases and shared databases (if available).

GetDeviceJurisdictionAsync (...)

Returns an array of ApiDeviceJurisdiction containing devices and their jurisdiction and dig url.

GetDeviceOrderEntries (...)

Returns an array of ApiDeviceOrderEntry containing status of orders.

GetDevicePlans (...)

Returns an array of active ApiDevicePlan, available to all assigned accounts.

GetDeviceTimelinesAsync (...)

Gets a list of device timelines ApiTimeline for the specified device.

GetGoEligibilityByMmy (...)

Returns GO device eligibility for vehicles matching the given make, model, and year. Supports offset pagination when called via the v3 endpoint.

GetGoEligibilityByVins (...)

Returns GO device eligibility for the specified vehicles, looked up by VIN. Supports offset pagination when called via the v3 endpoint.

GetHelpdeskAttachment (...)

Get a single Helpdesk Attachment Object in the comment of the ticket

GetHelpdeskAttachments (...)

Get all Helpdesk Attachment Objects in the comment of the ticket

GetHelpdeskComment (...)

Get a single comment of a Helpdesk Ticket

GetHelpdeskComments (...)

Get all comments of a Helpdesk Ticket

GetHelpdeskTicket (...)

Get Single Ticket from MyAdmin Helpdesk By TicketId and Account Number

GetHelpdeskTickets (...)

Get all tickets from MyAdmin Helpdesk By Account Number

GetIndustriesAsync (...)

Returns an array of valid Industry names.

GetInstallLogs (...)

Gets an array of ApiDeviceInstallResult. The method returns all install logs that occurred within the provided date range, filtered by the other parameters.

GetMake (...)

Returns all supported vehicle makes.

GetMinedVehicleData (...)

Returns vehicle specifications and harness installation compatibility for vehicles matching the given make, model, and year.

GetMinedVehicleDataByVins (...)

Returns vehicle specifications and harness compatibility for the specified vehicles, looked up by VIN.

GetModel (...)

Returns all supported models for the specified vehicle make.

GetMyInstallLogs (...)

Gets a list of InstallLog. The method returns all install logs that occurred within the provided date range, filtered by the other parameters.

GetOemSupportEligibilityForMake (...)

Checks whether vehicles from the specified make are eligible for OEM telematics support in the given region.

GetOnlineOrderStatus (...)

Returns an array of ApiOnlineOrder containing status of orders. If all of the following params (purchaseOrderNo, orderNo, orderDateFrom-orderDateTo) are null, last one month orders data will be returned by default.

GetOwnDatabases (...)

Finds a list of databases belonging to the specified account or all accounts associated with the calling user's accounts.

GetPartnerDeviceContractsAsync (...)

Returns a list of third party devices that the user's ERPs can manage.

GetReturnReasons (...)

Returns a list of ApiReturnReason used for Sales Return RMAs.

GetRmaRequestItems (...)

Gets an array of devices (ApiRmaRequestItem) that belong to a ApiRmaRequest.

GetRmaRequests (...)

Gets an array of active ApiRmaRequest for the specified account.

GetRmaTypes (...)

Returns a list of ApiRmaType.

GetRmas (...)

Gets an array of ApiRma for the specified account. If no deviceFilter or resellerReferenceFilter are specified, the method returns all active RMAs in the account. If a deviceFilter or resellerReferenceFilter are specified, the method returns the RMA(s) matching the filter(s), regardless of active status.

GetSecondaryTerminationReasons (...)

Returns an array of ApiDeviceContractRequestReason that are possible reasons for termination.

GetSharedDatabases (...)

Returns an array of ApiSharedDatabase containing databases the device has been assigned to and the type of relationship each one has with the device.

GetShippingFees (...)

Returns an array of shipping fees (used for Orders).

GetStates (...)

Returns an array of valid state names for a given country or an empty array if no states exist for the country. Throws ArgumentException if an invalid country name is provided.

GetSubscriptionsByPageAsync (...)

Returns a paginated list of subscriptions matching the provided filter criteria. This method supports filtering by ApiSubscriptionFilter and sorting by ApiSubscriptionSortColumn. The response outputs supported are ApiSubscriptionResult.

GetTerminationReasons (...)

Returns an array of ApiDeviceContractRequestReason that are possible reasons for termination.

GetUser (...)

Returns the user ApiUser, associated with a given email account.

GetUserContacts (...)

Returns an array of ApiUserContact for the API user, for the specified account.

GetVinOemEligibilityBatchResults (...)

Get the OEM eligibility results for a completed VIN OEM eligibility batch.

GetVinOemEligibilityBatchStatus (...)

Get the processing status of a submitted VIN OEM eligibility batch.

GetYear (...)

Returns all supported years for the specified vehicle make and model.

LogInstall (...)

Logs a device installation and returns the status of the device.

LookupDevice (...)

Returns current information relating to the device serial number provided.

PatchHelpdeskTicket (...)

Update an existing Helpdesk Ticket

PostHelpdeskAttachment (...)

Create a Helpdesk Attachment Object for a ticket

PostHelpdeskComment (...)

Creates a new comment on an existing Helpdesk ticket.

PostHelpdeskTicket (...)

Creates a new Helpdesk ticket through MyAdmin using the legacy (old) API.

PostOrder (...)

Posts a new order to MyAdmin. Create a ApiOrderHeader with details of the order. Required ApiOrderHeader fields are:

devicePlanLevel
forAccount
orderItems
purchaseOrderNumber
shipToId
shippingFeeId
warrantyOptionId

Note that an Order which contains OrderItems for which a Bulk Price exists may be adjusted for applicable Bulk Price discounts. To take advantage of these discounts, either post an order with the desired quantity at the normal purchase price (the discounts will be applied automatically) or post an order with exactly BulkPriceMinQuantity (see ApiProductPricing) quantity at the normal purchase price, and any additional quantity using the BulkPrice. Other combinations of order items may result in errors.

For bundle orders, the created order may include zero-priced child order items that were not in the request: products required by a retained bundle product (see ApiBundleTemplate.ProductDependencies from GetBundleComponentsAsync), evaluated independently for each bundle instance.

ProvisionDevice (...)

Provisions (creates, registers, and bills) a single third-party device — including OEM devices — to the authenticated user's default account.

ProvisionDeviceToAccount (...)

Provisions (creates, registers, and bills) a single third-party device — including OEM devices — to a specified customer account.

ProvisionDevicesBulk (...)

Provisions (creates, registers, and bills) one or more third-party devices — including OEM devices — to a customer account in a single call.

RegisterNewUser (...)

Registers a new user account into MyAdmin. An activation email will be sent to the user's email address.

RemoveAutoEnrollmentGroupsForAddIn (...)

Removes auto-enrollment groups for a Device Add-In on a specific database. Devices in the listed groups will no longer be auto-enrolled in the Add-In going forward. Only reseller users can call this method. by default ( omitted or true), devices that were previously auto-enrolled via these groups are also unenrolled from the Add-In as part of the removal. Pass false explicitly to keep those devices enrolled and only change the auto-enrollment configuration going forward. The applied value is echoed back in the response as UnenrolledDevices.

MyGeotab groups are hierarchical. Removing a parent group ID implicitly removes all of its descendant (child) groups — auto-enrollment will be cleared for devices in any child group as well. If is true, devices in those child groups are also unenrolled.

Groups not currently configured for the Add-In are accepted by MyGeotab and treated as a no-op for that group. is required: null, empty, or entries that are null/whitespace will be rejected with a MyAdminException.

RequestManualSupportVins (...)

Submits a manual eligibility review request for vehicles whose OEM telematics support eligibility could not be automatically determined. On success, a confirmation email for each unique vehicle manufacturer will be sent to the email address associated with your account.

SetAddInAutoEnrollmentFlag (...)

Enables or disables auto-enrollment for a Device Add-In on a specific database. When enabled, future devices that meet the Add-In's auto-enrollment criteria are enrolled automatically without manual intervention. Only reseller users can call this method. when is false, the auto-enrollment configuration (including any group filters) is removed in MyGeotab. By default the previously auto-enrolled devices remain enrolled; set to true to also unenroll them as part of the disable operation. The flag is only honored when is false; it is ignored when enabling.

ShareDevice (...)

Shares a device from myadmin by instructing the gateway to forward data to an additional database, and initiates billing as per multi stream billing.

SubmitVinOemEligibilityBatch (...)

Submit a batch of VINs for OEM eligibility processing.

TerminateDeviceBilling (...)

Submits a request to terminate a billing plan for the provided device.

TerminateDeviceBillingBulk (...)

Submits a request to terminate a billing plan for the provided list of devices.

UnblockAddIn (...)

Unblocks a Device Add-In on a specific database. Sets the Add-In status back to Active in MyGeotab and MyAdmin. Devices are not auto-re-enrolled — use the existing enrollment APIs if you need to enroll devices after unblocking. Only reseller users can call this method. This is the same operation exposed by the L1 Device Add-In Management UI's "Unblock" action; it is intended for programmatic unblocking without visiting the MyAdmin UI.

Only applies to Add-Ins currently in Blocked state. Idempotent when already Active (returns Success=true without re-issuing MyGeotab calls). Throws when the Add-In is in any other state (e.g. Inactive) — this API does not re-activate deactivated Add-Ins; use the existing install/enrollment APIs instead.

UnenrollAllDevicesFromAddIn (...)

Unenrolls all currently enrolled devices in a database from a Device Add-In. The work is queued for background processing; per-device results are not returned synchronously. Only reseller users can call this method.

UnenrollDeviceFromAddIn (...)

Unenrolls one or more devices from a Device Add-In. Stops billing and removes enrollment from MyGeotab. Only reseller users can call this method.

UpdateDatabaseAsync (...)

Updates the specified columns for a MyGeotab database using the provided admin credentials.

UpdateDeviceContracts (...)

Updates the comment and/or user contact (eg. assigned customer) for one or more Device Contracts.