Project
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
orname=02
will find projects namedGUI02
. - 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
orclientName=02
will find projects associated with the clientGUI02
. - 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
orbusinessUnitName=02
will find projects linked to the business unitGUI02
. - 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
ordomainName=02
will find projects associated with the domainGUI02
. - 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
orsubDomainName=02
will find projects linked to the subdomainGUI02
. - 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
orcostCenterName=02
will find projects associated with the cost centerGUI02
. - 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
List projects
Query Parameters
-1 for projects that are overdue
Required range:
x >= -1
Required range:
x >= 0
Allowed for linguists only
Allowed for linguists only
Available options:
NEW
, ACCEPTED
, COMPLETED
Page number, starting with 0, default 0
Required range:
x >= 0
Page size, accepts values between 1 and 50, default 50
Required range:
1 <= x <= 50
Name or internal ID of project
List also archived projects
List only archived projects, regardless of includeArchived
Available options:
INTERNAL_ID
, NAME
, DATE_CREATED
, DATE_ARCHIVED
Available options:
ASC
, DESC
Response
200
application/json
successful operation
The response is of type object
.
List projects