Explore with Postman
Postman lets you make API requests without building an application first. The samples repository contains a general API collection and a smaller Leads collection.
MyCRM API collection
Try example requests in Postman, with authentication handled by the collection.
Download API collection ↓MyCRM Leads collection
A focused starting point for creating a lead and retrieving it by its identifier.
Download Leads collection ↓Import and configure
- In Postman, choose Import and select the downloaded JSON file.
- Open the collection's Variables tab.
- Populate the values below using the details issued for your integration.
- Choose a read request that your credentials permit, or follow the Leads collection to create a test lead in an agreed environment.
| Variable | Value |
|---|---|
Auth_Url | Complete OAuth token URL |
ClientID | Application client ID |
ClientSecret | Application secret |
Scopes | Space-separated approved scopes to request |
AdviserContactId | Adviser identifier used for the UserId header |
PublicAPI_Url | API base URL, before /jsonapi |
Keep credentials in local or secret values rather than sharing them with a collection.
How authentication works
The collection's pre-request scripts perform the OAuth client-credentials exchange and add request headers. Inspect these scripts if you are adapting the collection into an application. Start with why MyCRM uses OAuth 2.0, then see the technical token flow.
Creation and update examples change records. Select an agreed test environment and use records intended for testing. A collection includes examples of capabilities; it does not grant your application permission to use all of them.
Continue with JSON:API explained to understand the responses.