LoginSign up

API Reference

Comprehensive documentation for the AirPinpoint API

AirPinpoint API Reference

Welcome to the AirPinpoint API documentation. Our API allows you to programmatically access and manage your tracking data, devices, and settings.

Authentication

All API requests require authentication using an API key. You can generate an API key from your dashboard settings.

# Example of authenticating with the API
curl -X GET "https://api.airpinpoint.com/v1/trackables" \
  -H "Authorization: Bearer YOUR_API_KEY"

Base URL

All API endpoints are relative to:

https://api.airpinpoint.com/v1

Rate Limits

The API is rate limited to 100 requests per minute per API key. If you exceed this limit, you will receive a 429 Too Many Requests response.

Endpoints

For detailed information on each endpoint, refer to the specific documentation sections:

Errors

The API uses standard HTTP status codes to indicate the success or failure of requests:

  • 200: Success
  • 400: Bad Request
  • 401: Unauthorized
  • 403: Forbidden
  • 404: Not Found
  • 429: Too Many Requests
  • 500: Internal Server Error

Error responses include a JSON object with an error field containing details about the error.

{
  "error": {
    "code": "invalid_request",
    "message": "The request was invalid",
    "details": "Required parameter 'name' is missing"
  }
}

Webhook Events (Enterprise Only)

You can configure webhooks to receive real-time notifications about events such as:

  • Device location updates
  • Geofence entry/exit events
  • Battery level changes
  • Connection status changes

To set up webhooks, go to your dashboard settings.

Support

If you need help with the API, please contact our support team at support@airpinpoint.com or visit our help center.

See all posts