Skip to main content

API FAQ

Written by Miles Dinsmore

Note: The Partners Portal has been deprecated and is no longer available. For API key requests, access, and update notifications, please email

Getting Started

How do I get an API key?

Does one API key work for everything?

No, each environment will have a different key and each client will have a different key. You must request a key for each environment (both testing environments and client environments), and for each client.

Where can I find my organization, facility, and user IDs?

In addition to an API key, the following IDs are required to use our API endpoints:

  • Organization ID

  • Facility ID

  • User ID

You can retrieve these IDs by contacting partners@mjfreeway.com

How do I gain access to a client's production environment?

To request an API key, email partners@mjfreeway.com. Approved requests will receive API access to our sandbox environment.

To request access to a client's production environment, see How to Receive an MJ Platform API Key.

Who can I contact to discuss partnering with MJ Freeway?

Email marketing@mjfreeway.com with your request. Our team will consider your idea and respond with next steps.

Managing Accounts and API Keys

How do I manage and request keys I’ve received?

Email partners@mjfreeway.com to view your current keys or request new ones.

How do I submit a request to change my API key?

Email partners@mjfreeway.com with the request. We will assess your request and notify you of the results.

General Questions

Can I receive login credentials for the MJ Platform generic partner test site?

No. We do not currently offer a generic sandbox environment. With a sponsoring client's approval, integrators can request access to that client's training sandbox.

Is there a rate limit to API usage?

Yes. The rate limit is 100 API calls per minute with a maximum of 5,000 API calls per day.

How will I be notified if there is a change to the APIs or documentation?

MJ Freeway will send an email alert from partners@mjfreeway.com to the address associated with your account whenever there are updates.

Did this answer your question?