Get a Thread

This endpoint retrieves all messages in a thread.

info

This operation requires authentication.

HTTP Request

GET /api/v2/pm/

Parameters

Name	In	Type	Required	Description
thread	query	integer	(one between thread, user or group is required)	The id of the thread
user	query	integer	(one between thread, user or group is required)	The id of the user
group	query	integer	(one between thread, user or group is required)	The id of the group (only if grouping and tagging features are enabled)
before_message	query	integer	false	Return all messages before this id of the message (excluded before_message)
from_message	query	integer	false	Return all messages from this id of the message (included from_message)
limit	query	integer	false	Number of results to return per page
offset	query	integer	false	The initial index from which to return the results

Example Request

JavaScript

const headers = {
  'Accept':'application/json',
  'Authorization': 'Bearer {access_token}'
};

fetch('/api/v2/pm/?thread={id}',
{
  method: 'GET',
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Bash

# You can also use wget
curl -X GET /api/v2/pm/?thread={id} \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access_token}'

Responses

Status	Meaning	Description	Schema
200	OK	Response status code	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» count	integer	false	none	Total results count
» next	string(uri)¦null	false	none	Next page url
» previous	string(uri)¦null	false	none	Previous page url
» results	list(Private Message Thread)	false	none	List of results

Example responses

200

{
  "count": "integer",
  "next": "string(uri)",
  "previous": "string(uri)",
  "results": [ 
    {
      "id": "integer",
      "message": "string",
      "sender": {User},
      "receiver": {User},
      "created_at": "string",
      "status": "string",
      "thread_id": "integer"
    },
    {
      "id": "integer",
      "message": "string",
      "sender": {User},
      "receiver": {User},
      "created_at": "string",
      "status": "string",
      "thread_id": "integer"
    }    
  ]
}