Get Users

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 the users defined in your project.

Membership

get

Authorizations

Bearer

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

DatabaseIntegrationIdstring · nullableOptional

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

IncludePermissionsbooleanOptional

Include each user's effective permissions in the result.

UserShouldHavePushDevicebooleanOptional

Only return users that have a registered push device.

UserShouldHaveEmailbooleanOptional

Only return users that have an email address.

IncludeMetabooleanOptional

Include each user's metadata in the result.

RoleNamesanyOptional

Filter to users that have any of these role names.

UserIdsanyOptional

Filter to these specific user ids.

startingAfterstring · nullableOptional

Cursor token — fetch the page AFTER this item.

endingBeforestring · nullableOptional

Cursor token — fetch the page BEFORE this item.

pageSizeinteger · int32 · nullableOptional

Amount of records to return.

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

HTTPcURLJavaScriptPython

GET /{version}/membership/auth HTTP/1.1
Host: api.norbix.ai
Authorization: Bearer YOUR_SECRET_TOKEN
norbix-project-id: text
Accept: */*

200

OK

{
  "responseStatus": {
    "isSuccess": true
  },
  "list": {
    "items": [],
    "hasMore": true,
    "hasPrevious": true,
    "startingAfter": "text",
    "endingBefore": "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 Users in the SDK reference, with examples in every language.