Home > Articles > Accessing your Vtiger CRM data via OData feed

Articles in this section

Access CRM data offline via Vtiger 360 Calendar View Capturing Emotional Journeys Closed States Customer Touchpoints Customizer Desktop Notification overview Exporting Data from Vtiger CRM Vtiger Feature Limits Glossary How do I scan a Business Card in Vtiger 360 mobile App IP Based Restriction Introduction to Kanban View Make the leap from Spreadsheets Merging Duplicates in Summary View Migration Timeframe and Process One View: Introduction Overview of Permission Usecases Performing Global Search Rest API Manual Managing your Vtiger CRM Subscriptions & Billing Vtiger 360 for Field Sales Vtiger 360 Mobile App Contact Roles What are Record-Level Analytics What are Sticky Notes What is Quick Create Whitelisting Vtiger to Configure Gmail Inbox Built-in Phone Dialer in the CRM with Plivo and Twilio Summary View QR Code in Vtiger CRM Internal Chat Details View Vtiger SAML application in Microsoft Entra ID Understanding Email Bounces and Error Codes Using Grid Edit in Vtiger CRM Embedding a Video URL Course Completion Certificates Customizing a Course Category Applicable Taxes for Vtiger Billing

Accessing your Vtiger CRM data via OData feed

Bindu Rekha Babu

17 Jun, 2024 - Updated 5 months ago

Introduction

OData (Open Data Protocol) allows applications such as Microsoft Power BI, MS Sharepoint, and other Apps to readily consume queryable information in a simple and standard way.

OData is a REST-based protocol for querying and updating data and is built on standardized technologies such as HTTP, Atom/XML, and JSON. It is different from other REST-based web services in that it provides a uniform way to describe both the data and the data model.

OData and Vtiger CRM

Vtiger provides an entry point to access data in OData format. User can hit the OData URL and provide credentials to fetch information from any module

For example, To fetch data from Contacts module
instance_url/restapi/V1/OData/Pull/odata.svc/Contacts

Authentication

To access the data you need to send Your User name and access key as basic authentication to the api call.

Parameters

It even allows fetching filtered data

Fetch selected fields
instance_url/restapi/V1/OData/Pull/odata.svc/Contacts?$select=firstname,lastname
Fetch with conditions
instance_url/restapi/V1/OData/Pull/odata.svc/Contacts?$filter=firstname eq 'Mark'
Fetch with limit
instance_url/restapi/V1/OData/Pull/odata.svc/Contacts?$top=10
Skip few records from the result (we can use this for paging)
instance_url/restapi/V1/OData/Pull/odata.svc/Contacts?$skip=10&$top=10
Count the total number of records
instance_url/restapi/V1/OData/Pull/odata.svc/Contacts/$count

Limitations:

To ensure optimal performance, results are limited to 5000 records per request. To get the next set of records, you can use the Skip command.

Was this article helpful?

0 out of 2 found this helpful.

Comments 0

Be the first to comment