Get user details

GET /apps/{appId}/users/{userId}
Bearer auth

Get detailed information about a specific user, including workspace information. Important: Use the workspace ID from this response in the Workspace-ID header for subsequent API calls. Note that workspace information is only available when the user status is 'completed'.

Path parameters

  • appId integer Required

    App ID

  • userId integer Required

    User ID

Responses

  • 200 application/json

    User details with roles and workspace information

    Hide response attributes Show response attributes object
    • createdAt string

      Creation timestamp

    • edges object
      Hide edges attribute Show edges attribute object
      • roles array[object]

        User's role and permissions within a workspace

        Hide roles attributes Show roles attributes object
        • createdAt string

          Creation timestamp

        • edges object
          Hide edges attribute Show edges attribute object
          • workspace object Required

            Workspace represents a user's context for API operations. Use the workspace ID in the Workspace-ID header

            Hide workspace attributes Show workspace attributes object
            • createdAt string

              Creation timestamp

            • id integer Required

              Workspace ID - use this value in the Workspace-ID header for API requests

            • name string Required

              Workspace name

            • type string

              Workspace type (personal/business)

            • updatedAt string

              Last update timestamp

        • id integer Required

          Workspace role ID

        • role string Required

          Workspace role (e.g., admin, member)

        • updatedAt string

          Last update timestamp

    • email string Required

      User email

    • id integer Required

      User ID

    • status string

      User status (e.g., pending, completed)

    • userType string

      User type (personal/business)
  • 401 application/json

    Unauthorized

    Hide response attributes Show response attributes object
    • errorCode string Required

      Error code

    • message string Required

      Error message
  • 404 application/json

    User not found

    Hide response attributes Show response attributes object
    • errorCode string Required

      Error code

    • message string Required

      Error message
GET /apps/{appId}/users/{userId} 
curl \
 --request GET 'https://bank.bank.place/apps/{appId}/users/{userId}' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "id": 123,
  "edges": {
    "roles": [
      {
        "role": "admin",
        "edges": {
          "workspace": {
            "id": 456,
            "name": "John Doe's Workspace",
            "type": "personal"
          }
        }
      }
    ]
  },
  "email": "user@example.com",
  "status": "completed",
  "userType": "personal",
  "createdAt": "2025-01-15T10:30:00Z"
}
Response examples (401) 
{
  "message": "Invalid request parameters",
  "errorCode": "invalid_request"
}
Response examples (404) 
{
  "message": "Invalid request parameters",
  "errorCode": "invalid_request"
}