Skip to main content
GET
Get User
V2 Preview — This endpoint is part of the V2 API preview. Breaking changes may occur.

Overview

Vendor API keys can’t call this endpoint. A token minted from a vendor key (vk_live_…) gets 403 FORBIDDEN “API keys cannot call this endpoint”, even with every scope. Use a vendor portal login session. A merchant key (mk_live_…) can read any user in the shop.
Retrieve a single vendor portal user. Portal sessions can read users of their own vendor. Merchant-key tokens can read any user in the shop.

Path Parameters

userId string required User ObjectId.

Response

200 Merchant key
403 Vendor API key

Example