The MyPass Global API enables seamless integration of MyPass functionality into your services and applications. To ensure secure and authorized access, an API Key is required. This key serves as a unique identifier, ensuring that only authorized users or applications can interact with your account and perform operations through the API.

With the MyPass API, you can easily extract data from your MyPass portal for tasks such as generating reports and more. For options on exporting MyPass reports, go to Dashboards and Reports.

Note: To gain access to the API Key generation feature, you need to have the ‘API Key’ user permission enabled. If you do not have this permission, please contact your account administrator. For more information on changing User Permissions, go to Update User Group Assignments.

To generate an API Key, navigate to Settings from the left-hand menu. Under the 'Integrations' section, select API Key.

Click the ‘Generate API Key’ button to create a new key.
 

 

Note: If an API Key has already been generated, the button will show as ‘Re-generate API Key’ instead. Please be aware that regenerating the API key will cause any existing integrations using the previous key to stop functioning. Click Yes, proceed to regenerate the API Key.

By default, the API Key will be masked. To reveal it, click the view icon next to the key. To copy the API Key, click the copy icon next to it. You can then use this API Key to integrate MyPass into your services and applications.

You can test your API Key by accessing the MyPass Global API Documentation. This site allows you to test various requests using your generated API key.

To test your API Key, copy the key and click on the MyPass Global API Documentation link.

In the new tab, click the Authorise button in the header of the page.

Paste the copied API key into the 'Value' field and click Authorise to confirm authorisation.  Once authorised, you can perform a query by providing the parameters of the call and clicking the Try It Out button.

Updated 12 March 2025 23:31