List projects

API call to retrieve a paginated list of projects. Contains a subset of information contained in Get project API call.

Utilize the query parameters below to refine the search criteria:

• name - The full project name or a portion of it. For instance, using name=GUI or name=02 will find projects named GUI02.
• clientId - The client’s ID within the system, not interchangeable with its UID.
• clientName - The complete or partial name of the client. For example, using clientName=GUI or clientName=02 will find projects associated with the client GUI02.
• businessUnitId - The business unit’s ID within the system, not interchangeable with its UID.
• businessUnitName - The complete or partial name of the business unit. For instance, using businessUnitName=GUI or businessUnitName=02 will find projects linked to the business unit GUI02.
• statuses - A list of project statuses. When adding multiple statuses, include each as a dedicated query parameter, e.g., statuses=ASSIGNED&statuses=COMPLETED.
• domainId - The domain’s ID within the system, not interchangeable with its UID.
• domainName - The complete or partial name of the domain. Using domainName=GUI or domainName=02 will find projects associated with the domain GUI02.
• subDomainId - The subdomain’s ID within the system, not interchangeable with its UID.
• subDomainName - The complete or partial name of the subdomain. For example, using subDomainName=GUI or subDomainName=02 will find projects linked to the subdomain GUI02.
• costCenterId - The cost center’s ID within the system, not interchangeable with its UID.
• costCenterName - The complete or partial name of the cost center. For instance, using costCenterName=GUI or costCenterName=02 will find projects associated with the cost center GUI02.
• dueInHours - Filter for jobs with due dates less than or equal to the specified number of hours.
• createdInLastHours - Filter for jobs created within the specified number of hours.
• ownerId - The user ID who owns the project within the system, not interchangeable with its UID.
• jobStatuses - A list of statuses for jobs within the projects. Include each status as a dedicated query parameter, e.g., jobStatuses=ASSIGNED&jobStatuses=COMPLETED.
• jobStatusGroup - The name of the status group used to filter projects containing at least one job with the specified status, similar to the status filter in the Projects list for a Linguist user.
• buyerId - The Buyer’s ID.
• pageNumber - Indicates the desired page number (zero-based) to retrieve. The total number of pages is returned in the totalPages field within each response.
• pageSize - Indicates the page size, affecting the totalPages retrieved in each response and potentially influencing the number of iterations needed to obtain all projects.
• nameOrInternalId - Specify either the project name or Internal ID (the sequence number in the project list displayed in the UI).
• includeArchived - A boolean parameter to include archived projects in the search.
• archivedOnly - A boolean search indicating whether only archived projects should be searched.

GET /api2/v1/projects

List projects

cURL

curl --request GET \
  --url https://cloud.memsource.com/web/api2/v1/projects \
  --header 'Authorization: <api-key>'

200

{
  "content": [
    {
      "userRole": "<string>",
      "dateCreated": "2023-11-07T05:31:56Z",
      "domain": {
        "id": "<string>",
        "name": "<string>",
        "uid": "<string>"
      },
      "id": "<string>",
      "internalId": 123,
      "mtSettingsPerLanguageList": [
        {
          "targetLang": "<string>",
          "machineTranslateSettings": {
            "id": "<string>",
            "name": "<string>",
            "type": "<string>",
            "uid": "<string>"
          }
        }
      ],
      "name": "<string>",
      "owner": {
        "email": "<string>",
        "firstName": "<string>",
        "id": "<string>",
        "lastName": "<string>",
        "uid": "<string>",
        "userName": "<string>"
      },
      "references": [
        {
          "createdBy": {
            "email": "<string>",
            "firstName": "<string>",
            "id": "<string>",
            "lastName": "<string>",
            "uid": "<string>",
            "userName": "<string>"
          },
          "dateCreated": "2023-11-07T05:31:56Z",
          "filename": "<string>",
          "id": "<string>",
          "note": "<string>",
          "uid": "<string>"
        }
      ],
      "sourceLang": "<string>",
      "subDomain": {
        "id": "<string>",
        "name": "<string>",
        "uid": "<string>"
      },
      "targetLangs": [
        "<string>"
      ],
      "uid": "<string>"
    }
  ],
  "numberOfElements": 123,
  "pageNumber": 123,
  "pageSize": 123,
  "sort": {
    "orders": [
      {
        "property": "<string>"
      }
    ]
  },
  "totalElements": 123,
  "totalPages": 123
}

Authorizations

ApiTokenOAuth2

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.

Query Parameters

name · string

clientId · integer<int64>

clientName · string

businessUnitId · integer<int64>

businessUnitName · string

statuses · enum<string>[]

Available options: NEW, ASSIGNED, COMPLETED, ACCEPTED_BY_VENDOR, DECLINED_BY_VENDOR, COMPLETED_BY_VENDOR, CANCELLED

targetLangs · string[]

domainId · integer<int64>

domainName · string

subDomainId · integer<int64>

subDomainName · string

costCenterId · integer<int64>

costCenterName · string

dueInHours · integer<int32>

-1 for projects that are overdue

Required range: x >= -1

createdInLastHours · integer<int32>

Required range: x >= 0

sourceLangs · string[]

ownerId · integer<int64>

jobStatuses · enum<string>[]

Allowed for linguists only

Available options: NEW, ACCEPTED, DECLINED, DELIVERED, EMAILED, COMPLETED, CANCELLED

jobStatusGroup · enum<string>

Allowed for linguists only

Available options: NEW, ACCEPTED, COMPLETED

buyerId · integer<int64>

pageNumber · integer<int32> · default: 0

Page number, starting with 0, default 0

Required range: x >= 0

pageSize · integer<int32> · default: 50

Page size, accepts values between 1 and 50, default 50

Required range: 1 <= x <= 50

nameOrInternalId · string

Name or internal ID of project

includeArchived · boolean · default: false

List also archived projects

archivedOnly · boolean · default: false

List only archived projects, regardless of includeArchived

sort · enum<string> · default: ID

Available options: ID, INTERNAL_ID, NAME, DATE_CREATED, DATE_ARCHIVED

order · enum<string> · default: ASC

Available options: ASC, DESC

Response

200

application/json

successful operation

content · object[]

Show child attributes

numberOfElements · integer<int32>

pageNumber · integer<int32>

pageSize · integer<int32>

sort · object

Show child attributes

totalElements · integer<int32>

totalPages · integer<int32>