The GraphQL API has Introspection enabled, allowing users to query the API itself to find out more information about it. Please see further documentation about this here. We recommend looking at Altair (docs) and Postman (docs) to use as clients to see what is available within the API.
Obtaining The GraphQL API Key In MEX:
To use the GraphQL API, you will first need to generate an API Key. This can be done by navigating to Settings > Users > Select the user you wish to create an API Key for > Select Generate new MEX GraphQL API Key. Once this has been done, it is possible to reveal or copy the API Key.
In the event you would like to revoke a GraphQL API Key, simply navigate to the User again and select the Revoke Key button.
How To Use:
The GraphQL API for your MEX instance is available at https://{yourDomain}/graphql.
Authenticate using the X-API-KEY header with an API key generated from MEX.
Optionally, provide the X-REGION-ID header to scope queries and mutations to a specific region. Only regions the authenticated user can access may be specified.
Pagination: Default page size = 100, Maximum page size = 100.
Postman Example:
Please note - The API Key Value and BaseUrl have been set as variables in the Example Images. For information on how to do this, please see these docs - Store and Reuse Values Using Variables
In Postman, set the URL (https://{yourDomain}/graphql), and the API key. The API key can be entered under the Authorization tab. When in the Authorization Tab, under Auth Type select "API Key". Then, in the Key field enter "X-API-Key" along with your API Key in the Value field.
Once that has been completed, navigate to the Schema tab to check that you are Using GraphQL Introspection.
Once Introspection is being utilised, navigate to the Query tab which will allow you to build your own queries. For example, this below set up returns a list of Work Order Numbers and Descriptions.