Overview
Retrieve Project List of the client
Retrieve Project List of the client
URL Format
https://{domain}.mobiwork.com/api/rest/{clientId}/{versionNumber}/project/list.html?token=XXXXXXXX&userId={userId}
https://{domain}.mobiwork.com/api/rest/{clientId}/{versionNumber}/project/list.html?token=XXXXXXXX&userId={userId}
Arguments
| clientId required |
MobiWork assigned unique ID of the company |
| versionNumber required |
Version number of MobiWork API SDK release. Current version is: 10.0.78 |
| token required |
Part of URL as a request parameter and is required in every call to verify access to API calls |
| userId optional |
If provided, this User ID will be taken as a logged in user. If not provided we use an active global administrator ID |
Filter or Search Criteria
| projectName | By Project Name |
| category | By the Category of the Projects |
| customStatus | By Projects status API names |
| createdBy | By the created user, accept either name (lastname, firstname) or userId |
| createdFromDate | By create date range from date |
| createdToDate | By create date range to date |
| externalId | By external ID of project |
| integrationStatus | By integration statuses, accept either name or the ID of the status. |
Curl Example
Returns a list of Project Object(s) if valid arguments and search criteria are provided. If no search criteria is provided the list of a maximum 200 projects will be returned. Returns an error if not a valid request
Returns a list of Project Object(s) if valid arguments and search criteria are provided. If no search criteria is provided the list of a maximum 200 projects will be returned. Returns an error if not a valid request
Request Body XSD
Response Body XSD
Curl Example
| HTTP Method: | GET |
| Request: | |
| Response: |