Persons
Get the list of persons matching search criteria.
Returns the list of persons with basic information: id, lastname, firstname, address, identifier, identifierType and personNumber.
get/persons
Request
- Base URL: https://pts-api.procountor.com/api
- URL: https://pts-api.procountor.com/api/persons
- Auth: HTTP bearer
Query parameters
personNumberstring
Person number
Also partial - search matches returned.
mainPersonGroupstring
Main group name of type PERSON
Only exact - search match returned.
personGroupIdinteger
Unique identifier of Business Partner Group of type PERSON
includeInactiveboolean
Include inactive persons
sizeinteger
Page size for the results. Maximum value: 200.
pageinteger
Page number for the results
orderById'ASC' | 'DESC'
Order the results by Person ID
Headers
namestring
Name of person (combined as lastname, firstname) matched by substring
identifierstring
Identifier of the person (SSN) or business identifier
Also partial - search matches returned.
Response
List of persons was successfully returned.
Changes
No recorded changes to this operation across all 1 revision of this API.