GET Get Order Contacts
Base URLs
Demo URL: https://demoapi.openletterconnect.com/api/v1
Production URL: https://api.openletterconnect.com/api/v1
{{base_url}}/orders/detail/contacts/1?search=NJ&addressStatus=["Failed", "Verified", "Corrected"]&mailedStatus=["Mailed", "Completed", "Processing"]&deliveredDate={"startDate": "2023-10-02", "endDate":"2023-10-02"}
Description
This endpoint is used to retrieve detailed information about the contacts associated with a specific order. By providing the order ID, you can filter the results based on search terms, address status, mailing status, and delivery date range. The response will include relevant contact details related to the specified order.
AUTHORIZATION
Bearer Token
- Token:
{{jwt_token}}
PARAMS
| Name | Data Type | Required | Description | Value |
|---|---|---|---|---|
| search | string | Yes | The search term (e.g., NJ) | NJ |
| addressStatus | array | Yes | The status of the address (e.g., Failed, Verified, Corrected) | ["Failed", "Verified", "Corrected"] |
| mailedStatus | array | Yes | The status of mailing (e.g., Mailed, Completed, Processing) | ["Mailed", "Completed", "Processing"] |
| deliveredDate | object | Yes | The date range for the delivery (start and end date) | {"startDate": "2023-10-02", "endDate":"2023-10-02"} |
Example Request
curl --location -g '{{base_url}}/orders/detail/contacts/1?search=NJ&addressStatus=[%22Failed%22%2C%20%22Verified%22%2C%20%22Corrected%22]&mailedStatus=[%22Mailed%22%2C%20%22Completed%22%2C%20%22Processing%22]&deliveredDate={%22startDate%22%3A%20%222023-10-02%22%2C%20%22endDate%22%3A%222023-10-02%22}'
Example Response
No response body