Request information
- HTTP method: GET
- URL
- CertManager UAT:
https://certmanager-uat.sovos.com/api/pre-auth/v1/configuration/customers - CertManager Production:
https://certmanager.sovos.com/api/pre-auth/v1/configuration/customers
- CertManager UAT:
Parameters
Field |
Field type |
Data type |
Required or optional |
Description |
| sortBy | Query | String | Optional |
Sort the customer list by one of the following values:
|
| order | Query | String | Optional |
If ASC, sort the customer list in ascending order If DESC, sort the customer list in descending order |
| perPage | Query | Integer | Optional | Number of customers to return per page |
| page | Query | Integer | Optional | The page of customers to return. The sortBy, order, and perPage parameters will be applied first, followed by the page parameter. 0 is the first page. |
| customerNameOrNumber | Query | String | Optional | Filter by customerName or customerNumber |
| parentNameOrNumber | Query | String | Optional | Return all customers with a specified parent customer |
| customersWithNoEmailAddresses | Query | Boolean | Optional |
If true, the list will only include customers without email addresses If false, the list will only include customers with email addresses |
| lastModifiedDate | Query | String | Optional | Return all customers last modified on, before, or after a certain date in milliseconds, depending on the value of lastModifiedDateIs |
| lastModifiedDateIs | Query | String | Optional |
Determines how the list is filtered by the last modified date Possible values:
|
| lastModifiedEndDate | Query | String | Optional |
If lastModifiedDateIs = between, this is the last date of the date range Returns all customers last modified between lastModifiedDate and lastModifiedEndDate |
Example response
{
"status": 200,
"message": "CorrelationId: 9f53b287-ca77-4772-96aa-a2b3bff7a69c - Retrieved customers",
"data": {
"pageState": {
"page": 0,
"perPage": 50,
"totalPages": 81,
"totalEntries": 4012,
"order": "desc",
"sortBy": "dateOfCreation"
},
"items": {
"content": [
{
"customerId": "3b6a4a83-e917-42df-b1b3-9d501f73b4ec",
"customerName": "NewCustomerNameExample",
"customerNumber": "CustomerNumberExample",
"contactName": "Contact Name",
"replyToContactName": "Representative Name",
"replyToContactEmail": "emailaddress@test.com",
"parentId": null,
"parentName": null,
"parentNumber": null,
"phoneNumber": "1234567890",
"faxNumber": "0987654321",
"notes": "notes field example",
"savedInGtd": true,
"gtdErrorMessage": null,
"customerEmails": "contact.email@test.com",
"lastModified": 1732633398314
},
...
],
"pageable": {
"pageNumber": 0,
"pageSize": 50,
"sort": {
"sorted": true,
"unsorted": false,
"empty": false
},
"offset": 0,
"paged": true,
"unpaged": false
},
"totalElements": 4012,
"totalPages": 81,
"last": false,
"numberOfElements": 50,
"first": true,
"size": 50,
"number": 0,
"sort": {
"sorted": true,
"unsorted": false,
"empty": false
},
"empty": false
}
},
"success": true
}