For the complete documentation index, see llms.txt. This page is also available as Markdown.

Get User

Membership.

A contact (user) is a person in your project's membership directory, with one or more linked logins (identities). Membership manages their profile, identities, roles, and lifecycle.

This endpoint returns a single user by id.

Membership

get
Authorizations
HTTPRequired

JWT Bearer Authorization

Path parameters
versionstring · nullableRequired

The CodeMash API version used to fetch data from the API. If not specified, the last version will be used. E.g.: v3

Query parameters
Idstring · nullableRequired

Id of the user to fetch, from get_users.

DatabaseIntegrationIdstring · nullableOptional

Database integration id. Optional — defaults to the request environment's default integration.

Header parameters
norbix-project-idstring · nullableRequired

ID of your project. Can be passed in a header as norbix-project-id.

norbix-envstring · nullableOptional

Target environment for this request (e.g. TEST, STAGING). Optional — when omitted the request runs against PROD. Can be passed in a header as norbix-env.

CultureCodestring · nullableOptional

Specify culture code when your response from the API should be localised. E.g.: en

TimeZoneIdstring · nullableOptional

TimeZone

CorrelationIdstring · nullableOptional

CorrelationId for each request

Responses
200

OK

application/json
get/{version}/membership/auth/{id}
GET /{version}/membership/auth/{id}?Id=text HTTP/1.1
Host: api.norbix.ai
Authorization: Bearer YOUR_SECRET_TOKEN
norbix-project-id: text
Accept: */*
200

OK

{
  "responseStatus": {
    "isSuccess": true
  },
  "user": {
    "id": "text",
    "email": "text",
    "userName": "text",
    "roles": [],
    "pushDevices": [],
    "tags": [],
    "createdOn": "text",
    "modifiedOn": "text"
  }
}

In the dashboard

Manage this visually in Norbix Cloud — see Membership → Users.

Use it from code

Every Norbix SDK exposes this endpoint as a method — see Get User in the SDK reference, with examples in every language.

Last updated