Rest V2 Gap - Filter by ID in relevant list methods

API Q&A
1

In the XMLRPC API DataService - we could paginate through various tables. Most of these tables have an “id” field. So when paginating, I could filter for id > 0 .. get 1000 records back (let’s say the last ID is 2548) .. then filter for ID > 2548 and so on until all records are retrieved.

If we’re importing data for an account and the import script dies prematurely in the middle for whatever reason, it’s easy to restart by filtering for the ID > X last received. Since we are filtering by a key such as ID it’s effiicient and fast.

In the Rest v2 API - we are unable to filter by “id” in the relevant list methods such as: listContacts, listOrders, listOpportunities

My request here is to add “id” as a filterable column to all list methods for consistency.

I also wanted to provide my feedback regarding the list methods. The majority of list methods allow you to bulk import data from a table, which is basically what the DataService allowed you to do.

listContacts() GET /v2/contacts
listCompanies() GET /v2/companies
listLeadSources() GET /v2/leadSources
listPaginatedUsers() GET /v2/users
listUserGroups() GET /v2/userGroups
listTags() GET /v2/tags
listSubscriptions() GET /v2/subscriptions
listProducts() GET /v2/products
listProductCategories() GET /v2/productCategories
listOrders() GET /v2/orders
listOpportunities() GET /v2/opportunities
listOpportunityStages() GET /v2/opportunities/stages
listTasks() GET /v2/tasks
listLeadSourceCategories() GET /v2/leadSourceCategories
listCategoryDiscounts() GET /v2/discounts/productCategories
listCampaigns() GET /v2/campaigns
listAutomations() GET /v2/automations
listAffiliate() GET /v2/affiliates

The list methods below make you filter for a given ID which is inconsistent with all the other list methods above.. It also makes it very inefficient when trying to import something like all notes.

listNotes() GET /v2/contacts/{contact_id}/notes
listPaymentMethods() GET /v2/contacts/{contact_id}/paymentMethods
listLeadSourceRecurringExpenses() GET /v2/leadSources/{lead_source_id}/recurringExpenses
listLeadSourceExpenses() GET /v2/leadSources/{lead_source_id}/expenses

Thanks,
Casey

2

Thanks for sharing your detailed feedback regarding the id filter in the REST v2 API and the list methods. We’ll discuss this internally and I’ll get back to you with an update as soon as I have more information.

All the gaps reported in this post have been added to the known issues tracker.

3

Hi @Casey_Page,

Thanks again for your detailed feedback and for highlighting these gaps. I wanted to share a quick update on this.

The issue regarding listPaymentMethods has been addressed with the introduction of a new endpoint, which you can find here:

This should help improve efficiency when retrieving payment methods without requiring a contact-specific filter.