Build quickly and easily with Postman
Postman is a free external software used by developers to create and test APIs. Klaviyo has developed an API collection for Postman, which makes it fast and easy to select the correct Klaviyo API endpoint and set up your API calls.
Learn how to fork, or make a copy of, the collection in your own account. You can make changes to your fork (your copy) without affecting anyone else using the collection.
Then, we'll use the API collection to make API calls to your Klaviyo test account.
Fork Klaviyo's API Collection in Postman
Before you start using Postman:
- Head to Postman and sign up for a free account. Then, you can choose to either download the Postman app or use it in your browser.
- Can’t find where to download? Navigate to Postman Downloads and click on your OS.
- Create a private API key in your Klaviyo test account. For more information, refer to our guide on setting up your development environment.
- Open up your test account's API key tab to prepare to paste your API keys into Postman.
Once you've completed these steps, follow along with the video below to fork Klaviyo's API collection and set up authorization.
You can also refer to this guide for a step-by-step walkthrough on forking Klaviyo's collection.
Make GET requests
Now that you've set up Klaviyo's API collection in Postman, let's make a few GET requests in Postman. Click the arrow to expand each dropdown and work through the exercises.
Get all profiles
Use the Get Profiles endpoint to return all profiles in your Klaviyo account.
To do so, click Get Profiles on the left, then click Send.
This will return information about every profile in your Klaviyo account. If you did not use the sample data generation tool to create sample data, this call may return nothing, since no profiles yet exist in your account.
You can tell the call went through successfully if you see a 200 OK status in Postman:
If you run into any issues, follow along with the Postman video above to make sure you have correctly set up authorization and selected the correct endpoint.
Get email and first name
As you just saw, the Get Profiles endpoint returns a lot of data about each profile in your account. Let's narrow it down to just return email and first name for each profile in your account.
Add the fields[profile] query parameter by checking the box next to this query parameter in the Params tab. In the value field, enter email,first_name.
Then, click Send.
This will return the email and first name for every profile in your account.
Again, you can tell the call went through successfully if you see a 200 OK status in Postman:
Get more data
With the sample data generation tool, you created profiles, ecommerce events, and catalog data. Can you use the Get Events or Get Catalog Items endpoints to retrieve some of this data?
Play around with Postman to see all of the data you can retrieve with GET requests.