Skip to main content
GET
/
users
/
{userId}
Get user
curl --request GET \
  --url https://apiv2.example.com/users/{userId} \
  --header 'X-Api-Key: <api-key>'
{
  "userId": "<string>",
  "name": "<string>",
  "email": "jsmith@example.com",
  "msisdn": "<string>",
  "identity": "<string>",
  "referenceId": "hr-employee-98765",
  "customers": [
    {
      "customerId": "<string>",
      "name": "<string>"
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "metadata": {}
}

Authorizations

​
X-Api-Key
string
header
required

An API key that grants access to the Connect API. You can create and manage API keys in the portal.

Path Parameters

​
userId
string
required

The unique identifier of the user. May be the entity's internal UUID or an external reference identifier. Reference identifiers MUST be prefixed with rid_ (e.g., rid_hr-employee-98765) so the API can distinguish them from internal UUIDs. The prefix is stripped before lookup.

Response

User details.

A user within the system.

​
userId
string
required

Unique identifier for the user.

​
name
string
required

Name of the user.

​
email
string<email>

Email of the user.

​
msisdn
string<phone>

Mobile phone number of the user.

​
identity
string

The identity of the entity, such as personal number, organization number, etc., depending on the country, entity, and customer type.

​
referenceId
string

A reference identifier provided by API clients to identify this user in their own systems. Must be unique per tenant. Use this field to look up users or to create/retrieve users during order creation.

Maximum string length: 255
Example:

"hr-employee-98765"

​
customers
object[]
​
createdAt
string<date-time>

Date and time when the user was created.

​
updatedAt
string<date-time>

Date and time when the user was last updated.

​
metadata
object

A set of key-value pairs that can be attached to an object for storing additional information in a semi-structured format.