Get User

GET/v1/users/{id}

Returns details for a workspace user by Identity user UUID. Optional service_id (query) or x-service-id (header) includes the matching service/role block under service. When omitted, service is not returned.

Path Parameters

idstring required

Identity user UUID.

Example:7c9e6679-7425-40de-944b-e07fc1f90ae7

Query Parameters

service_idstring

Optional service UUID. When set, response includes service with role details. Alternatively send x-service-id header.

Example:3fa85f64-5717-4562-b3fc-2c963f66afa6

Responses

Body

success_codeenum: 200 | 201•Numeric success code matching the HTTP response status. required

Example:200

messagestring required

Example:OK

detailsobject required

dataobject (GeneralDetailedUser)•Workspace user details. service is present only when service_id / x-service-id is provided. required

idstring (uuid)•Identity user UUID required

usernamestring required

emailstring (email) required

imgstring or null

is_activeboolean required

typeenum: owner & admin | owner | admin | user•Workspace membership type required

serviceobject•Service membership for the requested service_id

idstring (uuid)

namestring

unique_namestring or null

roleobject

idstring (uuid)

namestring

statusstring or null

metaobject

error_codeinteger•Numeric error code matching the HTTP response status. required

Example:400

messagestring required

detailsobject•Validation errors are returned as a field-to-messages map; other errors may use arbitrary keys. required

error_codeinteger•Numeric error code matching the HTTP response status. required

Example:400

messagestring required

detailsobject•Validation errors are returned as a field-to-messages map; other errors may use arbitrary keys. required

error_codeinteger•Numeric error code matching the HTTP response status. required

Example:400

messagestring required

detailsobject•Validation errors are returned as a field-to-messages map; other errors may use arbitrary keys. required

error_codeinteger•Numeric error code matching the HTTP response status. required

Example:400

messagestring required

detailsobject•Validation errors are returned as a field-to-messages map; other errors may use arbitrary keys. required

error_codeinteger•Numeric error code matching the HTTP response status. required

Example:400

messagestring required

detailsobject•Validation errors are returned as a field-to-messages map; other errors may use arbitrary keys. required

Request Sample:Shell / cURL

1
2
3
4

curl --request GET \
  --url "https://api-stg.bevatelcloud.com/v1/users/{id}?service_id=3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  --header "Authorization: Bearer <YOUR_API_KEY>" \
  --header "Content-Type: application/json"

Response Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

{
  "success_code": 200,
  "message": "OK",
  "details": {},
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "username": "string",
    "email": "[email protected]",
    "img": "string",
    "is_active": true,
    "type": "owner & admin",
    "service": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "string",
      "unique_name": "string",
      "role": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "string"
      },
      "status": "string"
    }
  },
  "meta": {}
}