Get Messages
Header Parameters
Optional correlation ID associated with the request, comprised of alphanumeric or hyphen characters up to 36 characters in length.
Query Parameters
The start of the date range. Default is 3 years ago.
The end of the date range. Default is now.
Filter for read status of messages.
Filter for archived status of messages.
Filter for favorite status of messages.
The number of records returned at once. Can be from 1-100, default is 25.
The current page index of the message records. Index starts at 0.
Response
OK
Response Attributes
The current page number in the paginated results.
The number of items returned per page in the results.
Indicates if there are additional pages of results.
The total count of unread messages for the person.
A list of messages.
Show child attributes
Bad Request
Response Attributes
List of invalid parameters that caused the validation error.
Show child attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
Unauthorized
Response Attributes
List of invalid parameters that caused the validation error.
Show child attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
Not Found
Response Attributes
List of invalid parameters that caused the validation error.
Show child attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
Internal Server Error
Unexpected error
Response Attributes
List of invalid parameters that caused the validation error.
Show child attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.