solarOS Organization API

Organization API

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.

/api/v1/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.

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

external_references:read

Parameters

No path or query parameters.

Request body

objectrequired
FieldTypeDescription
lookups[]requiredarray<object>Optional unless marked required.
lookups[].externalSystemrequiredstringOptional unless marked required.
lookups[].externalObjectrequiredstringOptional unless marked required.
lookups[].externalIdrequiredstringOptional unless marked required.
lookupexternalreferencesbatchRequest
{
  "lookups": [
    {
      "externalSystem": "salesforce",
      "externalObject": "WorkOrder",
      "externalId": "0WO123"
    }
  ]
}

Responses

200

Ordered External Reference lookup results envelope

#/components/schemas/OrgApiResourceEnvelope

400

Invalid or oversized lookup batch

#/components/schemas/OrgApiError

401

Missing or invalid organization API key

#/components/schemas/OrgApiError

402

Organization billing access or an endpoint-specific business quota denied the request

#/components/schemas/OrgApiError

403

Missing external_references:read scope

#/components/schemas/OrgApiError

429

Rate limit exceeded

#/components/schemas/OrgApiError

Errors

400 Invalid or oversized lookup batch401 Missing or invalid organization API key402 Organization billing access or an endpoint-specific business quota denied the request403 Missing external_references:read scope429 Rate limit exceeded

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"}]}'