API

Quickstart

Get started with the Qariyb REST API. This guide covers authentication and making your first API call to retrieve events.

Looking to add checkout to your website without building a custom UI? Check out the Qariyb Elements for drop-in web components.

Get your API keys

  1. Log in to your Qariyb organizer account
  2. Navigate to Settings → Developer → API keys
  3. Click Create API Key
  4. Copy and securely store your secret key (sk_live_…) — server-side use only, never in browser code

Creating a key issues a matched pair: a publishable key (pk_live_…) for browser widgets and a secret key (sk_live_…) for server-side REST API calls. Keys are scoped to one organization. The secret key is shown once and cannot be revealed later — keep it secure and never commit it to version control.

Make your first request

Once you have your secret key, you are ready to make your first request. The Qariyb REST API uses secret key authentication with a Bearer token. Here is how to retrieve a list of your events:

GET
/api/v1/events
curl -G https://api.qariyb.com/api/v1/events \
  -H "Authorization: Bearer sk_live_..." \
  -H "Accept: application/json"
Read the Events API documentation

Understanding the response

The Qariyb API returns JSON responses with a consistent structure:

Success Response

{
  "success": true,
  "code": 100,
  "locale": "en",
  "message": "OK",
  "data": {
    // Your requested data
  }
}

All successful responses include:

  • success: Boolean indicating request success
  • code: Qariyb API status code (see Error Codes)
  • data: The requested resource data

What is next?

Now that you have made your first API request, explore these resources:

API Reference:

Guides:

Was this page helpful?