Get a list of users

Published on Aug 7, 2026

Prev Next

Get

/v{version}/Users

Security

API Key: api_key

Header parameter nameX-ApiKey

Api Key

API Key: session_id

Header parameter nameX-Session-Id

Session Id

Path parameters

version

stringRequired

The requested API version

Query parameters

includeUserGroups

boolean

If true, user groups of users are loaded. Default: false.

userGroupId

array of integer

Unique ID of the user group

Responses

200

Array of object

object

User

Created

string (date-time)

Creation date in UTC

CustomerId

integer (int32)

Unique ID of the customer

EntityAssignmentType

string

Entity assignment type of user determining which entity type is assigned to the user

Valid values[ "None", "Player", "Location" ]

FirstName

string

First name of the user

integer (int32)

Unique ID of the user

LastLoginDate

string (date-time)

Last login date of the user in UTC

LastName

string

Last name of the user

Modified

string (date-time)

Modification date in UTC

PasswordValidTo

string (date-time)

Expiration date of the user's password in UTC

PermissionGroupId

integer (int32)

Unique ID of the assigned permission group

Permissions

object (V1.Models.CmsPermissions)

User permissions in the IXM Platform

Administration

boolean

If true, the user has access to the administration tab in the IXM Platform. Default: false.

Archive

boolean

If true, the user can archive various entities such as spots in the IXM Platform. Default: false.

DashboardMessages

boolean

If true, the user has access to the widgets in the dashboard tab in the IXM Platform. Default: false.

DashboardWidgets

boolean

If true, the user has access to the widget shown in the dashboard tab in the IXM Platform. Default: false.

DataSources

boolean

If true, the user has access to the data sources tab of the player in the IXM Platform. Default: false.

Dooh

boolean

If true, the user has access to the DOOH tab in the IXM Platform. Default: false.

Location

boolean

If true, the user has access to the channels/locations tab in the IXM Platform. Default: false.

MediaManagement

boolean

If true, the user has access to the content/media management tab in the IXM Platform. Default: false.

PlayerMessages

boolean

If true, the user has access to the player notifications tab in the IXM Platform. Default: false.

Playlist

boolean

If true, the user has access to the content/playlist tab in the IXM Platform. Default: false.

PlaylistManagement

boolean

If true, the user can manage playlists in the IXM Platform. Default: false.

PlaylistRelease

boolean

If true, the user can release playlists in the IXM Platform. Default: false.

ProgramScheme

boolean

If true, the user has access to the program scheme tab in the IXM Platform. Default: false.

ProgramSchemeManagement

boolean

If true, the user can manage program schemes in the IXM Platform. Default: false.

Reports

boolean

If true, the user has access to the reports tab in the IXM Platform. Default: false.

ScreenLayout

boolean

If true, the user has access to the screen layout tab in the IXM Platform. Default: false.

ScreenLayoutManagement

boolean

If true, the user can manage screen layouts in the IXM Platform. Default: false.

Type

string

Types of user

Valid values[ "Undefined", "Admin", "Standard", "Location" ]

UserGroups

Array of object (V1.Models.User.UserGroup)

User groups of the user

object

User's user group

Created

string (date-time)

Creation date in UTC

integer (int32)

Unique ID of the user group

IsDoohUserGroup

boolean

Is DOOH user group

Modified

string (date-time)

Modification date in UTC

Name

string

Name of the user group

Username

string

Username of the user

400

Bad Request

Expand All

object

ValidationErrors

object

property*

Array of string additionalProperties

string

401

Unauthorized

Expand All

object

string

Message

string

Type

string

Values

object

property*

object additionalProperties

403

Access denied

Expand All

object

string

Message

string

Type

string

Values

object

property*

object additionalProperties

500

Unexpected error

Expand All

object

string

Message

string

Type

string

Values

object

property*

object additionalProperties