GET pxapi/Employee?selection={selection}&inclNotActive={inclNotActive}&inclSubsets={inclSubsets}&keyValue={keyValue}&companyId={companyId}
Retrieves employees according to selection and keyValue
Request Information
Parameters
| Name | Description | Additional information |
|---|---|---|
| selection | 2 - list employees on the profitcentre stated in param keyValue
3 - list employees on the attestgroup stated in param keyValue
4 - get data for the employee-id in keyValue
5 - list employees with the category stated in param keyValue |
Define this parameter in the request URI. |
| 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. |
| keyValue | Profitcentre-ID to get data for when selection = 2
Attestgroup-ID to get data for when selection = 3
Employee-ID to get data for when selection = 4
Category-ID to get data for when selection = 5 |
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:18:19.4332998+02:00",
"Employees": [
{
"Employeeid": "sample string 1",
"Name": "sample string 2",
"Employmentstart": "2026-05-09T17:18:19.4332998+02:00",
"Employmentend": "2026-05-09T17:18:19.4332998+02:00",
"Employmenttypecurrent": 4,
"Worktimecurrent": 5,
"Gender": "sample string 6",
"Projectresponsible": 7,
"Emailid": "sample string 8",
"Phonework": "sample string 9",
"Role": "sample string 10",
"Attestgroup": "sample string 11",
"Costcenter": "sample string 12",
"Companycode": "sample string 13",
"Object6": "sample string 14",
"Object7": "sample string 15",
"Object8": "sample string 16",
"Periodclass": "sample string 17",
"Debgradelimit": 1.0,
"Blocked": true,
"Groups": [
{
"Id": "sample string 1",
"Grouptype": "sample string 2",
"Groupid": "sample string 3"
},
{
"Id": "sample string 1",
"Grouptype": "sample string 2",
"Groupid": "sample string 3"
},
{
"Id": "sample string 1",
"Grouptype": "sample string 2",
"Groupid": "sample string 3"
}
]
},
{
"Employeeid": "sample string 1",
"Name": "sample string 2",
"Employmentstart": "2026-05-09T17:18:19.4332998+02:00",
"Employmentend": "2026-05-09T17:18:19.4332998+02:00",
"Employmenttypecurrent": 4,
"Worktimecurrent": 5,
"Gender": "sample string 6",
"Projectresponsible": 7,
"Emailid": "sample string 8",
"Phonework": "sample string 9",
"Role": "sample string 10",
"Attestgroup": "sample string 11",
"Costcenter": "sample string 12",
"Companycode": "sample string 13",
"Object6": "sample string 14",
"Object7": "sample string 15",
"Object8": "sample string 16",
"Periodclass": "sample string 17",
"Debgradelimit": 1.0,
"Blocked": true,
"Groups": [
{
"Id": "sample string 1",
"Grouptype": "sample string 2",
"Groupid": "sample string 3"
},
{
"Id": "sample string 1",
"Grouptype": "sample string 2",
"Groupid": "sample string 3"
},
{
"Id": "sample string 1",
"Grouptype": "sample string 2",
"Groupid": "sample string 3"
}
]
},
{
"Employeeid": "sample string 1",
"Name": "sample string 2",
"Employmentstart": "2026-05-09T17:18:19.4332998+02:00",
"Employmentend": "2026-05-09T17:18:19.4332998+02:00",
"Employmenttypecurrent": 4,
"Worktimecurrent": 5,
"Gender": "sample string 6",
"Projectresponsible": 7,
"Emailid": "sample string 8",
"Phonework": "sample string 9",
"Role": "sample string 10",
"Attestgroup": "sample string 11",
"Costcenter": "sample string 12",
"Companycode": "sample string 13",
"Object6": "sample string 14",
"Object7": "sample string 15",
"Object8": "sample string 16",
"Periodclass": "sample string 17",
"Debgradelimit": 1.0,
"Blocked": true,
"Groups": [
{
"Id": "sample string 1",
"Grouptype": "sample string 2",
"Groupid": "sample string 3"
},
{
"Id": "sample string 1",
"Grouptype": "sample string 2",
"Groupid": "sample string 3"
},
{
"Id": "sample string 1",
"Grouptype": "sample string 2",
"Groupid": "sample string 3"
}
]
}
],
"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:
<EmployeeHead xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Visma.PXWebApi.Domain.Entities.Registration">
<Employees>
<Employee>
<Attestgroup>sample string 11</Attestgroup>
<Blocked>true</Blocked>
<Companycode>sample string 13</Companycode>
<Costcenter>sample string 12</Costcenter>
<Debgradelimit>1</Debgradelimit>
<Emailid>sample string 8</Emailid>
<Employeeid>sample string 1</Employeeid>
<Employmentend>2026-05-09T17:18:19.4332998+02:00</Employmentend>
<Employmentstart>2026-05-09T17:18:19.4332998+02:00</Employmentstart>
<Employmenttypecurrent>4</Employmenttypecurrent>
<Gender>sample string 6</Gender>
<Groups>
<GroupReference>
<Groupid>sample string 3</Groupid>
<Grouptype>sample string 2</Grouptype>
<Id>sample string 1</Id>
</GroupReference>
<GroupReference>
<Groupid>sample string 3</Groupid>
<Grouptype>sample string 2</Grouptype>
<Id>sample string 1</Id>
</GroupReference>
<GroupReference>
<Groupid>sample string 3</Groupid>
<Grouptype>sample string 2</Grouptype>
<Id>sample string 1</Id>
</GroupReference>
</Groups>
<Name>sample string 2</Name>
<Object6>sample string 14</Object6>
<Object7>sample string 15</Object7>
<Object8>sample string 16</Object8>
<Periodclass>sample string 17</Periodclass>
<Phonework>sample string 9</Phonework>
<Projectresponsible>7</Projectresponsible>
<Role>sample string 10</Role>
<Worktimecurrent>5</Worktimecurrent>
</Employee>
<Employee>
<Attestgroup>sample string 11</Attestgroup>
<Blocked>true</Blocked>
<Companycode>sample string 13</Companycode>
<Costcenter>sample string 12</Costcenter>
<Debgradelimit>1</Debgradelimit>
<Emailid>sample string 8</Emailid>
<Employeeid>sample string 1</Employeeid>
<Employmentend>2026-05-09T17:18:19.4332998+02:00</Employmentend>
<Employmentstart>2026-05-09T17:18:19.4332998+02:00</Employmentstart>
<Employmenttypecurrent>4</Employmenttypecurrent>
<Gender>sample string 6</Gender>
<Groups>
<GroupReference>
<Groupid>sample string 3</Groupid>
<Grouptype>sample string 2</Grouptype>
<Id>sample string 1</Id>
</GroupReference>
<GroupReference>
<Groupid>sample string 3</Groupid>
<Grouptype>sample string 2</Grouptype>
<Id>sample string 1</Id>
</GroupReference>
<GroupReference>
<Groupid>sample string 3</Groupid>
<Grouptype>sample string 2</Grouptype>
<Id>sample string 1</Id>
</GroupReference>
</Groups>
<Name>sample string 2</Name>
<Object6>sample string 14</Object6>
<Object7>sample string 15</Object7>
<Object8>sample string 16</Object8>
<Periodclass>sample string 17</Periodclass>
<Phonework>sample string 9</Phonework>
<Projectresponsible>7</Projectresponsible>
<Role>sample string 10</Role>
<Worktimecurrent>5</Worktimecurrent>
</Employee>
<Employee>
<Attestgroup>sample string 11</Attestgroup>
<Blocked>true</Blocked>
<Companycode>sample string 13</Companycode>
<Costcenter>sample string 12</Costcenter>
<Debgradelimit>1</Debgradelimit>
<Emailid>sample string 8</Emailid>
<Employeeid>sample string 1</Employeeid>
<Employmentend>2026-05-09T17:18:19.4332998+02:00</Employmentend>
<Employmentstart>2026-05-09T17:18:19.4332998+02:00</Employmentstart>
<Employmenttypecurrent>4</Employmenttypecurrent>
<Gender>sample string 6</Gender>
<Groups>
<GroupReference>
<Groupid>sample string 3</Groupid>
<Grouptype>sample string 2</Grouptype>
<Id>sample string 1</Id>
</GroupReference>
<GroupReference>
<Groupid>sample string 3</Groupid>
<Grouptype>sample string 2</Grouptype>
<Id>sample string 1</Id>
</GroupReference>
<GroupReference>
<Groupid>sample string 3</Groupid>
<Grouptype>sample string 2</Grouptype>
<Id>sample string 1</Id>
</GroupReference>
</Groups>
<Name>sample string 2</Name>
<Object6>sample string 14</Object6>
<Object7>sample string 15</Object7>
<Object8>sample string 16</Object8>
<Periodclass>sample string 17</Periodclass>
<Phonework>sample string 9</Phonework>
<Projectresponsible>7</Projectresponsible>
<Role>sample string 10</Role>
<Worktimecurrent>5</Worktimecurrent>
</Employee>
</Employees>
<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:18:19.4332998+02:00</Servertime>
</EmployeeHead>