Your first API request

The Pigeonhole Live API offers many different features, this guide will help you through making your first API calls.

Prerequisites

• API Key

Step 1. Getting your API Key

Every API request to the Pigeonhole Live API needs to include an authentication method, refer to this article on the different authentication methods.

For simplicity, all guides will use API Key authentication.

Step 2. Making the request

For the first request, let’s get the Pigeonholes in the Workspace:

curl -X GET https://api.pigeonholelive.com/v2/pigeonholes \
  -H "X-API-KEY: $API_KEY" \
  -H "Content-Type: application/json"

A response resembling the following content will be returned:

{
    "data": [
        {
            "id": 1,
            "name": "This is a Pigeonhole!",
            "description": "Welcome! All available sessions are shown below. Tap on any to enter and start engaging.",
            "passcode": "ABCDEF",
            "startDate": "2019-11-26",
            "endDate": "2019-11-29",
            "status": "ended",
            "timezone": "Asia/Singapore",
            "attendeeProfiles": true,
            "registrants": false,
            "attendeeCodeRequired": false,
            "links": {
                ...
            }
        }
    ],
    "links": {
        "next": "https://api.pigeonholelive.com/v2/pigeonholes?cursor=Y3Vyc29yXzI1NzQ4MQ=="
    },
    "meta": {
        "perPage": 30,
        "nextCursor": "Y3Vyc29yXzI1NzQ4MQ==",
        "hasMore": true
    }
}

info

Some parts have been omitted for brevity

That’s it! You’ve successfully made your first API call to the Pigeonhole Live API. To find out more on the use cases of the API, take a look here.