Make the first API request

Hyran Data exposes governed product data through a versioned REST API. Every customer-data request requires a tenant-bound bearer credential. The credential determines the organization and scopes. Requests never select a tenant through a query parameter, header, or request body.

Before you begin

Ask an authorized Hyran operator for an API credential with the scope required by your integration. The secret is displayed once. Store it in a password manager or secrets platform, never in source control, workbooks, screenshots, logs, or URLs.

Request entity types

1. 1

   Set the credential in your shell

   Keep the value outside shell history when possible. The example variable is local to the current process.

2. 2

   Send the bearer credential

   Include the credential in the Authorization header over HTTPS.

3. 3

   Record the request ID

   Capture X-Request-ID with failures. Hyran uses it to correlate the response with logs, traces, rate-limit events, and audit records.

curl --request GET \
  --url https://api.data.hyran.co/v1/entity-types \
  --header "Authorization: Bearer $HYRAN_DATA_API_TOKEN" \
  --header "Accept: application/json"

A successful response uses a stable envelope:

{
  "data": ["style", "sku", "material", "supplier", "bom_publication"],
  "meta": {
    "requestId": "4d34680e-64c8-44ec-994d-a1352c6569b4",
    "asOf": "2026-08-15T10:30:00.000Z"
  }
}

Continue from here

• Read Authentication before distributing a credential.
• Use Pagination and filters before processing a collection.
• Open the generated API reference for parameters and response schemas.
• Import the OpenAPI 3.1 document or download the curated Postman collection.