solarOS Organization API

Organization API

List pickup Locations

Lists the organization's active Locations open for material pickup — the values a Material Request's pickupLocationId accepts — ordered as they are in solarOS settings. Required scope: material_reqs:read.

/api/v1/pickup-locations

Lists the organization's active Locations open for material pickup — the values a Material Request's pickupLocationId accepts — ordered as they are in solarOS settings. Required scope: material_reqs:read.

List pickup Locations. Use an organization API key with material_reqs:read. Check the response envelope and meta.requestId before triggering dependent workflow steps.

Required scopes

material_reqs:read

Parameters

No path or query parameters.

Request body

This endpoint does not accept a JSON request body.

Responses

200

Pickup Location list envelope

#/components/schemas/PickupLocationListEnvelope

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 required scope: material_reqs:read

#/components/schemas/OrgApiError

429

Rate limit exceeded

#/components/schemas/OrgApiError

Errors

401 Missing or invalid organization API key402 Organization billing access or an endpoint-specific business quota denied the request403 Missing required scope: material_reqs:read429 Rate limit exceeded

Static examples

curl -X GET "$SOLAROS_BASE_URL/api/v1/pickup-locations" \
  -H "Authorization: Bearer $SOLAROS_API_KEY"