v1
latestOpenAPI 3.0.12026-08-041753011.2 MBApproval
Get approval requests
get/v1/workspaces/{workspaceId}/approval-requests
Path parameters
workspaceIdstring required
Represents workspace identifier across the system.
Example:dd087fe2dd087fe2dd087fe2
Represents workspace identifier across the system.
Query parameters
status'PENDING' | 'APPROVED' | 'WITHDRAWN_APPROVAL'
Filters results based on the provided approval state.
sort-column'ID' | 'USER_ID' | 'START' | 'UPDATED_AT'
Represents the column name to be used as sorting criteria.
sort-order'ASCENDING' | 'DESCENDING'
Represents the sorting order.
pageinteger
Page number.
Example:1
Page number.
page-sizeinteger
Page size.
Example:50
Page size.
typesstring[]
Response
OK
Example response
[
{
"approvalRequest": {
"creator": {
"userEmail": "johhndoe@example.com",
"userId": "5a0ab5acb07987125438b60f",
"userName": "johhndoe"
},
"id": "567687e29ae1f428e7ebf564",
"owner": {
"startOfWeek": "MONDAY",
"timeZone": "Europe/Budapest",
"userId": "5a0ab5acb07987125438b60f",
"userName": "johndoe"
},
"status": {
"note": "This is a sample approval request note.",
"state": "APPROVED",
"updatedAt": "2020-01-01T08:00:00Z",
"updatedBy": "5a0ab5acb07987125438b60f",
"updatedByUserName": "juandelacruz"
},
"workspaceId": "64a687e29ae1f428e7ebe303"
},
"approvedTime": "PT1H30M",
"billableAmount": 2500,
"billableTime": "PT1H30M",
"breakTime": "PT1H30M",
"costAmount": 5000,
"entries": [
{
"approvalRequestId": "5e4117fe8c625f38930d57b7",
"costRate": {
"amount": 10500,
"currency": "USD"
},
"customFieldValues": [
{
"customFieldId": "44a687e29ae1f428e7ebe305",
"sourceType": "WORKSPACE",
"timeEntryId": "64c777ddd3fcab07cfbb210c"
}
],
"description": "This is a sample time entry description.",
"hourlyRate": {
"amount": 10500,
"currency": "USD"
},
"id": "5b715448b0798751107918ab",
"project": {
"clientId": "64c777ddd3fcab07cfbb210c",
"clientName": "Client X",
"color": "#000000",
"id": "5b641568b07987035750505e",
"name": "Software Development"
},
"tags": [
{
"id": "64c777ddd3fcab07cfbb210c",
"name": "Sprint1",
"workspaceId": "64a687e29ae1f428e7ebe303"
}
],
"task": {
"id": "5b715448b0798751107918ab",
"name": "Bugfixing"
},
"timeInterval": {
"duration": "PT1H30M"
},
"type": "REGULAR"
}
],
"expenseTotal": 7500,
"expenses": [
{
"approvalRequestId": "445687e29ae1f428e7ebe893",
"approvalStatus": "PENDING",
"category": {
"id": "89a687e29ae1f428e7ebe303",
"name": "Procurement",
"priceInCents": 1000,
"unit": "piece",
"workspaceId": "64a687e29ae1f428e7ebe303"
},
"currency": "USD",
"date": "2020-01-01",
"detailedApprovalStatus": "PENDING",
"fileId": "745687e29ae1f428e7ebe890",
"fileName": "file_12345.csv",
"id": "64c777ddd3fcab07cfbb210c",
"notes": "This is a sample note for this expense.",
"project": {
"clientId": "64c777ddd3fcab07cfbb210c",
"clientName": "Client X",
"color": "#000000",
"id": "5b641568b07987035750505e",
"name": "Software Development"
},
"task": {
"id": "5b715448b0798751107918ab",
"name": "Bugfixing"
},
"total": 10500.5,
"userId": "89b687e29ae1f428e7ebe912",
"workspaceId": "64a687e29ae1f428e7ebe303"
}
],
"pendingTime": "PT1H30M",
"trackedTime": "PT1H30M"
}
]