List User Addresses
API operation: Open the endpoint in Scalar
Use GET /users/{user_id}/addresses to list a user's addresses. The current public operation is Address.findAll.
Authentication is required. Administrators and agents can list addresses across users; other callers must match user_id. The response may include user or metafield relations depending on params.
const response = await ordering.users(userId).addresses().get();
This SDK syntax is historical. Confirm the package and version before using it.
See User address model.
OpenAPI reference
Operation: GET /users/{user_id}/addresses
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
user_id | integer | Yes | — |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
params | string | No | Comma-separated list of fields. It is intersected with the model’s $fillable; an empty or invalid list returns all fields. |
orderBy | string | No | Field to sort by, with - prefixed for descending order. Multiple fields can be chained with commas. |
where | string | No | JSON filter over the fields the model declares as filterable. Valid fields for each resource are exposed in its x-ordering-whereable schema extension. |
page | integer | No | Page number, starting at 1. Applies only to lists that return a pagination block. |
page_size | integer | No | Number of items per page. |
Responses
| Code | Description |
|---|---|
| 200 | OK (Envelope) |
| 400 | Bad Request (ErrorResponse) |
| 401 | Unauthorized |
| 404 | Not Found |
| 429 | Too Many Requests (ErrorResponse) |
| 500 | Internal Server Error (ErrorResponse) |
| 503 | Service Unavailable (ErrorResponse) |