/messages Permission level: 5

get/messages

Request

  • Base URL
    https://www.humanity.com/api/v2
  • Auth
    API key in query parameter access_token

Query parameters

modestring

Mode (enum[inbox,outbox]) inbox: Recived messages - outbox: Sent messages

limitinteger

Sets the limit for the number of returned messages

offsetstring
idstring

Message id

Response

200

statusinteger
tokenstring
errorunknown

Example response

{
  "status": 1,
  "data": {
    "4055810": {
      "id": 4055810,
      "conversation": 4055810,
      "sender": 3842511,
      "sent": 1522830003,
      "subject": "Hello",
      "message": "Hello World",
      "receivers": {
        "individuals": [
          "3842510"
        ]
      }
    },
    "4055811": {
      "id": 4055811,
      "conversation": 4055811,
      "sender": 3842511,
      "sent": 1522830308,
      "subject": "Shift pickup",
      "message": "Good morning Chuck, let me know if there is a shift available for pick up.\n\nThanks",
      "receivers": {
        "individuals": [
          "3842510"
        ]
      }
    }
  },
  "token": "xxxxxxxxxx"
}

Changes