Quickstart

This guide will get you all set up and ready to use the Collctiv API. We'll cover how to get started using one of our API clients and how to make your first API request. We'll also look at where to go next to find all the information you need to take full advantage of our powerful REST API.

Making your first API request

After picking your preferred client, you are ready to make your first call to the Collctiv API. Below, you can see how to send a GET request to the customers endpoint to get a list of all your customers. In the cURL example, results are limited to ten customers, the default page length for each client.

GET
/v1/customers
curl -G https://api.collctiv.com/v1/customers \
  -H "Authorization: Bearer {token}" \
  -d limit=10

What's next?

Great, you're now set up with an API client and have made your first request to the API. Here are a few links that might be handy as you venture further into the Collctiv API:

Was this page helpful?