Overview

External IDs

External IDs APIs allow you to associate Motive entities with unique identifiers from external systems or integrations. This mapping helps synchronize users, vehicles, assets, and groups between Motive and third-party systems.

This overview covers the External IDs endpoints.

Add external ID information for an entity

  • Endpoint: POST /v1/external_ids
  • Description: Adds external integration details to an entity. The supported entity types are User, Vehicle, Asset, and Group.
  • Use Case: Map an entity in Motive to its corresponding record in an external system, such as a payroll, maintenance, or transportation management system.

Update the external ID of an entity

  • Endpoint: PUT /v1/external_ids/:id
  • Description: Updates the external integration information associated with an external ID record. You must provide the Motive-generated external ID record ID.
  • Use Case: Correct or update an external identifier or its associated integration.

Delete the external ID of an entity

  • Endpoint: DELETE /v1/external_ids/:id
  • Description: Deletes an external ID record using its unique identifier.
  • Use Case: Remove an external integration mapping that is no longer valid or required.