GET pxapi/UserPrivilege?inclNotActive={inclNotActive}&inclSubsets={inclSubsets}&companyId={companyId}
Retrieves functionality privileges for users
Request Information
Parameters
| Name | Description | Additional information |
|---|---|---|
| inclNotActive | false for only active ones or true for all, no matter status |
Define this parameter in the request URI. |
| inclSubsets | false only main level resultset or true for any additional data subset(s) |
Define this parameter in the request URI. |
| companyId | ID for the current company/PX database received by the PX Administrator |
Define this parameter in the request URI. |
Response Information
Response body formats
application/json, text/json
Sample:
{
"Servertime": "2026-05-09T17:17:36.0484346+02:00",
"Userprivileges": [
{
"Userid": "sample string 1",
"Username": "sample string 2",
"Employeeid": "sample string 3",
"Employeename": "sample string 4",
"Employmenttypecurrent": 5,
"Emailid": "sample string 6",
"Adaccount": "sample string 7",
"Licenselevel": "sample string 8",
"Costcenter": "sample string 9",
"Companycode": "sample string 10",
"Blocked": true,
"Privileges": [
{
"Userid": "sample string 1",
"Privstringid": "sample string 2",
"Privilegename": "sample string 3",
"Privilegelevel": 4
},
{
"Userid": "sample string 1",
"Privstringid": "sample string 2",
"Privilegename": "sample string 3",
"Privilegelevel": 4
},
{
"Userid": "sample string 1",
"Privstringid": "sample string 2",
"Privilegename": "sample string 3",
"Privilegelevel": 4
}
]
},
{
"Userid": "sample string 1",
"Username": "sample string 2",
"Employeeid": "sample string 3",
"Employeename": "sample string 4",
"Employmenttypecurrent": 5,
"Emailid": "sample string 6",
"Adaccount": "sample string 7",
"Licenselevel": "sample string 8",
"Costcenter": "sample string 9",
"Companycode": "sample string 10",
"Blocked": true,
"Privileges": [
{
"Userid": "sample string 1",
"Privstringid": "sample string 2",
"Privilegename": "sample string 3",
"Privilegelevel": 4
},
{
"Userid": "sample string 1",
"Privstringid": "sample string 2",
"Privilegename": "sample string 3",
"Privilegelevel": 4
},
{
"Userid": "sample string 1",
"Privstringid": "sample string 2",
"Privilegename": "sample string 3",
"Privilegelevel": 4
}
]
},
{
"Userid": "sample string 1",
"Username": "sample string 2",
"Employeeid": "sample string 3",
"Employeename": "sample string 4",
"Employmenttypecurrent": 5,
"Emailid": "sample string 6",
"Adaccount": "sample string 7",
"Licenselevel": "sample string 8",
"Costcenter": "sample string 9",
"Companycode": "sample string 10",
"Blocked": true,
"Privileges": [
{
"Userid": "sample string 1",
"Privstringid": "sample string 2",
"Privilegename": "sample string 3",
"Privilegelevel": 4
},
{
"Userid": "sample string 1",
"Privstringid": "sample string 2",
"Privilegename": "sample string 3",
"Privilegelevel": 4
},
{
"Userid": "sample string 1",
"Privstringid": "sample string 2",
"Privilegename": "sample string 3",
"Privilegelevel": 4
}
]
}
],
"Message": {
"Messagetype": 1,
"Datareference": "sample string 2",
"Messagetext": "sample string 3",
"Created": "sample string 4",
"Noofrowssub1": 1,
"Noofrowssub2": 1,
"Noofrowssub3": 1,
"Noofrowssub4": 1,
"Noofrowssub5": 1,
"Noofrowssub6": 1,
"AutoInvoiceData": {
"Status": 1,
"Documentid": 2,
"Errortext": "sample string 3",
"Xmlfilesuffix": "sample string 4",
"Filereference": "sample string 5",
"Document": "QEBA",
"Attachments": [
{
"Attachmenttype": 1,
"Documentid": 2,
"Attachmentid": 1,
"Filereference": "sample string 3",
"Filename": "sample string 4",
"DceInvoice": "QEBA"
},
{
"Attachmenttype": 1,
"Documentid": 2,
"Attachmentid": 1,
"Filereference": "sample string 3",
"Filename": "sample string 4",
"DceInvoice": "QEBA"
},
{
"Attachmenttype": 1,
"Documentid": 2,
"Attachmentid": 1,
"Filereference": "sample string 3",
"Filename": "sample string 4",
"DceInvoice": "QEBA"
}
]
}
}
}
application/xml, text/xml
Sample:
<UserPrivilegeHead xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Visma.PXWebApi.Domain.Entities.Registration">
<Message xmlns:d2p1="http://schemas.datacontract.org/2004/07/Visma.PXWebApi.Domain.Entities.Misc">
<d2p1:AutoInvoiceData>
<d2p1:Attachments>
<d2p1:AutoInvoiceAttachment>
<d2p1:Attachmentid>1</d2p1:Attachmentid>
<d2p1:Attachmenttype>1</d2p1:Attachmenttype>
<d2p1:DceInvoice>QEBA</d2p1:DceInvoice>
<d2p1:Documentid>2</d2p1:Documentid>
<d2p1:Filename>sample string 4</d2p1:Filename>
<d2p1:Filereference>sample string 3</d2p1:Filereference>
</d2p1:AutoInvoiceAttachment>
<d2p1:AutoInvoiceAttachment>
<d2p1:Attachmentid>1</d2p1:Attachmentid>
<d2p1:Attachmenttype>1</d2p1:Attachmenttype>
<d2p1:DceInvoice>QEBA</d2p1:DceInvoice>
<d2p1:Documentid>2</d2p1:Documentid>
<d2p1:Filename>sample string 4</d2p1:Filename>
<d2p1:Filereference>sample string 3</d2p1:Filereference>
</d2p1:AutoInvoiceAttachment>
<d2p1:AutoInvoiceAttachment>
<d2p1:Attachmentid>1</d2p1:Attachmentid>
<d2p1:Attachmenttype>1</d2p1:Attachmenttype>
<d2p1:DceInvoice>QEBA</d2p1:DceInvoice>
<d2p1:Documentid>2</d2p1:Documentid>
<d2p1:Filename>sample string 4</d2p1:Filename>
<d2p1:Filereference>sample string 3</d2p1:Filereference>
</d2p1:AutoInvoiceAttachment>
</d2p1:Attachments>
<d2p1:Document>QEBA</d2p1:Document>
<d2p1:Documentid>2</d2p1:Documentid>
<d2p1:Errortext>sample string 3</d2p1:Errortext>
<d2p1:Filereference>sample string 5</d2p1:Filereference>
<d2p1:Status>1</d2p1:Status>
<d2p1:Xmlfilesuffix>sample string 4</d2p1:Xmlfilesuffix>
</d2p1:AutoInvoiceData>
<d2p1:Created>sample string 4</d2p1:Created>
<d2p1:Datareference>sample string 2</d2p1:Datareference>
<d2p1:Messagetext>sample string 3</d2p1:Messagetext>
<d2p1:Messagetype>1</d2p1:Messagetype>
<d2p1:Noofrowssub1>1</d2p1:Noofrowssub1>
<d2p1:Noofrowssub2>1</d2p1:Noofrowssub2>
<d2p1:Noofrowssub3>1</d2p1:Noofrowssub3>
<d2p1:Noofrowssub4>1</d2p1:Noofrowssub4>
<d2p1:Noofrowssub5>1</d2p1:Noofrowssub5>
<d2p1:Noofrowssub6>1</d2p1:Noofrowssub6>
</Message>
<Servertime>2026-05-09T17:17:36.0484346+02:00</Servertime>
<Userprivileges>
<UserPrivilege>
<Adaccount>sample string 7</Adaccount>
<Blocked>true</Blocked>
<Companycode>sample string 10</Companycode>
<Costcenter>sample string 9</Costcenter>
<Emailid>sample string 6</Emailid>
<Employeeid>sample string 3</Employeeid>
<Employeename>sample string 4</Employeename>
<Employmenttypecurrent>5</Employmenttypecurrent>
<Licenselevel>sample string 8</Licenselevel>
<Privileges>
<Privilege>
<Privilegelevel>4</Privilegelevel>
<Privilegename>sample string 3</Privilegename>
<Privstringid>sample string 2</Privstringid>
<Userid>sample string 1</Userid>
</Privilege>
<Privilege>
<Privilegelevel>4</Privilegelevel>
<Privilegename>sample string 3</Privilegename>
<Privstringid>sample string 2</Privstringid>
<Userid>sample string 1</Userid>
</Privilege>
<Privilege>
<Privilegelevel>4</Privilegelevel>
<Privilegename>sample string 3</Privilegename>
<Privstringid>sample string 2</Privstringid>
<Userid>sample string 1</Userid>
</Privilege>
</Privileges>
<Userid>sample string 1</Userid>
<Username>sample string 2</Username>
</UserPrivilege>
<UserPrivilege>
<Adaccount>sample string 7</Adaccount>
<Blocked>true</Blocked>
<Companycode>sample string 10</Companycode>
<Costcenter>sample string 9</Costcenter>
<Emailid>sample string 6</Emailid>
<Employeeid>sample string 3</Employeeid>
<Employeename>sample string 4</Employeename>
<Employmenttypecurrent>5</Employmenttypecurrent>
<Licenselevel>sample string 8</Licenselevel>
<Privileges>
<Privilege>
<Privilegelevel>4</Privilegelevel>
<Privilegename>sample string 3</Privilegename>
<Privstringid>sample string 2</Privstringid>
<Userid>sample string 1</Userid>
</Privilege>
<Privilege>
<Privilegelevel>4</Privilegelevel>
<Privilegename>sample string 3</Privilegename>
<Privstringid>sample string 2</Privstringid>
<Userid>sample string 1</Userid>
</Privilege>
<Privilege>
<Privilegelevel>4</Privilegelevel>
<Privilegename>sample string 3</Privilegename>
<Privstringid>sample string 2</Privstringid>
<Userid>sample string 1</Userid>
</Privilege>
</Privileges>
<Userid>sample string 1</Userid>
<Username>sample string 2</Username>
</UserPrivilege>
<UserPrivilege>
<Adaccount>sample string 7</Adaccount>
<Blocked>true</Blocked>
<Companycode>sample string 10</Companycode>
<Costcenter>sample string 9</Costcenter>
<Emailid>sample string 6</Emailid>
<Employeeid>sample string 3</Employeeid>
<Employeename>sample string 4</Employeename>
<Employmenttypecurrent>5</Employmenttypecurrent>
<Licenselevel>sample string 8</Licenselevel>
<Privileges>
<Privilege>
<Privilegelevel>4</Privilegelevel>
<Privilegename>sample string 3</Privilegename>
<Privstringid>sample string 2</Privstringid>
<Userid>sample string 1</Userid>
</Privilege>
<Privilege>
<Privilegelevel>4</Privilegelevel>
<Privilegename>sample string 3</Privilegename>
<Privstringid>sample string 2</Privstringid>
<Userid>sample string 1</Userid>
</Privilege>
<Privilege>
<Privilegelevel>4</Privilegelevel>
<Privilegename>sample string 3</Privilegename>
<Privstringid>sample string 2</Privstringid>
<Userid>sample string 1</Userid>
</Privilege>
</Privileges>
<Userid>sample string 1</Userid>
<Username>sample string 2</Username>
</UserPrivilege>
</Userprivileges>
</UserPrivilegeHead>