# Epicor Kinetic API Documentation: Where It Lives and How the URLs Work > Source: https://netray.co/erp-help/epicor-kinetic-api-documentation-rest-v1-v2 > Publisher: Netray (netray.co), AI and integration engineering for ERP and manufacturing systems. > Section: ERP Help ## Short answer Epicor Kinetic documents its REST API on your own server: a Swagger-style help page under /api/help lists every business object, method and field for your exact version. v1 uses /api/v1/ service URLs, v2 uses /api/v2/odata/{Company}/ and adds function (EFx) and BAQ endpoints. There is no separate SDK you must install; most teams call REST or generate a client from the OpenAPI definition. ## Kind how-to ## System epicor ## Erp Epicor Kinetic ## Module REST API / Integration ## Query epicor kinetic api documentation ## Alternate Queries - epicor kinetic rest api documentation - epicor erp api documentation - epicor kinetic api url - epicor kinetic sdk ## Applies To Epicor Kinetic 2021 and later, and Epicor ERP 10.2.x for the v1 pattern; Kinetic cloud and on-prem. Exact page layout varies by release. ## Steps ### Find the docs and make your first call **Items:** - Open https://your-server/your-instance/api/help in a browser. Replace the host and instance with the values from your Kinetic web address. This is the live reference for your version. - Pick a business object (for example Erp.BO.PartSvc) and expand a method to see the request body, response shape and field list. - Build the base URL. v1 pattern: https://server/instance/api/v1/Erp.BO.PartSvc/Parts. v2 pattern: https://server/instance/api/v2/odata/{Company}/Erp.BO.PartSvc/Parts. - Authenticate. Send an API key in the x-api-key header (generate it in API Key maintenance) together with either HTTP Basic credentials or a bearer token, depending on how your environment is configured. - Send a simple GET with $top=5 first. If it returns rows, add $filter, $select and $expand. - For reports and custom data, call a BAQ through the BaqSvc endpoint or a published function through the efx path instead of stitching several business objects together. - Keep the help page open next to the Epicor Help Portal. The portal explains concepts; the /api/help page is the authoritative field and method list. ## Sections ### REST v1 versus REST v2: which to use **Body:** v1 exposes the classic business object services (BOs) one method at a time, for example GetByID or GetRows. It is familiar to anyone who has used the old service references and is still common in older integrations. v2 is OData based. You get standard query options ($filter, $select, $top, $orderby, $expand), the company in the URL, and extra routes for Epicor Functions and BAQs. New integrations should start on v2 unless a vendor tool forces v1. Both versions enforce the same business logic, security and BPM directives as the client, because they call the same BOs. That is the main reason to prefer the API over writing directly to SQL. **Code:** - GET https://server/instance/api/v2/odata/EPIC06/Erp.BO.PartSvc/Parts?$top=5&$select=PartNum,PartDescription x-api-key: Authorization: Basic - GET https://server/instance/api/v2/odata/EPIC06/BaqSvc/MyBaqId/Data?$top=10 ### The API URL, per environment **Body:** The API URL is simply your application server address plus the instance name plus /api. In cloud tenants the host is the tenant name Epicor gave you; on-prem it is whatever IIS binding you set up for the Kinetic web site. Check the instance name carefully. A wrong instance gives a 404 that looks like a missing endpoint, while a right instance with a bad key gives a 401 or 403. If you see 401, the existing 401 troubleshooting page covers keys, user permissions and token expiry. Use a dedicated integration user with a narrow security group, not a named employee. Every call runs with that user's menu security and company access. ### Is there a Kinetic SDK? **Body:** Epicor does not ask you to install a separate SDK. The practical options are: plain HTTP from any language, a client generated from the OpenAPI/Swagger definition on the help page, or the .NET client assemblies that ship with the Windows client for in-process customization code. For Power BI, Excel and low-code tools, use BAQs exposed through the BaqSvc endpoint. For integrations that must write data, call the business object method the screen itself uses, so BPMs and validation still fire. Treat any code sample from the web as version specific. Field names and required parameters change between releases, which is why the on-server help page matters more than a blog post. ## Pitfalls - Using the cloud help page of a different version than your tenant, then sending fields your version does not have. - Skipping the x-api-key header; Basic credentials alone are rejected on environments that require a key. - Pulling large tables with no $top or $select, which times out and loads the server. Page results. - Writing to a table through a BAQ-style shortcut and bypassing BPM validation. Use the BO method. - Hard-coding the company ID; test and production companies differ. ## Ai Angle An ERPray style assistant that reads Kinetic through these same APIs (or a read-only BAQ layer) can answer questions in plain language, show the exact OData query it ran and respect the caller's Epicor security. For on-prem Kinetic, the model runs on your own GPUs and the API traffic stays inside your network. ## Faq ### What is the Epicor Kinetic API URL? **Answer:** It is your Kinetic server address, then the instance name, then /api. For example https://server/instance/api/v2/odata/{Company}/Erp.BO.PartSvc/Parts for the Part service in v2. The matching Swagger-style help is at /api/help on the same server. ### Does Epicor publish REST API documentation outside my server? **Answer:** Epicor Help covers concepts and examples, but the authoritative list of services, methods and fields is the help page generated on your own server because it reflects your version, customizations and enabled modules. ### Can I call a BAQ from the REST API? **Answer:** Yes. Publish the BAQ and call it through the BaqSvc route in v2 with OData query options. This is the simplest way to feed Power BI, Excel or a data pipeline with read-only data. ### v1 or v2 for a new integration? **Answer:** Use v2 for new work. It has OData filtering, function and BAQ routes and is where Epicor is investing. Keep v1 only for existing integrations or tools that cannot speak OData. ## Search terms epicor kinetic api documentation, epicor kinetic rest api, epicor rest api v2, epicor api url, epicor kinetic sdk, epicor swagger help, epicor odata api, epicor api key, epicor erp api --- Talk to an engineer: https://netray.co/contact?intent=erp_ai | Machine catalog: https://netray.co/agent/catalog.json