Scale API | Users › Get User

Users

users

Methods

User Info ->

UserInfo

get/user-info

Get basic information for the logged in user making this request including preferences.

Get User -> { id, access_profiles, email, 5 more... }

get/users/{user_id}

Get basic information for a user. The requester must belong to the same organization as the target user and be an admin or manager of an account the target user belongs to.

Security

API Key Header

Example: x-api-key: My API Key

Parameters

user_id: string

Response fields

id: string

User id

access_profiles: Array<{ id, account, role, 1 more... }>

A list of access profiles that the selected user has access to

email: string

E-mail address

first_name: string

Optional

First name

is_organization_admin: boolean

Optional

True if the current user is an organization admin.

last_name: string

Optional

Last name

organization_id: string

Optional

The organization ID of the user.

preferences: unknown

Optional

User preferences that can be stored in the Scale GenAI Platform.

Request example

curl https://api.egp.scale.com/users/$USER_ID \
    -H "x-api-key: $SGP_API_KEY"

200Example

{
  "id": "id",
  "access_profiles": [
    {
      "id": "id",
      "account": {
        "id": "id",
        "name": "name"
      },
      "role": "manager",
      "user_id": "user_id"
    }
  ],
  "email": "email",
  "first_name": "first_name",
  "is_organization_admin": true,
  "last_name": "last_name",
  "organization_id": "organization_id",
  "preferences": {}
}

Domain types

UserInfo = { id, access_profiles, email, 6 more... }