Last updated

Getting started

A technical guide on using the Closelink public API.

Authentication

The Closelink API uses API keys for authentication. The level of permission is defined by the role and companies assigned to the API key.

  1. Log in to Closelink as a group admin
  2. Go to the company group settings
  3. Scroll down to the API keys section and click Create new secret key
  4. Select the assigned companies and permissions
  5. Copy and save the created API key, you will not be able to retrieve the key later

Alternatively, feel free to contact us at hello@closelink.com to request an API key.

Environments

Staging

This environment is used for testing and development.

Base URL Staging
https://public-api-staging.closelink.com

Production

This environment is used for production. Should not be used for testing or development.

Base URL Production
https://public-api.closelink.com

API reference

You can find the full reference here.

You can use the Try it buttons to test the endpoints.