Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ The file format of it is based on [Keep a Changelog](http://keepachangelog.com/e
For public Changelog covering all changes done to Pipedrive’s API, webhooks and app extensions platforms, see [public Changelog](https://pipedrive.readme.io/docs/changelog) with discussion area in [Developers Community](https://devcommunity.pipedrive.com/c/documentation/changelog/19).

## [Unreleased]
### Fixed
- Fixed the `limit` query parameter on `GET /api/v2/deals/search`, `GET /api/v2/itemSearch`, `GET /api/v2/leads/search`, `GET /api/v2/organizations/search`, `GET /api/v2/persons/search`, `GET /api/v2/products/search`, and `GET /api/v2/projects/search` — the maximum value is now documented as 100 (previously 500 on most of them) and added `minimum: 1` and `maximum: 100`
- Add `minimum` and `maximum` to the shared `limit` query parameter used by the other v2 cursor-paginated endpoints

## [35.1.1] - 2026-10-12
### Fixed
Expand Down
6 changes: 3 additions & 3 deletions src/versions/v2/api/beta-api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -883,7 +883,7 @@ export const BetaApiAxiosParamCreator = function (configuration?: Configuration)
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
* @param {number} [person_id] Will filter projects by the provided person ID
* @param {number} [organization_id] Will filter projects by the provided organization ID
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page

* @throws {RequiredError}
Expand Down Expand Up @@ -1403,7 +1403,7 @@ export const BetaApiFp = function(configuration?: Configuration) {
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
* @param {number} [person_id] Will filter projects by the provided person ID
* @param {number} [organization_id] Will filter projects by the provided organization ID
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page

* @throws {RequiredError}
Expand Down Expand Up @@ -2067,7 +2067,7 @@ export interface BetaApiSearchProjectsRequest {
readonly organization_id?: number

/**
* For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
* For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
* @type {number}
* @memberof BetaApiSearchProjects
*/
Expand Down
6 changes: 3 additions & 3 deletions src/versions/v2/api/deals-api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -873,7 +873,7 @@ export const DealsApiAxiosParamCreator = function (configuration?: Configuration
* @param {number} [organization_id] Will filter deals by the provided organization ID. The upper limit of found deals associated with the organization is 2000.
* @param {'open' | 'won' | 'lost'} [status] Will filter deals by the provided specific status. open = Open, won = Won, lost = Lost. The upper limit of found deals associated with the status is 2000.
* @param {Set<'deal.cc_email'>} [include_fields] Supports including optional fields in the results which are not provided by default
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page

* @throws {RequiredError}
Expand Down Expand Up @@ -1261,7 +1261,7 @@ export const DealsApiFp = function(configuration?: Configuration) {
* @param {number} [organization_id] Will filter deals by the provided organization ID. The upper limit of found deals associated with the organization is 2000.
* @param {'open' | 'won' | 'lost'} [status] Will filter deals by the provided specific status. open &#x3D; Open, won &#x3D; Won, lost &#x3D; Lost. The upper limit of found deals associated with the status is 2000.
* @param {Set<'deal.cc_email'>} [include_fields] Supports including optional fields in the results which are not provided by default
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page

* @throws {RequiredError}
Expand Down Expand Up @@ -2045,7 +2045,7 @@ export interface DealsApiSearchDealsRequest {
readonly include_fields?: Set<'deal.cc_email'>

/**
* For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
* For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
* @type {number}
* @memberof DealsApiSearchDeals
*/
Expand Down
6 changes: 3 additions & 3 deletions src/versions/v2/api/leads-api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ export const LeadsApiAxiosParamCreator = function (configuration?: Configuration
* @param {number} [person_id] Will filter leads by the provided person ID. The upper limit of found leads associated with the person is 2000.
* @param {number} [organization_id] Will filter leads by the provided organization ID. The upper limit of found leads associated with the organization is 2000.
* @param {Set<'lead.was_seen'>} [include_fields] Supports including optional fields in the results which are not provided by default
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page

* @throws {RequiredError}
Expand Down Expand Up @@ -250,7 +250,7 @@ export const LeadsApiFp = function(configuration?: Configuration) {
* @param {number} [person_id] Will filter leads by the provided person ID. The upper limit of found leads associated with the person is 2000.
* @param {number} [organization_id] Will filter leads by the provided organization ID. The upper limit of found leads associated with the organization is 2000.
* @param {Set<'lead.was_seen'>} [include_fields] Supports including optional fields in the results which are not provided by default
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page

* @throws {RequiredError}
Expand Down Expand Up @@ -393,7 +393,7 @@ export interface LeadsApiSearchLeadsRequest {
readonly include_fields?: Set<'lead.was_seen'>

/**
* For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
* For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
* @type {number}
* @memberof LeadsApiSearchLeads
*/
Expand Down
6 changes: 3 additions & 3 deletions src/versions/v2/api/organizations-api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -492,7 +492,7 @@ export const OrganizationsApiAxiosParamCreator = function (configuration?: Confi
* @param {string} term The search term to look for. Minimum 2 characters (or 1 if using &#x60;exact_match&#x60;). Please note that the search term has to be URL encoded.
* @param {Set<'address' | 'custom_fields' | 'notes' | 'name'>} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: &#x60;address&#x60;, &#x60;varchar&#x60;, &#x60;text&#x60;, &#x60;varchar_auto&#x60;, &#x60;double&#x60;, &#x60;monetary&#x60; and &#x60;phone&#x60;. Read more about searching by custom fields &lt;a href&#x3D;\&quot;https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\&quot; target&#x3D;\&quot;_blank\&quot; rel&#x3D;\&quot;noopener noreferrer\&quot;&gt;here&lt;/a&gt;.
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is &lt;b&gt;not&lt;/b&gt; case sensitive.
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page

* @throws {RequiredError}
Expand Down Expand Up @@ -722,7 +722,7 @@ export const OrganizationsApiFp = function(configuration?: Configuration) {
* @param {string} term The search term to look for. Minimum 2 characters (or 1 if using &#x60;exact_match&#x60;). Please note that the search term has to be URL encoded.
* @param {Set<'address' | 'custom_fields' | 'notes' | 'name'>} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: &#x60;address&#x60;, &#x60;varchar&#x60;, &#x60;text&#x60;, &#x60;varchar_auto&#x60;, &#x60;double&#x60;, &#x60;monetary&#x60; and &#x60;phone&#x60;. Read more about searching by custom fields &lt;a href&#x3D;\&quot;https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\&quot; target&#x3D;\&quot;_blank\&quot; rel&#x3D;\&quot;noopener noreferrer\&quot;&gt;here&lt;/a&gt;.
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is &lt;b&gt;not&lt;/b&gt; case sensitive.
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page

* @throws {RequiredError}
Expand Down Expand Up @@ -1150,7 +1150,7 @@ export interface OrganizationsApiSearchOrganizationRequest {
readonly exact_match?: boolean

/**
* For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
* For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
* @type {number}
* @memberof OrganizationsApiSearchOrganization
*/
Expand Down
6 changes: 3 additions & 3 deletions src/versions/v2/api/persons-api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -547,7 +547,7 @@ export const PersonsApiAxiosParamCreator = function (configuration?: Configurati
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is &lt;b&gt;not&lt;/b&gt; case sensitive.
* @param {number} [organization_id] Will filter persons by the provided organization ID. The upper limit of found persons associated with the organization is 2000.
* @param {Set<'person.picture'>} [include_fields] Supports including optional fields in the results which are not provided by default
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page

* @throws {RequiredError}
Expand Down Expand Up @@ -800,7 +800,7 @@ export const PersonsApiFp = function(configuration?: Configuration) {
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is &lt;b&gt;not&lt;/b&gt; case sensitive.
* @param {number} [organization_id] Will filter persons by the provided organization ID. The upper limit of found persons associated with the organization is 2000.
* @param {Set<'person.picture'>} [include_fields] Supports including optional fields in the results which are not provided by default
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page

* @throws {RequiredError}
Expand Down Expand Up @@ -1280,7 +1280,7 @@ export interface PersonsApiSearchPersonsRequest {
readonly include_fields?: Set<'person.picture'>

/**
* For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
* For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
* @type {number}
* @memberof PersonsApiSearchPersons
*/
Expand Down
6 changes: 3 additions & 3 deletions src/versions/v2/api/products-api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -737,7 +737,7 @@ export const ProductsApiAxiosParamCreator = function (configuration?: Configurat
* @param {Set<'code' | 'custom_fields' | 'name'>} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: &#x60;address&#x60;, &#x60;varchar&#x60;, &#x60;text&#x60;, &#x60;varchar_auto&#x60;, &#x60;double&#x60;, &#x60;monetary&#x60; and &#x60;phone&#x60;. Read more about searching by custom fields &lt;a href&#x3D;\&quot;https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\&quot; target&#x3D;\&quot;_blank\&quot; rel&#x3D;\&quot;noopener noreferrer\&quot;&gt;here&lt;/a&gt;.
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is &lt;b&gt;not&lt;/b&gt; case sensitive.
* @param {Set<'product.price'>} [include_fields] Supports including optional fields in the results which are not provided by default
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page

* @throws {RequiredError}
Expand Down Expand Up @@ -1187,7 +1187,7 @@ export const ProductsApiFp = function(configuration?: Configuration) {
* @param {Set<'code' | 'custom_fields' | 'name'>} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: &#x60;address&#x60;, &#x60;varchar&#x60;, &#x60;text&#x60;, &#x60;varchar_auto&#x60;, &#x60;double&#x60;, &#x60;monetary&#x60; and &#x60;phone&#x60;. Read more about searching by custom fields &lt;a href&#x3D;\&quot;https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\&quot; target&#x3D;\&quot;_blank\&quot; rel&#x3D;\&quot;noopener noreferrer\&quot;&gt;here&lt;/a&gt;.
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is &lt;b&gt;not&lt;/b&gt; case sensitive.
* @param {Set<'product.price'>} [include_fields] Supports including optional fields in the results which are not provided by default
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page

* @throws {RequiredError}
Expand Down Expand Up @@ -1805,7 +1805,7 @@ export interface ProductsApiSearchProductsRequest {
readonly include_fields?: Set<'product.price'>

/**
* For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
* For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
* @type {number}
* @memberof ProductsApiSearchProducts
*/
Expand Down
Loading
Loading