Skip to main content
GET
/
v1
/
users
/
{user_id}
Get third-party user details
curl --request GET \
  --url https://register.tariff.interop/v1/users/{user_id} \
  --header 'X-Supplier-API-Key: <api-key>'
{
  "user_id": "usr_c7e2f1a03b4d4e5f8a9b1c2d3e4f5a6b",
  "name": "Example Optimiser Ltd",
  "display_name": "Optimiser",
  "status": "active",
  "last_modified": "2026-10-15T08:30:00.000Z",
  "support": "tariff-support@optimiser.co.uk"
}

Authorizations

​
X-Supplier-API-Key
string
header
required

API key issued to TI Energy Suppliers for accessing restricted register data and submitting performance reports. Credentials are valid for 2 years and are distributed via a one-time URL from the Code Manager.

Path Parameters

​
user_id
string<uuid>
required

The user_id of the RTI User, as returned by GET /v1/users. Compact UUID generated by RECCo uniquely identifying the user with usr_.

Pattern: ^usr_[0-9a-f]{32}$
Example:

"usr_550e8400e29b41d4a716446655440000"

Response

A single RTI User register entry.

An RTI User's entry in the TI User Register. Registration data (webhook URL, contact details) is only returned to authenticated suppliers.

​
user_id
string<uuid>
required

Compact UUID generated by RECCo uniquely identifying the user with usr_.

Pattern: ^usr_[0-9a-f]{32}$
Example:

"usr_550e8400e29b41d4a716446655440000"

​
name
string
required

Organisation's legal name.

Maximum string length: 200
Example:

"Cucumber Energy Optimiser Ltd"

​
display_name
string
required

Short trading name displayed to consumers.

Maximum string length: 100
Example:

"Optimiser"

​
status
enum<string>
required

The status of the user.

Available options:
active,
suspended,
disabled,
removed
Example:

"active"

​
support
string
required

Support contact information for Users - email, url, telephone is acceptable.

Example:

"tariff-support@optimiser.co.uk"

​
last_modified
string<date-time>
required

ISO 8601 datetime with millisecond precision.

Example:

"2026-11-01T10:00:00.000Z"

Last modified on March 28, 2026