Use the OData API to query and update your Prospect CRM data using standard web technologies. This guide covers everything you need to know to authenticate, understand rate limits, and start building queries. You'll need a Personal Access Token (PAT) to use the API.

If you're already familiar with OData and just need endpoint and data model details, refer to the API documentation instead.

OData is a REST-based protocol for querying and updating data, built on standard technologies such as HTTP, Atom/XML and JSON. It is standardised by OASIS and is ISO/IEC approved.

Because the OData specification is standardised, any OData feed responds in the same way to the defined OData functions. This means you can use a consistent approach to query your CRM data regardless of the tool or language you're using.

To access the Prospect CRM OData service, you need a Personal Access Token (PAT). To generate a token:

The OData service uses bearer authentication. You need to add a bearer authorisation header to every request using a valid access token:

API access is limited to 1,200 requests every 10 minutes using a 'Sliding Window' algorithm. The rate limit applies to your overall CRM workspace, not per token. If you have multiple PAT tokens, all requests across all tokens count towards the same limit.

If you exceed the limit, the API returns a 429 response code. The API does not queue requests, so you must retry any request that receives a 429 response.

The algorithm keeps a rolling log of request timestamps for your workspace. For each incoming request, the system:

Every OData query is made up of three parts:

The base URL tells the API where to retrieve data from. The Prospect CRM OData base URL is:

The entity is the type of CRM record you want to access. Entities are generally the plural of the table name. You append the entity name directly after the base URL:

To retrieve a specific record by ID, append the ID in parentheses after the entity name:

Running a query without any filters returns all records for that entity. Retrieving large data sets takes a long time to complete. Wherever possible, retrieve only the data you need using smaller, filtered queries. To handle large data sets efficiently, the API uses server-driven paging. Each response includes a page of results and an @odata.nextLink if more data is available. Continue making requests to the @odata.nextLink until all records are retrieved.

Parameters are OData functions that you chain after the entity using &. They let you select, filter, sort, and limit the data returned. For example:

For a full list of available OData functions and how to use them, see Query the OData API.

To replicate a report query, you can inspect the report's syntax using your browser's developer tools. Follow these steps:

This method allows you to understand the structure of the report and use it as a basis for constructing your own queries.

A 401 Unauthorised error usually indicates a problem with your token. To resolve it:

If the error persists, revoke the token and generate a new one from Integrations, then click Custom API Integration (OData API).

The Notepad entity in Prospect CRM is a versatile tool for managing notes and linking them to specific contacts or activities. This guide explains how to create a General Note and retrieve Notepad entries with specific activity types using the API.

To create a General Note, use the Notepad entity:

Using the Notepad entity avoids OData errors that occur when attempting to set note fields on the Contact type.

To retrieve Notepad entries associated with a specific Activity History type (e.g., "Customer Meeting"), follow these steps: