Skip to main content

Get user

API operation: Open the endpoint in Scalar

Use GET /users/{user} to retrieve one user. The current public operation is User.find.users_user.

The archived route named its final integer parameter user_id; the current route and controller use user in the same position. The HTTP method and fixed resource path are otherwise identical.

Administrators and agents can retrieve other users. Other callers may be limited to their own user record; business-manager access can depend on role permissions.

Use params only for fields and relations supported by the current operation.

Legacy API explorer example

Legacy SDK example​

const response = await ordering.users(userId).get();

Confirm the SDK package and version before using this historical helper.

OpenAPI reference​

Operation: GET /users/{user}

Path parameters

NameTypeRequiredDescription
userintegerYes—

Query parameters

NameTypeRequiredDescription
paramsstringNoComma-separated list of fields. It is intersected with the model’s $fillable; an empty or invalid list returns all fields.
delivery_block_fromstringNo—
delivery_block_tostringNo—

Responses

CodeDescription
200OK (UserResponse)
400Bad Request (ErrorResponse)
401Unauthorized
404Not Found
429Too Many Requests (ErrorResponse)
500Internal Server Error (ErrorResponse)
503Service Unavailable (ErrorResponse)
Open this operation in the API reference