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.
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.
Lookup External References in a batch. Use an organization API key with external_references:read. Check the response envelope and meta.requestId before triggering dependent workflow steps.
Required scopes
Parameters
No path or query parameters.
Request body
| Field | Type | Description |
|---|---|---|
| lookups[]required | array<object> | Optional unless marked required. |
| lookups[].externalSystemrequired | string | Optional unless marked required. |
| lookups[].externalObjectrequired | string | Optional unless marked required. |
| lookups[].externalIdrequired | string | Optional unless marked required. |
{
"lookups": [
{
"externalSystem": "salesforce",
"externalObject": "WorkOrder",
"externalId": "0WO123"
}
]
}Responses
Ordered External Reference lookup results envelope
#/components/schemas/OrgApiResourceEnvelope
Invalid or oversized lookup batch
#/components/schemas/OrgApiError
Missing or invalid organization API key
#/components/schemas/OrgApiError
Organization billing access or an endpoint-specific business quota denied the request
#/components/schemas/OrgApiError
Missing external_references:read scope
#/components/schemas/OrgApiError
Rate limit exceeded
#/components/schemas/OrgApiError
Errors
Static examples
curl -X POST "$SOLAROS_BASE_URL/api/v1/external-references/lookup/batch" \
-H "Authorization: Bearer $SOLAROS_API_KEY" \
-H "Content-Type: application/json" \
--data '{"lookups":[{"externalSystem":"salesforce","externalObject":"WorkOrder","externalId":"0WO123"}]}'