GET api/entity/person/staff/GetStaff
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| PersonIDs |
Gets or sets the person ids. |
Collection of integer |
None. |
| Since |
The timestamp to use. This should always be UTC. |
date |
None. |
Body Parameters
None.
Response Information
Resource Description
WebMethodResultOfListOfStaff| Name | Description | Type | Additional information |
|---|---|---|---|
| Result | Collection of Staff |
None. |
|
| Success | boolean |
None. |
|
| ErrorText | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Result": [
{
"PersonID": 1,
"StaffID": 2,
"Address1": "sample string 3",
"Address2": "sample string 4",
"City": "sample string 5",
"State": "sample string 6",
"Zip": "sample string 7",
"Country": "sample string 8",
"Birthplace": "sample string 9",
"Citizenship": "sample string 10",
"BestTimeToCall": "sample string 11",
"SSN": "sample string 12",
"LicenseState": "sample string 13",
"LicenseNumber": "sample string 14",
"BusLicense": true,
"IsStudent": "sample string 15",
"LeadSource": "sample string 16",
"Highschool": "sample string 17",
"HighschoolGraduation": "sample string 18",
"SchoolName": "sample string 19",
"SchoolAddress1": "sample string 20",
"SchoolAddress2": "sample string 21",
"SchoolCity": "sample string 22",
"SchoolState": "sample string 23",
"SchoolZip": "sample string 24",
"SchoolCountry": "sample string 25",
"SchoolPhone": "sample string 26",
"Extracurricular": "sample string 27",
"Major": "sample string 28",
"Career": "sample string 29",
"Graduation": "sample string 30",
"MiddleInt": "sample string 31",
"MailingTitle": "sample string 32",
"Height": "sample string 33",
"Weight": "sample string 34",
"PayrollNumber": "sample string 35",
"MaritalStatus": true,
"FedWithholding": "sample string 36",
"StateWithholding": "sample string 37",
"StateUnemployment": true,
"SsTax": true,
"Nickname": "sample string 38",
"AgencyID": 1,
"PrimaryAddressID": 1,
"International": "sample string 39",
"CarMake": "sample string 40",
"CarModel": "sample string 41",
"CarYear": "sample string 42",
"CarColor": "sample string 43",
"CarLicensePlateState": "sample string 44",
"CarLicensePlateNum": "sample string 45",
"InsuranceCompany": "sample string 46",
"PolicyNumber": "sample string 47",
"GroupPolicyNum": "sample string 48",
"PrescriptionPlan": "sample string 49",
"DoctorName": "sample string 50",
"DoctorPhone": "sample string 51",
"EmergencyContact": "sample string 52",
"EmergencyContact2": "sample string 53",
"EmergencyRelationship": "sample string 54",
"EmergencyAddress": "sample string 55",
"EmergencyNumber1": "sample string 56",
"EmergencyNumber2": "sample string 57",
"LastContact": "sample string 58",
"InterviewDateAsString": "2025-11-01T17:26:50.6433769-06:00",
"InterviewTimeAsString": "2025-11-01T17:26:50.6433769-06:00",
"InterviewStaff": "sample string 61",
"AcknowledgeStaffer": true,
"PartnerClientID": "sample string 62",
"BusinessPartnerUniqueKey": "sample string 63",
"GPA": "sample string 64",
"PreviousExperienceNotes": "sample string 65",
"AttentionNotes": "sample string 66",
"PrimaryAddress": true,
"SpringBreak": "sample string 67",
"SummerBreak": "sample string 68",
"TimeStamp": {
"Created": {
"PersonID": 1,
"DateTime": "sample string 1"
},
"Modified": {
"PersonID": 1,
"DateTime": "sample string 1"
},
"Archived": {
"PersonID": 1,
"DateTime": "sample string 1"
}
}
},
{
"PersonID": 1,
"StaffID": 2,
"Address1": "sample string 3",
"Address2": "sample string 4",
"City": "sample string 5",
"State": "sample string 6",
"Zip": "sample string 7",
"Country": "sample string 8",
"Birthplace": "sample string 9",
"Citizenship": "sample string 10",
"BestTimeToCall": "sample string 11",
"SSN": "sample string 12",
"LicenseState": "sample string 13",
"LicenseNumber": "sample string 14",
"BusLicense": true,
"IsStudent": "sample string 15",
"LeadSource": "sample string 16",
"Highschool": "sample string 17",
"HighschoolGraduation": "sample string 18",
"SchoolName": "sample string 19",
"SchoolAddress1": "sample string 20",
"SchoolAddress2": "sample string 21",
"SchoolCity": "sample string 22",
"SchoolState": "sample string 23",
"SchoolZip": "sample string 24",
"SchoolCountry": "sample string 25",
"SchoolPhone": "sample string 26",
"Extracurricular": "sample string 27",
"Major": "sample string 28",
"Career": "sample string 29",
"Graduation": "sample string 30",
"MiddleInt": "sample string 31",
"MailingTitle": "sample string 32",
"Height": "sample string 33",
"Weight": "sample string 34",
"PayrollNumber": "sample string 35",
"MaritalStatus": true,
"FedWithholding": "sample string 36",
"StateWithholding": "sample string 37",
"StateUnemployment": true,
"SsTax": true,
"Nickname": "sample string 38",
"AgencyID": 1,
"PrimaryAddressID": 1,
"International": "sample string 39",
"CarMake": "sample string 40",
"CarModel": "sample string 41",
"CarYear": "sample string 42",
"CarColor": "sample string 43",
"CarLicensePlateState": "sample string 44",
"CarLicensePlateNum": "sample string 45",
"InsuranceCompany": "sample string 46",
"PolicyNumber": "sample string 47",
"GroupPolicyNum": "sample string 48",
"PrescriptionPlan": "sample string 49",
"DoctorName": "sample string 50",
"DoctorPhone": "sample string 51",
"EmergencyContact": "sample string 52",
"EmergencyContact2": "sample string 53",
"EmergencyRelationship": "sample string 54",
"EmergencyAddress": "sample string 55",
"EmergencyNumber1": "sample string 56",
"EmergencyNumber2": "sample string 57",
"LastContact": "sample string 58",
"InterviewDateAsString": "2025-11-01T17:26:50.6433769-06:00",
"InterviewTimeAsString": "2025-11-01T17:26:50.6433769-06:00",
"InterviewStaff": "sample string 61",
"AcknowledgeStaffer": true,
"PartnerClientID": "sample string 62",
"BusinessPartnerUniqueKey": "sample string 63",
"GPA": "sample string 64",
"PreviousExperienceNotes": "sample string 65",
"AttentionNotes": "sample string 66",
"PrimaryAddress": true,
"SpringBreak": "sample string 67",
"SummerBreak": "sample string 68",
"TimeStamp": {
"Created": {
"PersonID": 1,
"DateTime": "sample string 1"
},
"Modified": {
"PersonID": 1,
"DateTime": "sample string 1"
},
"Archived": {
"PersonID": 1,
"DateTime": "sample string 1"
}
}
}
],
"Success": true,
"ErrorText": "sample string 2"
}
application/javascript
Sample:
{"Result":[{"PersonID":1,"StaffID":2,"Address1":"sample string 3","Address2":"sample string 4","City":"sample string 5","State":"sample string 6","Zip":"sample string 7","Country":"sample string 8","Birthplace":"sample string 9","Citizenship":"sample string 10","BestTimeToCall":"sample string 11","SSN":"sample string 12","LicenseState":"sample string 13","LicenseNumber":"sample string 14","BusLicense":true,"IsStudent":"sample string 15","LeadSource":"sample string 16","Highschool":"sample string 17","HighschoolGraduation":"sample string 18","SchoolName":"sample string 19","SchoolAddress1":"sample string 20","SchoolAddress2":"sample string 21","SchoolCity":"sample string 22","SchoolState":"sample string 23","SchoolZip":"sample string 24","SchoolCountry":"sample string 25","SchoolPhone":"sample string 26","Extracurricular":"sample string 27","Major":"sample string 28","Career":"sample string 29","Graduation":"sample string 30","MiddleInt":"sample string 31","MailingTitle":"sample string 32","Height":"sample string 33","Weight":"sample string 34","PayrollNumber":"sample string 35","MaritalStatus":true,"FedWithholding":"sample string 36","StateWithholding":"sample string 37","StateUnemployment":true,"SsTax":true,"Nickname":"sample string 38","AgencyID":1,"PrimaryAddressID":1,"International":"sample string 39","CarMake":"sample string 40","CarModel":"sample string 41","CarYear":"sample string 42","CarColor":"sample string 43","CarLicensePlateState":"sample string 44","CarLicensePlateNum":"sample string 45","InsuranceCompany":"sample string 46","PolicyNumber":"sample string 47","GroupPolicyNum":"sample string 48","PrescriptionPlan":"sample string 49","DoctorName":"sample string 50","DoctorPhone":"sample string 51","EmergencyContact":"sample string 52","EmergencyContact2":"sample string 53","EmergencyRelationship":"sample string 54","EmergencyAddress":"sample string 55","EmergencyNumber1":"sample string 56","EmergencyNumber2":"sample string 57","LastContact":"sample string 58","InterviewDateAsString":"2025-11-01T17:26:50.6433769-06:00","InterviewTimeAsString":"2025-11-01T17:26:50.6433769-06:00","InterviewStaff":"sample string 61","AcknowledgeStaffer":true,"PartnerClientID":"sample string 62","BusinessPartnerUniqueKey":"sample string 63","GPA":"sample string 64","PreviousExperienceNotes":"sample string 65","AttentionNotes":"sample string 66","PrimaryAddress":true,"SpringBreak":"sample string 67","SummerBreak":"sample string 68","TimeStamp":{"Created":{"PersonID":1,"DateTime":"sample string 1"},"Modified":{"PersonID":1,"DateTime":"sample string 1"},"Archived":{"PersonID":1,"DateTime":"sample string 1"}}},{"PersonID":1,"StaffID":2,"Address1":"sample string 3","Address2":"sample string 4","City":"sample string 5","State":"sample string 6","Zip":"sample string 7","Country":"sample string 8","Birthplace":"sample string 9","Citizenship":"sample string 10","BestTimeToCall":"sample string 11","SSN":"sample string 12","LicenseState":"sample string 13","LicenseNumber":"sample string 14","BusLicense":true,"IsStudent":"sample string 15","LeadSource":"sample string 16","Highschool":"sample string 17","HighschoolGraduation":"sample string 18","SchoolName":"sample string 19","SchoolAddress1":"sample string 20","SchoolAddress2":"sample string 21","SchoolCity":"sample string 22","SchoolState":"sample string 23","SchoolZip":"sample string 24","SchoolCountry":"sample string 25","SchoolPhone":"sample string 26","Extracurricular":"sample string 27","Major":"sample string 28","Career":"sample string 29","Graduation":"sample string 30","MiddleInt":"sample string 31","MailingTitle":"sample string 32","Height":"sample string 33","Weight":"sample string 34","PayrollNumber":"sample string 35","MaritalStatus":true,"FedWithholding":"sample string 36","StateWithholding":"sample string 37","StateUnemployment":true,"SsTax":true,"Nickname":"sample string 38","AgencyID":1,"PrimaryAddressID":1,"International":"sample string 39","CarMake":"sample string 40","CarModel":"sample string 41","CarYear":"sample string 42","CarColor":"sample string 43","CarLicensePlateState":"sample string 44","CarLicensePlateNum":"sample string 45","InsuranceCompany":"sample string 46","PolicyNumber":"sample string 47","GroupPolicyNum":"sample string 48","PrescriptionPlan":"sample string 49","DoctorName":"sample string 50","DoctorPhone":"sample string 51","EmergencyContact":"sample string 52","EmergencyContact2":"sample string 53","EmergencyRelationship":"sample string 54","EmergencyAddress":"sample string 55","EmergencyNumber1":"sample string 56","EmergencyNumber2":"sample string 57","LastContact":"sample string 58","InterviewDateAsString":"2025-11-01T17:26:50.6433769-06:00","InterviewTimeAsString":"2025-11-01T17:26:50.6433769-06:00","InterviewStaff":"sample string 61","AcknowledgeStaffer":true,"PartnerClientID":"sample string 62","BusinessPartnerUniqueKey":"sample string 63","GPA":"sample string 64","PreviousExperienceNotes":"sample string 65","AttentionNotes":"sample string 66","PrimaryAddress":true,"SpringBreak":"sample string 67","SummerBreak":"sample string 68","TimeStamp":{"Created":{"PersonID":1,"DateTime":"sample string 1"},"Modified":{"PersonID":1,"DateTime":"sample string 1"},"Archived":{"PersonID":1,"DateTime":"sample string 1"}}}],"Success":true,"ErrorText":"sample string 2"}
application/xml, text/xml
Sample:
<WebMethodResultOfListOfStaff xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<Success>true</Success>
<ErrorText>sample string 2</ErrorText>
<Result>
<Staff>
<PersonID>1</PersonID>
<StaffID>2</StaffID>
<Address1>sample string 3</Address1>
<Address2>sample string 4</Address2>
<City>sample string 5</City>
<State>sample string 6</State>
<Zip>sample string 7</Zip>
<Country>sample string 8</Country>
<Birthplace>sample string 9</Birthplace>
<Citizenship>sample string 10</Citizenship>
<BestTimeToCall>sample string 11</BestTimeToCall>
<SSN>sample string 12</SSN>
<LicenseState>sample string 13</LicenseState>
<LicenseNumber>sample string 14</LicenseNumber>
<BusLicense>true</BusLicense>
<IsStudent>sample string 15</IsStudent>
<LeadSource>sample string 16</LeadSource>
<Highschool>sample string 17</Highschool>
<HighschoolGraduation>sample string 18</HighschoolGraduation>
<SchoolName>sample string 19</SchoolName>
<SchoolAddress1>sample string 20</SchoolAddress1>
<SchoolAddress2>sample string 21</SchoolAddress2>
<SchoolCity>sample string 22</SchoolCity>
<SchoolState>sample string 23</SchoolState>
<SchoolZip>sample string 24</SchoolZip>
<SchoolCountry>sample string 25</SchoolCountry>
<SchoolPhone>sample string 26</SchoolPhone>
<Extracurricular>sample string 27</Extracurricular>
<Major>sample string 28</Major>
<Career>sample string 29</Career>
<Graduation>sample string 30</Graduation>
<MiddleInt>sample string 31</MiddleInt>
<MailingTitle>sample string 32</MailingTitle>
<Height>sample string 33</Height>
<Weight>sample string 34</Weight>
<PayrollNumber>sample string 35</PayrollNumber>
<MaritalStatus>true</MaritalStatus>
<FedWithholding>sample string 36</FedWithholding>
<StateWithholding>sample string 37</StateWithholding>
<StateUnemployment>true</StateUnemployment>
<SsTax>true</SsTax>
<Nickname>sample string 38</Nickname>
<AgencyID>1</AgencyID>
<PrimaryAddressID>1</PrimaryAddressID>
<International>sample string 39</International>
<CarMake>sample string 40</CarMake>
<CarModel>sample string 41</CarModel>
<CarYear>sample string 42</CarYear>
<CarColor>sample string 43</CarColor>
<CarLicensePlateState>sample string 44</CarLicensePlateState>
<CarLicensePlateNum>sample string 45</CarLicensePlateNum>
<InsuranceCompany>sample string 46</InsuranceCompany>
<PolicyNumber>sample string 47</PolicyNumber>
<GroupPolicyNum>sample string 48</GroupPolicyNum>
<PrescriptionPlan>sample string 49</PrescriptionPlan>
<DoctorName>sample string 50</DoctorName>
<DoctorPhone>sample string 51</DoctorPhone>
<EmergencyContact>sample string 52</EmergencyContact>
<EmergencyContact2>sample string 53</EmergencyContact2>
<EmergencyRelationship>sample string 54</EmergencyRelationship>
<EmergencyAddress>sample string 55</EmergencyAddress>
<EmergencyNumber1>sample string 56</EmergencyNumber1>
<EmergencyNumber2>sample string 57</EmergencyNumber2>
<LastContact>sample string 58</LastContact>
<InterviewDateAsString>2025-11-01T17:26:50.6433769-06:00</InterviewDateAsString>
<InterviewDate>2025-11-01T17:26:50.6433769-06:00</InterviewDate>
<InterviewTimeAsString>2025-11-01T17:26:50.6433769-06:00</InterviewTimeAsString>
<InterviewTime>2025-11-01T17:26:50.6433769-06:00</InterviewTime>
<InterviewStaff>sample string 61</InterviewStaff>
<AcknowledgeStaffer>true</AcknowledgeStaffer>
<PartnerClientID>sample string 62</PartnerClientID>
<BusinessPartnerUniqueKey>sample string 63</BusinessPartnerUniqueKey>
<GPA>sample string 64</GPA>
<PreviousExperienceNotes>sample string 65</PreviousExperienceNotes>
<AttentionNotes>sample string 66</AttentionNotes>
<PrimaryAddress>true</PrimaryAddress>
<SpringBreak>sample string 67</SpringBreak>
<SummerBreak>sample string 68</SummerBreak>
<TimeStamp>
<Created>
<PersonID>1</PersonID>
<DateTime>sample string 1</DateTime>
</Created>
<Modified>
<PersonID>1</PersonID>
<DateTime>sample string 1</DateTime>
</Modified>
<Archived>
<PersonID>1</PersonID>
<DateTime>sample string 1</DateTime>
</Archived>
</TimeStamp>
</Staff>
<Staff>
<PersonID>1</PersonID>
<StaffID>2</StaffID>
<Address1>sample string 3</Address1>
<Address2>sample string 4</Address2>
<City>sample string 5</City>
<State>sample string 6</State>
<Zip>sample string 7</Zip>
<Country>sample string 8</Country>
<Birthplace>sample string 9</Birthplace>
<Citizenship>sample string 10</Citizenship>
<BestTimeToCall>sample string 11</BestTimeToCall>
<SSN>sample string 12</SSN>
<LicenseState>sample string 13</LicenseState>
<LicenseNumber>sample string 14</LicenseNumber>
<BusLicense>true</BusLicense>
<IsStudent>sample string 15</IsStudent>
<LeadSource>sample string 16</LeadSource>
<Highschool>sample string 17</Highschool>
<HighschoolGraduation>sample string 18</HighschoolGraduation>
<SchoolName>sample string 19</SchoolName>
<SchoolAddress1>sample string 20</SchoolAddress1>
<SchoolAddress2>sample string 21</SchoolAddress2>
<SchoolCity>sample string 22</SchoolCity>
<SchoolState>sample string 23</SchoolState>
<SchoolZip>sample string 24</SchoolZip>
<SchoolCountry>sample string 25</SchoolCountry>
<SchoolPhone>sample string 26</SchoolPhone>
<Extracurricular>sample string 27</Extracurricular>
<Major>sample string 28</Major>
<Career>sample string 29</Career>
<Graduation>sample string 30</Graduation>
<MiddleInt>sample string 31</MiddleInt>
<MailingTitle>sample string 32</MailingTitle>
<Height>sample string 33</Height>
<Weight>sample string 34</Weight>
<PayrollNumber>sample string 35</PayrollNumber>
<MaritalStatus>true</MaritalStatus>
<FedWithholding>sample string 36</FedWithholding>
<StateWithholding>sample string 37</StateWithholding>
<StateUnemployment>true</StateUnemployment>
<SsTax>true</SsTax>
<Nickname>sample string 38</Nickname>
<AgencyID>1</AgencyID>
<PrimaryAddressID>1</PrimaryAddressID>
<International>sample string 39</International>
<CarMake>sample string 40</CarMake>
<CarModel>sample string 41</CarModel>
<CarYear>sample string 42</CarYear>
<CarColor>sample string 43</CarColor>
<CarLicensePlateState>sample string 44</CarLicensePlateState>
<CarLicensePlateNum>sample string 45</CarLicensePlateNum>
<InsuranceCompany>sample string 46</InsuranceCompany>
<PolicyNumber>sample string 47</PolicyNumber>
<GroupPolicyNum>sample string 48</GroupPolicyNum>
<PrescriptionPlan>sample string 49</PrescriptionPlan>
<DoctorName>sample string 50</DoctorName>
<DoctorPhone>sample string 51</DoctorPhone>
<EmergencyContact>sample string 52</EmergencyContact>
<EmergencyContact2>sample string 53</EmergencyContact2>
<EmergencyRelationship>sample string 54</EmergencyRelationship>
<EmergencyAddress>sample string 55</EmergencyAddress>
<EmergencyNumber1>sample string 56</EmergencyNumber1>
<EmergencyNumber2>sample string 57</EmergencyNumber2>
<LastContact>sample string 58</LastContact>
<InterviewDateAsString>2025-11-01T17:26:50.6433769-06:00</InterviewDateAsString>
<InterviewDate>2025-11-01T17:26:50.6433769-06:00</InterviewDate>
<InterviewTimeAsString>2025-11-01T17:26:50.6433769-06:00</InterviewTimeAsString>
<InterviewTime>2025-11-01T17:26:50.6433769-06:00</InterviewTime>
<InterviewStaff>sample string 61</InterviewStaff>
<AcknowledgeStaffer>true</AcknowledgeStaffer>
<PartnerClientID>sample string 62</PartnerClientID>
<BusinessPartnerUniqueKey>sample string 63</BusinessPartnerUniqueKey>
<GPA>sample string 64</GPA>
<PreviousExperienceNotes>sample string 65</PreviousExperienceNotes>
<AttentionNotes>sample string 66</AttentionNotes>
<PrimaryAddress>true</PrimaryAddress>
<SpringBreak>sample string 67</SpringBreak>
<SummerBreak>sample string 68</SummerBreak>
<TimeStamp>
<Created>
<PersonID>1</PersonID>
<DateTime>sample string 1</DateTime>
</Created>
<Modified>
<PersonID>1</PersonID>
<DateTime>sample string 1</DateTime>
</Modified>
<Archived>
<PersonID>1</PersonID>
<DateTime>sample string 1</DateTime>
</Archived>
</TimeStamp>
</Staff>
</Result>
</WebMethodResultOfListOfStaff>