Get messages
This endpoint returns a list of your messages, separated by type.
Request
HTTP Header | Value |
---|---|
Authorization |
A valid JSON Web Token, of the form Bearer ENCODEDHEADER.ENCODEDPAYLOAD.ENCODEDSIGNATURE
|
Examples
GET /v1/members/messages HTTP/1.1
Host: api.thefifthworld.com
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
Response
If you’ve provided a valid JSON Web Token, the API responds with a JSON object with properties
confirmation
, error
, warning
, and info
.
Each one provides an array of strings, each string a message for you of that type.
- Confirmations tell you that something you tried to do succeeded.
- Errors tell you that something you tried to do failed.
- Warnings inform you when something hasn’t failed exactly, but could have effects you might not have wanted or anticipated, or might have such effects in the future.
- Informational messages tell you about things you might want to know about, but don’t really fit into any of the other categories.
If the API verifies your authentication, you will receive this object even if all of the properties
within it only provide empty arrays. If the API could not verify your authentication, it responds with
a 401
HTTP status.
Example
{
"confirmation": [
"The invitation you sent went out successfully."
],
"error": [
"Failed to connect the OAuth 2.0 provider you requested.
],
"warning": [
"Your passphrase looks pretty short. You could improve your account security by making it longer."
],
"info": [
"Frogs absorb water through their skin so they don't need to drink."
]
}