solarOSsolarOS Docs

Lookup External References in a batch

Resolves 1 to 200 tenant-owned External Reference tuples in request order. A missing tuple returns null resourceType, resourceId, and externalReference values in its result instead of failing the whole batch. Duplicate inputs are queried once but remain duplicated in the ordered response. Required scope: external_references:read.

POST
/external-references/lookup/batch

Resolves 1 to 200 tenant-owned External Reference tuples in request order. A missing tuple returns null resourceType, resourceId, and externalReference values in its result instead of failing the whole batch. Duplicate inputs are queried once but remain duplicated in the ordered response. Required scope: external_references:read.

Authorization

Authorization<token>

Organization API key. Format: Bearer sk_live_...

In: header

Request Body

application/json

JSON request payload for lookupExternalReferencesBatch.

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/external-references/lookup/batch" \  -H "Content-Type: application/json" \  -d '{    "lookups": [      {        "externalSystem": "salesforce",        "externalObject": "WorkOrder",        "externalId": "0WO123"      }    ]  }'
{  "data": {},  "meta": {    "requestId": "string",    "version": "v1",    "timestamp": "2019-08-24T14:15:22Z",    "rateLimit": {      "limit": 0,      "remaining": 0,      "reset": 0    }  }}