External Users

Get a registered external user

Changed on

Retrieve an active or inactive registration by its URL-encoded, caller-supplied tracking ID. Management key required.

get/external-users/{user}

Request

  • Base URL: https://openrouter.ai/api/v1
  • URL: https://openrouter.ai/api/v1/external-users/{user}
  • Auth: HTTP bearer

Path parameters

userstring required

Immutable case-sensitive tracking string supplied as user on inference requests or as external.user on API keys: 1 to 512 characters, well-formed Unicode, no NUL, no surrounding whitespace. URL-encode it in resource paths; an ID of . or .. cannot be addressed by path, so look it up with the list filter.

Example:employee_123

Response

The registered external user. No generated public identifier is returned.

Example response

{
  "data": {
    "created_at": "2026-09-16T12:00:00Z",
    "is_active": true,
    "updated_at": "2026-09-16T12:00:00Z",
    "user": "employee_123"
  }
}

Changes