Sites & Organisation

Meta

These endpoints provide metadata about the Trybe platform

get/meta/supported-locales

Returns the status and output of a Trybe-internal background job that was previously kicked off via a queue-issuing endpoint (e.g. queueExport, queueImportVouchers, the practitioner-occupancy queue endpoints, voucher-code bulk creation).

Poll this endpoint to watch a job progress from pending → in_progress → complete/failed. Once status is complete, output contains the per-job result envelope (a list of created records, a signed download URL, error rows, etc., depending on the job).

Requires the view ability on the QueuedJob — typically granted to the user who originally enqueued the job.

Path parameters

queuedJobIdobject-idrequired
The unique identifier of the queued job.

Responses

200
The job was successfully queued
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found

curl "https://api.playground.try.be/shop/queued-jobs/abc123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/queued-jobs/abc123', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    Accept: 'application/json',
  },
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.get(
    "https://api.playground.try.be/shop/queued-jobs/abc123",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.playground.try.be/shop/queued-jobs/abc123', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"encoding/json"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.playground.try.be/shop/queued-jobs/abc123", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

The job was successfully queued

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "status": "pending",
    "output": {},
    "created_at": "2023-11-07T00:00:00+00:00",
    "updated_at": "2023-11-07T01:00:00+00:00"
  }
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

Meta

Get supported locales

Responses

Get supported currencies

Responses

Get supported timezones

Responses

Get outbound IPs

Responses

Get a queued job

Path parameters

Responses