Skip to main content

GET /api/v1/users/

Retrieves all details for a user by system-generated user ID or external ID. The response includes organization memberships and user metadata.

Request

Path Parameters

id
string
required
System-generated user ID. Must start with ‘usr_’.
usr_1234abcd5678efgh

Query Parameters

external_id
string
Your application’s unique identifier for this user. Use this to retrieve a user by your own ID instead of Scalekit’s ID.
ext_12345a67b89c

Response

user
object
Full user object with system-generated fields and timestamps.

Examples

    Error Responses

    200
    success
    User details retrieved successfully
    404
    error
    User not found

    Build docs developers (and LLMs) love