Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update getting-started.md #81

Merged
merged 2 commits into from
Mar 28, 2025
Merged

Update getting-started.md #81

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b5fc4fa
Update getting-started.md
Queerty Jan 10, 2025
5aecbc8
Merge branch 'master' into Queerty-patch-2-1
Queerty Mar 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions api-docs/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,17 +19,22 @@ The M-RETS API provides nearly all of the functionality available through the pl

## What is required to use the M-RETS API?

M-RETs requires that all API users be part of a registered organization with a General Subscription in good standing.
M-RETS requires that all API users and Sandbox participants be part of a registered organization with a General Subscription in good standing.


## How to get started

To gain access to our API, we recommend the following steps:
If you are interested in testing and utilizing M-RETS API but do not currently have a General Subscription in M-RETS, please email [email protected] to discuss registration options or changes.

If you have a General Subscription in M-RETS and would like to gain access to our API, we recommend the following steps:

1. Users with a General Subscription can request access to the M-RETS sandbox by filling out [this form](https://docs.google.com/forms/d/e/1FAIpQLSebmAyf6cNc1GAcYASXcbU3vwHwHGG-jUNReQQdc0ii-k_Pwg/viewform).
If you are not a current M-RETS user or have a different subscription type, reach out to [email protected] to learn more about our API and discuss next steps.
2. We create test organizations for your team to use and send you Sandbox credentials. You are free to generate new API keys and test out workflows.
3. Find the documentation, libraries, code examples, and other resources that you need to make your first successful request.



## Resources

### Swagger Docs
Expand Down