Introduction | Parallel Developer Documentation
Endpoints
The base URL for the API endpoints differ for production and sandbox environments. You should call the endpoint associated with the environment you are integrating with.
| Production Endpoint | Sandbox Endpoint |
|---|---|
https://api.parallelmarkets.com/v2/partner-records/ |
https://demo-api.parallelmarkets.com/v2/partner-records/ |
Demo Environment Configuration
If integrating in the sandbox environment, ensure you are using the sandbox endpoint listed above. Using the production API endpoints with an API key associated with a sandbox account will fail.
Authentication
All case management endpoints use API Key authentication.
Pagination
Pagination is supported by endpoints that return a list of records, for example, List Businesses/Individuals. The following parameters can be used to page your requests.
Paginated Request Parameters
| Parameter | Description |
|---|---|
cursor (string) |
Optional. A pagination cursor value that is returned in the previous response. |
limit (integer) |
Optional. Limit the number of records returned per page. Min: 1, Max: 100, Default: 10 |
Paginated Response
| Parameter | Description |
|---|---|
pagination |
Optional. An object containing the next_cursor string. The next_cursor value can be used in subsequent requests to retrieve the next page of records. If no further records are available, then the next_cursor value will be null. |