Identity API References
Base URLs
https://identity-api.dev.dimo.zone
GraphQL Operations
The Identity API provides one endpoint /query
, for query execution.
Constructing a GraphQL Query
To construct a GraphQL query, use the interactive playground to explore the nodes and how each resources are connected. To understand how GraphQL queries are constructed, please check out this tutorial below:
Sample Query
Here's a sample query trying to fetch for a vehicle
with a tokenId
of 21957
. Here, I'm naturally specifying what information I want returned from the API, namely the id
of the vehicle, aftermarketDevice
information, syntheticDevice
information, and definition
for the selected vehicle:
Sending a GraphQL Query
To send a GraphQL query, simply send your formatted request to {baseUrl}/query
and a response will be returned to you.
Sample Payload
This is a sample payload of what I attempted to fetch for in Sample Query:
Paginating through GraphQL Payload
When returning a GraphQL payload that consists of multiple results, such as vehicles
or manufacturers
, there may be times where the length of the payload is too long for your current operation to display - this is when pagination is needed. To paginate through the results returned, look for the pagination fields listed below under pageInfo
.
Sample Query
Sample Payload
GraphQL Playground
Last updated