Skip to main content
POST
/
api2
/
v1
/
jobs
/
conversations
/
searchByProject
Search conversation by project
curl --request POST \
  --url https://cloud.memsource.com/web/api2/v1/jobs/conversations/searchByProject \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "jobPartUidRef": {
    "uid": "3HYnHHLkTPJfMxBCDbPXFe"
  },
  "includeDeleted": true,
  "mentionedUid": "<string>",
  "pageRequest": {
    "pageNumber": 123,
    "pageSize": 123,
    "sort": {
      "orders": [
        {
          "property": "<string>"
        }
      ]
    }
  },
  "since": "2024-07-21T10:15:27.819Z",
  "status": "<string>",
  "text": "<string>"
}
'
import requests

url = "https://cloud.memsource.com/web/api2/v1/jobs/conversations/searchByProject"

payload = {
    "jobPartUidRef": { "uid": "3HYnHHLkTPJfMxBCDbPXFe" },
    "includeDeleted": True,
    "mentionedUid": "<string>",
    "pageRequest": {
        "pageNumber": 123,
        "pageSize": 123,
        "sort": { "orders": [{ "property": "<string>" }] }
    },
    "since": "2024-07-21T10:15:27.819Z",
    "status": "<string>",
    "text": "<string>"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    jobPartUidRef: {uid: '3HYnHHLkTPJfMxBCDbPXFe'},
    includeDeleted: true,
    mentionedUid: '<string>',
    pageRequest: {pageNumber: 123, pageSize: 123, sort: {orders: [{property: '<string>'}]}},
    since: '2024-07-21T10:15:27.819Z',
    status: '<string>',
    text: '<string>'
  })
};

fetch('https://cloud.memsource.com/web/api2/v1/jobs/conversations/searchByProject', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://cloud.memsource.com/web/api2/v1/jobs/conversations/searchByProject",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'jobPartUidRef' => [
        'uid' => '3HYnHHLkTPJfMxBCDbPXFe'
    ],
    'includeDeleted' => true,
    'mentionedUid' => '<string>',
    'pageRequest' => [
        'pageNumber' => 123,
        'pageSize' => 123,
        'sort' => [
                'orders' => [
                                [
                                                                'property' => '<string>'
                                ]
                ]
        ]
    ],
    'since' => '2024-07-21T10:15:27.819Z',
    'status' => '<string>',
    'text' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://cloud.memsource.com/web/api2/v1/jobs/conversations/searchByProject"

	payload := strings.NewReader("{\n  \"jobPartUidRef\": {\n    \"uid\": \"3HYnHHLkTPJfMxBCDbPXFe\"\n  },\n  \"includeDeleted\": true,\n  \"mentionedUid\": \"<string>\",\n  \"pageRequest\": {\n    \"pageNumber\": 123,\n    \"pageSize\": 123,\n    \"sort\": {\n      \"orders\": [\n        {\n          \"property\": \"<string>\"\n        }\n      ]\n    }\n  },\n  \"since\": \"2024-07-21T10:15:27.819Z\",\n  \"status\": \"<string>\",\n  \"text\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://cloud.memsource.com/web/api2/v1/jobs/conversations/searchByProject")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"jobPartUidRef\": {\n    \"uid\": \"3HYnHHLkTPJfMxBCDbPXFe\"\n  },\n  \"includeDeleted\": true,\n  \"mentionedUid\": \"<string>\",\n  \"pageRequest\": {\n    \"pageNumber\": 123,\n    \"pageSize\": 123,\n    \"sort\": {\n      \"orders\": [\n        {\n          \"property\": \"<string>\"\n        }\n      ]\n    }\n  },\n  \"since\": \"2024-07-21T10:15:27.819Z\",\n  \"status\": \"<string>\",\n  \"text\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://cloud.memsource.com/web/api2/v1/jobs/conversations/searchByProject")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"jobPartUidRef\": {\n    \"uid\": \"3HYnHHLkTPJfMxBCDbPXFe\"\n  },\n  \"includeDeleted\": true,\n  \"mentionedUid\": \"<string>\",\n  \"pageRequest\": {\n    \"pageNumber\": 123,\n    \"pageSize\": 123,\n    \"sort\": {\n      \"orders\": [\n        {\n          \"property\": \"<string>\"\n        }\n      ]\n    }\n  },\n  \"since\": \"2024-07-21T10:15:27.819Z\",\n  \"status\": \"<string>\",\n  \"text\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "content": [
    {
      "type": "<string>",
      "comments": [
        {
          "createdBy": {
            "unavailable": true,
            "email": "<string>",
            "firstName": "<string>",
            "id": "<string>",
            "jobRoles": [
              {
                "workflowStep": {
                  "abbreviation": "<string>",
                  "id": 123,
                  "name": "<string>",
                  "workflowLevel": 123,
                  "workflowStep": {
                    "id": "<string>",
                    "lqaEnabled": true,
                    "name": "<string>",
                    "order": 123,
                    "uid": "<string>"
                  }
                }
              }
            ],
            "lastName": "<string>",
            "uid": "<string>",
            "userName": "<string>"
          },
          "dateCreated": "2023-11-07T05:31:56Z",
          "dateModified": "2023-11-07T05:31:56Z",
          "id": "<string>",
          "mentions": [
            {
              "mentionableGroup": {
                "groupName": "<string>",
                "groupReference": {
                  "uid": "3HYnHHLkTPJfMxBCDbPXFe"
                }
              },
              "tag": "<string>",
              "uidReference": {
                "uid": "3HYnHHLkTPJfMxBCDbPXFe"
              },
              "userReferences": [
                {
                  "unavailable": true,
                  "email": "<string>",
                  "firstName": "<string>",
                  "id": "<string>",
                  "jobRoles": [
                    {
                      "workflowStep": {
                        "abbreviation": "<string>",
                        "id": 123,
                        "name": "<string>",
                        "workflowLevel": 123,
                        "workflowStep": {
                          "id": "<string>",
                          "lqaEnabled": true,
                          "name": "<string>",
                          "order": 123,
                          "uid": "<string>"
                        }
                      }
                    }
                  ],
                  "lastName": "<string>",
                  "uid": "<string>",
                  "userName": "<string>"
                }
              ]
            }
          ],
          "text": "<string>"
        }
      ],
      "createdBy": {
        "unavailable": true,
        "email": "<string>",
        "firstName": "<string>",
        "id": "<string>",
        "jobRoles": [
          {
            "workflowStep": {
              "abbreviation": "<string>",
              "id": 123,
              "name": "<string>",
              "workflowLevel": 123,
              "workflowStep": {
                "id": "<string>",
                "lqaEnabled": true,
                "name": "<string>",
                "order": 123,
                "uid": "<string>"
              }
            }
          }
        ],
        "lastName": "<string>",
        "uid": "<string>",
        "userName": "<string>"
      },
      "dateCreated": "2023-11-07T05:31:56Z",
      "dateEdited": "2023-11-07T05:31:56Z",
      "dateModified": "2023-11-07T05:31:56Z",
      "deleted": true,
      "id": "<string>",
      "status": {
        "by": {
          "unavailable": true,
          "email": "<string>",
          "firstName": "<string>",
          "id": "<string>",
          "jobRoles": [
            {
              "workflowStep": {
                "abbreviation": "<string>",
                "id": 123,
                "name": "<string>",
                "workflowLevel": 123,
                "workflowStep": {
                  "id": "<string>",
                  "lqaEnabled": true,
                  "name": "<string>",
                  "order": 123,
                  "uid": "<string>"
                }
              }
            }
          ],
          "lastName": "<string>",
          "uid": "<string>",
          "userName": "<string>"
        },
        "date": "2023-11-07T05:31:56Z"
      }
    }
  ],
  "numberOfElements": 123,
  "pageNumber": 123,
  "pageSize": 123,
  "sort": {
    "orders": [
      {
        "property": "<string>"
      }
    ]
  },
  "totalElements": 123,
  "totalPages": 123
}

Authorizations

​
Authorization
string
header
required

Get a token from auth/login endpoint and then pass it in the Authorization HTTP header in every subsequent API call. For more information visit our help center.

Body

application/json

Search conversations by project request body

​
jobPartUidRef
object
required

Reference to an object by its unique identifier

​
includeDeleted
boolean

Include conversations flagged for deletion. Default: false

​
mentionedUid
string

Search a single user uid in mentions

​
pageRequest
object
​
since
string

Filtered by createdAt date time in ISO 8601 UTC format

Example:

"2024-07-21T10:15:27.819Z"

​
status
string

Filter current status for values "resolved" or "unresolved"

​
text
string

Case insensitive search in the lqa description and conversation comments

Response

OK

A paged list of conversations of all types matching the project search criteria

​
content
object[]
​
numberOfElements
integer<int32>
​
pageNumber
integer<int32>
​
pageSize
integer<int32>
​
sort
object
​
totalElements
integer<int32>
​
totalPages
integer<int32>