Skip to documentation
Browse documentation
API reference / Connected data
GET/v1/connected-records/searchmaterials:read

Find connected materials and factories

Operation ID: searchConnectedRecords

Parameters

NameLocationTypeDescription
query

Required

querystringCustomer name or business reference.
kindquerymaterial | factoryOptional record type to find.
limitqueryintegerMaximum matching records.
cursorquerystringOpaque continuation cursor returned by the previous page.

Example request

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

Responses

HTTP 200

Successful response

HTTP 400

Problem response

HTTP 401

Problem response

HTTP 403

Problem response

HTTP 404

Problem response

HTTP 409

Problem response

HTTP 429

Problem response

HTTP 500

Problem response

HTTP 503

Problem response

Try this operation

The credential is held only in React memory for this browser tab. Hyran Docs does not persist, proxy, inspect, or log it.