- General
- Endpoints
Capacity Stage
GET
/board/{board_id}/capacity/stage
Capacity
Request
Path Params
board_id
string <uuid>
required
Example:
0d646fe8-b4a8-4586-b5ce-84286402e207
Query Params
date_range_start
string
required
Example:
2024-01-01
date_range_end
string
required
Example:
2025-01-01
time_frame
enum<string>
optional
Allowed values:
dayweekmonthquarteryear
Default:
day
Example:
day
stage_id
string
optional
Example:
20f8e3e3-6962-49d5-a169-4f3b9df27c74
Header Params
x-api-key
string
required
Default:
{{api_key}}
x-api-env
string
required
Default:
{{api_env}}
Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.vplan.com/v1/board/0d646fe8-b4a8-4586-b5ce-84286402e207/capacity/stage?date_range_start=2024-01-01&date_range_end=2025-01-01' \
--header 'x-api-key;' \
--header 'x-api-env;'Responses
🟢200OK
application/json
Body
data
array [object {2}]
required
date
string
required
stage
array [object {3}]
required
Example
{
"data": [
{
"date": "2024-01-01",
"stage": [
{
"id": "20f8e3e3-6962-49d5-a169-4f3b9df27c74",
"time_available": 1920
},
{
"id": "a0aa3408-fdde-4d4f-a45d-ff28f5e9e9da",
"time_available": 960
},
{
"id": "b492b98b-eade-47dc-b71d-336f5435c423",
"time_available": 1920
},
{
"id": "c21b28a6-6a21-4280-b49a-927b569bf324",
"time_available": 1920
},
{
"id": "c6dc530f-82c4-4c50-8f01-0425e41b9f01",
"time_available": 480
}
]
},
{
"date": "2024-01-02",
"stage": [
{
"id": "20f8e3e3-6962-49d5-a169-4f3b9df27c74",
"time_available": 1920
},
{
"id": "a0aa3408-fdde-4d4f-a45d-ff28f5e9e9da",
"time_available": 960
},
{
"id": "b492b98b-eade-47dc-b71d-336f5435c423",
"time_available": 1920
},
{
"id": "c21b28a6-6a21-4280-b49a-927b569bf324",
"time_available": 1920
},
{
"id": "c6dc530f-82c4-4c50-8f01-0425e41b9f01",
"time_available": 480
}
]
},
{
"date": "2024-01-03",
"stage": [
{
"id": "20f8e3e3-6962-49d5-a169-4f3b9df27c74",
"time_available": 1920
},
{
"id": "a0aa3408-fdde-4d4f-a45d-ff28f5e9e9da",
"time_available": 960
},
{
"id": "b492b98b-eade-47dc-b71d-336f5435c423",
"time_available": 1920
},
{
"id": "c21b28a6-6a21-4280-b49a-927b569bf324",
"time_available": 1920
},
{
"id": "c6dc530f-82c4-4c50-8f01-0425e41b9f01",
"time_available": 480
}
]
},
{
"date": "2024-01-04",
"stage": [
{
"id": "20f8e3e3-6962-49d5-a169-4f3b9df27c74",
"time_available": 1920
},
{
"id": "a0aa3408-fdde-4d4f-a45d-ff28f5e9e9da",
"time_available": 960
},
{
"id": "b492b98b-eade-47dc-b71d-336f5435c423",
"time_available": 1920
},
{
"id": "c21b28a6-6a21-4280-b49a-927b569bf324",
"time_available": 1920
},
{
"id": "c6dc530f-82c4-4c50-8f01-0425e41b9f01",
"time_available": 480
}
]
},
{
"date": "2024-01-05",
"stage": [
{
"id": "20f8e3e3-6962-49d5-a169-4f3b9df27c74",
"time_available": 1920
},
{
"id": "a0aa3408-fdde-4d4f-a45d-ff28f5e9e9da",
"time_available": 960
},
{
"id": "b492b98b-eade-47dc-b71d-336f5435c423",
"time_available": 1920
},
{
"id": "c21b28a6-6a21-4280-b49a-927b569bf324",
"time_available": 1920
},
{
"id": "c6dc530f-82c4-4c50-8f01-0425e41b9f01",
"time_available": 480
}
]
},
{
"date": "2024-01-06",
"stage": [
{
"id": "20f8e3e3-6962-49d5-a169-4f3b9df27c74",
"time_available": 0
},
{
"id": "a0aa3408-fdde-4d4f-a45d-ff28f5e9e9da",
"time_available": 0
},
{
"id": "b492b98b-eade-47dc-b71d-336f5435c423",
"time_available": 0
},
{
"id": "c21b28a6-6a21-4280-b49a-927b569bf324",
"time_available": 0
},
{
"id": "c6dc530f-82c4-4c50-8f01-0425e41b9f01",
"time_available": 0
}
]
},
{
"date": "2024-01-07",
"stage": [
{
"id": "20f8e3e3-6962-49d5-a169-4f3b9df27c74",
"time_available": 0
},
{
"id": "a0aa3408-fdde-4d4f-a45d-ff28f5e9e9da",
"time_available": 0
},
{
"id": "b492b98b-eade-47dc-b71d-336f5435c423",
"time_available": 0
},
{
"id": "c21b28a6-6a21-4280-b49a-927b569bf324",
"time_available": 0
},
{
"id": "c6dc530f-82c4-4c50-8f01-0425e41b9f01",
"time_available": 0
}
]
},
{
"date": "2024-01-08",
"stage": [
{
"id": "20f8e3e3-6962-49d5-a169-4f3b9df27c74",
"time_available": 1920
},
{
"id": "a0aa3408-fdde-4d4f-a45d-ff28f5e9e9da",
"time_available": 960
},
{
"id": "b492b98b-eade-47dc-b71d-336f5435c423",
"time_available": 1920
},
{
"id": "c21b28a6-6a21-4280-b49a-927b569bf324",
"time_available": 1920
},
{
"id": "c6dc530f-82c4-4c50-8f01-0425e41b9f01",
"time_available": 480
}
]
},
{
"date": "2024-01-09",
"stage": [
{
"id": "20f8e3e3-6962-49d5-a169-4f3b9df27c74",
"time_available": 1920
},
{
"id": "a0aa3408-fdde-4d4f-a45d-ff28f5e9e9da",
"time_available": 960
},
{
"id": "b492b98b-eade-47dc-b71d-336f5435c423",
"time_available": 1920
},
{
"id": "c21b28a6-6a21-4280-b49a-927b569bf324",
"time_available": 1920
},
{
"id": "c6dc530f-82c4-4c50-8f01-0425e41b9f01",
"time_available": 480
}
]
},
{
"date": "2024-01-10",
"stage": [
{
"id": "20f8e3e3-6962-49d5-a169-4f3b9df27c74",
"time_available": 1920
},
{
"id": "a0aa3408-fdde-4d4f-a45d-ff28f5e9e9da",
"time_available": 960
},
{
"id": "b492b98b-eade-47dc-b71d-336f5435c423",
"time_available": 1920
},
{
"id": "c21b28a6-6a21-4280-b49a-927b569bf324",
"time_available": 1920
},
{
"id": "c6dc530f-82c4-4c50-8f01-0425e41b9f01",
"time_available": 480
}
]
},
{
"date": "2024-01-11",
"stage": [
{
"id": "20f8e3e3-6962-49d5-a169-4f3b9df27c74",
"time_available": 1920
},
{
"id": "a0aa3408-fdde-4d4f-a45d-ff28f5e9e9da",
"time_available": 960
},
{
"id": "b492b98b-eade-47dc-b71d-336f5435c423",
"time_available": 1920
},
{
"id": "c21b28a6-6a21-4280-b49a-927b569bf324",
"time_available": 1920
},
{
"id": "c6dc530f-82c4-4c50-8f01-0425e41b9f01",
"time_available": 480
}
]
},
{
"date": "2024-01-12",
"stage": [
{
"id": "20f8e3e3-6962-49d5-a169-4f3b9df27c74",
"time_available": 1920
},
{
"id": "a0aa3408-fdde-4d4f-a45d-ff28f5e9e9da",
"time_available": 960
},
{
"id": "b492b98b-eade-47dc-b71d-336f5435c423",
"time_available": 1920
},
{
"id": "c21b28a6-6a21-4280-b49a-927b569bf324",
"time_available": 1920
},
{
"id": "c6dc530f-82c4-4c50-8f01-0425e41b9f01",
"time_available": 480
}
]
},
{
"date": "2024-01-13",
"stage": [
{
"id": "20f8e3e3-6962-49d5-a169-4f3b9df27c74",
"time_available": 0
},
{
"id": "a0aa3408-fdde-4d4f-a45d-ff28f5e9e9da",
"time_available": 0
},
{
"id": "b492b98b-eade-47dc-b71d-336f5435c423",
"time_available": 0
},
{
"id": "c21b28a6-6a21-4280-b49a-927b569bf324",
"time_available": 0
},
{
"id": "c6dc530f-82c4-4c50-8f01-0425e41b9f01",
"time_available": 0
}
]
},
{
"date": "2024-01-14",
"stage": [
{
"id": "20f8e3e3-6962-49d5-a169-4f3b9df27c74",
"time_available": 0
},
{
"id": "a0aa3408-fdde-4d4f-a45d-ff28f5e9e9da",
"time_available": 0
},
{
"id": "b492b98b-eade-47dc-b71d-336f5435c423",
"time_available": 0
},
{
"id": "c21b28a6-6a21-4280-b49a-927b569bf324",
"time_available": 0
},
{
"id": "c6dc530f-82c4-4c50-8f01-0425e41b9f01",
"time_available": 0
}
]
},
{
"date": "2024-01-15",
"stage": [
{
"id": "20f8e3e3-6962-49d5-a169-4f3b9df27c74",
"time_available": 1920
},
{
"id": "a0aa3408-fdde-4d4f-a45d-ff28f5e9e9da",
"time_available": 960
},
{
"id": "b492b98b-eade-47dc-b71d-336f5435c423",
"time_available": 1920
},
{
"id": "c21b28a6-6a21-4280-b49a-927b569bf324",
"time_available": 1920
},
{
"id": "c6dc530f-82c4-4c50-8f01-0425e41b9f01",
"time_available": 480
}
]
},
{
"date": "2024-01-16",
"stage": [
{
"id": "20f8e3e3-6962-49d5-a169-4f3b9df27c74",
"time_available": 1920
},
{
"id": "a0aa3408-fdde-4d4f-a45d-ff28f5e9e9da",
"time_available": 960
},
{
"id": "b492b98b-eade-47dc-b71d-336f5435c423",
"time_available": 1920
},
{
"id": "c21b28a6-6a21-4280-b49a-927b569bf324",
"time_available": 1920
},
{
"id": "c6dc530f-82c4-4c50-8f01-0425e41b9f01",
"time_available": 480
}
]
},
{
"date": "2024-01-17",
"stage": [
{
"id": "20f8e3e3-6962-49d5-a169-4f3b9df27c74",
"time_available": 1920
},
{
"id": "a0aa3408-fdde-4d4f-a45d-ff28f5e9e9da",
"time_available": 960
},
{
"id": "b492b98b-eade-47dc-b71d-336f5435c423",
"time_available": 1920
},
{
"id": "c21b28a6-6a21-4280-b49a-927b569bf324",
"time_available": 1920
},
{
"id": "c6dc530f-82c4-4c50-8f01-0425e41b9f01",
"time_available": 480
}
]
}
]
}Modified at 2024-10-04 09:04:55