--- title: "Getting started with Panaya APIs" slug: "api-guide" updated: 2026-01-04T13:04:36Z published: 2026-01-05T19:44:52Z --- > ## Documentation Index > Fetch the complete documentation index at: https://success.panaya.com/llms.txt > Use this file to discover all available pages before exploring further. # Getting started with Panaya APIs Follow the steps below to get started with Panaya APIs - ## **Download an API Connection Software** We recommend using [Postman](https://www.getpostman.com/) to run the API connection. While many other tools are available that will work for this purpose, this guide will demonstrate the use of [Postman](http://www.getpostman.com/). If you are already using Postman, upgrade to the latest version before proceeding with the next steps. --- ## **Import a shared collection of Panaya APIs** Click on this link to import the shared collection of Panaya’s API into Postman: [![](https://cdn.panaya.com/customer_education/SZ/run_in_postman.png)](https://cdn.panaya.com/customer_education/SZ/Panaya%20Catalog%20of%20API%20examples%202025.htm) After you have imported the collection into Panaya, you should see the Shared Panaya Catalog of API examples, and an environment called "Panaya Shared Environment". ![](https://cdn.document360.io/f404076c-de23-4609-848e-2dfd4ef701b0/Images/Documentation/image-KO5XHBJI.png) --- ## **Postman api_token and URL** Select the **Panaya Shared Environment**, and expand the environment variables view, by clicking on Variables: ![](https://cdn.document360.io/f404076c-de23-4609-848e-2dfd4ef701b0/Images/Documentation/image-EPUX1HGS.png) Then click on the Environment link: ![](https://cdn.document360.io/f404076c-de23-4609-848e-2dfd4ef701b0/Images/Documentation/image-9SQ5RBLJ.png) You should now see a list of predefined environment variables, notice the ones highlighted in red, these are the ones you will be updating in the “Current value” column: ![](https://cdn.document360.io/f404076c-de23-4609-848e-2dfd4ef701b0/Images/Documentation/image-P7480JNY.png) **Create and set the API Token -** To create your Panaya Api token, see the steps in [this article](/v1/docs/how-to-create-your-token). Set the **api_token** variable as shown above with the value you received. Ensure that your Panaya Username (Email address) is added in front of the token and separated by a colon. Be sure to set the "Current value" column of each variable, as only this column is used. After setting the api_token, it should look similar to this: ![](https://cdn.document360.io/f404076c-de23-4609-848e-2dfd4ef701b0/Images/Documentation/image-J583UREZ.png) If you log into Panaya using emea.panaya.com, set the **URL** variable as follows: **![](https://cdn.document360.io/f404076c-de23-4609-848e-2dfd4ef701b0/Images/Documentation/image-1645792821882.png)** If you log into Panaya using my.panaya.com, use the **URL** variable as follows: ![](https://cdn.document360.io/f404076c-de23-4609-848e-2dfd4ef701b0/Images/Documentation/image-1645792943954.png) --- ## **Project ID** You can find the project ID in the browser URL when visiting a Panaya project. [Click here to learn how to locate the project ID](/v1/docs/project-id-for-apis) ### Get Projects IDs using API Expand the Project folder click on "Get Projects - Friendly" API call. Notice that the url and api_token values are dynamically passed. ![](https://cdn.document360.io/f404076c-de23-4609-848e-2dfd4ef701b0/Images/Documentation/image-K6PF3S75.png) Click on Send. You should receive a similar response, but with your projectId or several of them if you are connected to several projects. In our example below, the projectId is 9930. ![](https://cdn.document360.io/f404076c-de23-4609-848e-2dfd4ef701b0/Images/Documentation/image-ZK5M9GL6.png) Now set the **projectId**of the Panaya project you would like to work with in the Panaya Shared Environment **projectId** variable. ![](https://cdn.document360.io/f404076c-de23-4609-848e-2dfd4ef701b0/Images/Documentation/projectid.jpg) You should now be able to try and experiment with the rest of the many API calls in each folder. You may want to map the fields from your project to match the ones in the collection you have just imported, so please follow the steps in [this article](/v1/docs/map-the-api-fields-from-the-project)to do that. **Tip!** You can easily display the full API request headers and body in many different code formats, such as Python, C#, Ruby, curl, etc., by choosing the required one from the **Code snippet**window. ![](https://cdn.document360.io/f404076c-de23-4609-848e-2dfd4ef701b0/Images/Documentation/Code%20snippet(1).jpg) See more [API Tips and Tricks here](/v1/docs/api-tips-and-tricks). ## Related - [API & Integration](/api.md) - [API Call Limits](/what-are-the-default-api-call-limits.md) - [Test Dynamix APIs](/panaya-testing-api-supported-entities-and-functions.md) - [API Tips and Tricks](/api-tips-and-tricks.md) - [Project ID for APIs](/project-id-for-apis.md)