Quickstart

This guide will get you all set up and ready to use the Benefits Cliffs 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.

Overview

When an API response returns a list of objects, no matter the amount, pagination is supported. In paginated responses, objects are nested in a data attribute and have a has_more attribute that indicates whether you have reached the end of the last page. You can use the starting_after and endding_before query parameters to browse pages.

Choose your client

Before making your first API request, you need to pick which API client you will use. In the following example, you make make a basic request to ensure that your client is working correctly. You can then choose the client that you want to use for your project.

# cURL is most likely already installed on your machine
curl --version

Making your first API request

You are ready to make your first call to the Benefits Cliffs API. Below, you can see how to send a GET request to the Conversations endpoint to get a list of all your conversations. In the cURL example, results are limited to ten conversations, the default page length for each client.

curl -X https://api.benefitscliffs.org/me \
  -H "Authorization: Bearer {token}" \

Response

This will simply return your name and email address to verify that you have successfully made your first API request. You can see the response below.

   {
     "name": "John Doe",
     "email": "john@doe.com",
   }

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 Benefits Cliffs API:

• Grab your API key from the dashboard
• Check out the available endpoints