Horeca24 Partner API › Connection

Check the key and read the connection's state

GEThttps://management.horeca-24.de/api/partner/v1/ping

menuUrl, menuHash and menuUpdatedAt are null until the restaurant first syncs its menu. menuHash is the SHA-256 (hex) of the menu file's current bytes.

Headers

AuthorizationstringRequired

Bearer pk_<connectionId>.<keyId>.<secret>

The connection's API key, from the restaurant's till. Treat it as one opaque string. 401 UNAUTHORIZED for a missing, wrong, expired or revoked key; 403 CONNECTION_REVOKED for the key of a deleted connection. After a rotation by the restaurant, the previous key keeps working for 24 hours.

Response

200The connection

connectionIdstringRequiredpattern: ^pc_[0-9a-f]{20}$

namestringRequired

The connection's name; orders appear in the till under it

storeNamestring or nullRequired

The restaurant's name

storeStatusstringStoreStatusRequiredonlineoffline

online while the restaurant takes orders through this connection

webhookConfiguredbooleanRequired

menuUrlstring or nullRequiredformat: uri

The menu file; null before the first menu sync

menuHashstring or nullRequiredpattern: ^[0-9a-f]{64}$

SHA-256 (hex) of the file's bytes

menuUpdatedAtstring or nullRequiredformat: date-time

The last write of the file

Errors

objectErrorBody

401

UNAUTHORIZED: the key is missing, malformed, unknown, wrong, expired or revoked

403

CONNECTION_REVOKED: the restaurant deleted the connection; stop sending

GET/ping

cURL

curl https://management.horeca-24.de/api/partner/v1/ping \
  -H "Authorization: Bearer $PARTNER_API_KEY"

Python

import os
import requests

url = "https://management.horeca-24.de/api/partner/v1/ping"

headers = {
    "Authorization": "Bearer " + os.environ["PARTNER_API_KEY"],
}

response = requests.get(url, headers=headers)

print(response.status_code)
print(response.text)

JavaScript

const response = await fetch("https://management.horeca-24.de/api/partner/v1/ping", {
  method: "GET",
  headers: {
    "Authorization": "Bearer " + process.env.PARTNER_API_KEY,
  },
});

const data = await response.text();
console.log(response.status, data);

PHP

<?php
$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => 'https://management.horeca-24.de/api/partner/v1/ping',
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('PARTNER_API_KEY'),
    ],
]);

$response = curl_exec($curl);
curl_close($curl);

echo $response;

Try it

ServerAuthorizationNever stored, never sent to us.

Response

200

200The connection

{
  "connectionId": "pc_3f1c0a9e5b7d2c4f6a81",
  "name": "Test-Partner A",
  "storeName": "Pizzeria Roma",
  "storeStatus": "online",
  "webhookConfigured": true,
  "menuUrl": "https://cdn.horeca-24.de/partner-api/menus/pc_3f1c0a9e5b7d2c4f6a81/menu.json",
  "menuHash": "9b2f6a1c0d3e4f5a6b7c8d9e0f1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f90",
  "menuUpdatedAt": "2026-10-15T09:58:12.000Z"
}

401

401UNAUTHORIZED: the key is missing, malformed, unknown, wrong, expired or revoked

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "string",
    "path": "string",
    "details": null,
    "requestId": "string"
  }
}

403

403CONNECTION_REVOKED: the restaurant deleted the connection; stop sending

{
  "error": {
    "code": "CONNECTION_REVOKED",
    "message": "string",
    "path": "string",
    "details": null,
    "requestId": "string"
  }
}