Skip to main content
GET
Read a user
List active human members, change a plan, and set the extra usage budget beyond the included allowance. Amounts are US dollars. The calls use the workspace API key’s BILLING_API scope. Writes run as the key’s service account owner. This API does not invite or deactivate members. Use the User Management API for that.

Base URL

Dedicated deploymentsReplace api.langdock.com with <your-deployment-url>/api/public in all requests.

Prerequisites

  • API key with the BILLING_API scope
  • The key owner is a service account that has not been deleted and has an active Admin membership
  • USER_MANAGEMENT_API on the same key when you need email, name, or an email filter
A member object includes email and name only when the key also has USER_MANAGEMENT_API. Without that scope, those fields are omitted. name may be null when it is included.
monthlyBudget.effective is the included monthly budget. It is the higher of the plan budget and any group budget. An unlimited value wins over a limited one. When the amounts are equal, the plan wins over a group. If two groups set the same amount, the source is the group whose name comes first. source is plan, or group with groupId and groupName. That monthly budget sets the weekly allowance (monthly divided by 4) and the session allowance (weekly divided by 3). extraUsageBudget is the allowance after those included windows are used up. It is none, unlimited, or limited. extraUsagePeriodSpend measures that extra usage. It is null when the workspace hides per user spend. A user who is not an active human member returns 404.
Langdock intentionally blocks browser-origin requests to protect your API key and ensure your applications remain secure. For more information, please see our guide on API Key Best Practices.

Authorizations

Authorization
string
header
required

API key as Bearer token. Format "Bearer YOUR_API_KEY"

Path Parameters

userId
string<uuid>
required

Response

Successful response.

USD. The highest plan/group monthly budget configures weekly and session allowances. Extra usage can start when those included allowances are exhausted. Spend is null when private and always null in mutation responses.

id
string<uuid>
required
plan
enum<string>
required
Available options:
standard,
power_user
monthlyBudget
object
required
extraUsageBudget
object
required
extraUsagePeriodSpend
number | null
required
Required range: x >= 0
email
string<email>

Present only when the key also has the USER_MANAGEMENT_API scope.

name
string | null

Present only when the key also has the USER_MANAGEMENT_API scope.