curl --request GET \
--url https://davinci-app.com/api/v2/orgs/{orgId}/teams/{teamId}/overview \
--header 'Authorization: Bearer <token>'import requests
url = "https://davinci-app.com/api/v2/orgs/{orgId}/teams/{teamId}/overview"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://davinci-app.com/api/v2/orgs/{orgId}/teams/{teamId}/overview', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://davinci-app.com/api/v2/orgs/{orgId}/teams/{teamId}/overview', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"team": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"status": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"visibility": "private"
},
"workflowStatuses": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"position": "<string>",
"color": "<string>",
"status": "<string>",
"transition_state": "not_started",
"closeMode": "off",
"team_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"sprints": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"status": "planned",
"created_at": "2023-11-07T05:31:56Z",
"start_date": "2023-11-07T05:31:56Z",
"end_date": "2023-11-07T05:31:56Z",
"team_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"cards": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deadline": "2023-11-07T05:31:56Z",
"is_open": true,
"project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"effort": 1,
"link_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sprint_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"project_name": "<string>",
"assignees": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"display_name": "<string>"
}
],
"cardAccess": "full",
"capabilities": {
"canReadCards": true,
"canWriteCards": true,
"canDeleteCards": true
},
"description": "<string>",
"resolution": "<string>",
"created_by_user": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"author_display_name": "<string>",
"closed_at": "2023-11-07T05:31:56Z",
"tag_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"tags": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"color": "<string>"
}
]
}
],
"meta": {
"limit": 2,
"offset": 1,
"hasMore": true,
"total": 1
},
"viewerCapabilities": {
"canReadTeam": true,
"canManageTeam": true,
"canDeleteTeam": true,
"canReadMembers": true,
"canInviteMembers": true,
"canRemoveMembers": true,
"canUpdateMemberRoles": true,
"canAddProjects": true,
"canRemoveProjects": true,
"canCreateSprint": true,
"canReadSprints": true,
"canManageSprint": true,
"canDeleteSprint": true,
"canManageBoardCards": true,
"canReadAnalysis": true
},
"completedSprintTotal": 1
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}Get active team planning work
Returns team metadata, workflow statuses, active and planned sprints, placed cards outside completed sprints, the completed-sprint count, and effective viewer capabilities. The card page is always bounded and defaults to 500.
curl --request GET \
--url https://davinci-app.com/api/v2/orgs/{orgId}/teams/{teamId}/overview \
--header 'Authorization: Bearer <token>'import requests
url = "https://davinci-app.com/api/v2/orgs/{orgId}/teams/{teamId}/overview"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://davinci-app.com/api/v2/orgs/{orgId}/teams/{teamId}/overview', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://davinci-app.com/api/v2/orgs/{orgId}/teams/{teamId}/overview', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"team": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"status": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"visibility": "private"
},
"workflowStatuses": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"position": "<string>",
"color": "<string>",
"status": "<string>",
"transition_state": "not_started",
"closeMode": "off",
"team_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"sprints": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"status": "planned",
"created_at": "2023-11-07T05:31:56Z",
"start_date": "2023-11-07T05:31:56Z",
"end_date": "2023-11-07T05:31:56Z",
"team_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"cards": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deadline": "2023-11-07T05:31:56Z",
"is_open": true,
"project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"effort": 1,
"link_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sprint_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"project_name": "<string>",
"assignees": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"display_name": "<string>"
}
],
"cardAccess": "full",
"capabilities": {
"canReadCards": true,
"canWriteCards": true,
"canDeleteCards": true
},
"description": "<string>",
"resolution": "<string>",
"created_by_user": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"author_display_name": "<string>",
"closed_at": "2023-11-07T05:31:56Z",
"tag_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"tags": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"color": "<string>"
}
]
}
],
"meta": {
"limit": 2,
"offset": 1,
"hasMore": true,
"total": 1
},
"viewerCapabilities": {
"canReadTeam": true,
"canManageTeam": true,
"canDeleteTeam": true,
"canReadMembers": true,
"canInviteMembers": true,
"canRemoveMembers": true,
"canUpdateMemberRoles": true,
"canAddProjects": true,
"canRemoveProjects": true,
"canCreateSprint": true,
"canReadSprints": true,
"canManageSprint": true,
"canDeleteSprint": true,
"canManageBoardCards": true,
"canReadAnalysis": true
},
"completedSprintTotal": 1
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}Authorizations
Personal access token. The scopes granted at issuance determine both which
operations the key may call and the ceiling on the resource permissions it
can exercise. Each scope family is a ladder: projects:manage implies
projects:write and projects:read; cards:manage implies cards:write
and cards:read; and teams:manage implies teams:write and teams:read.
These are named API capability bundles, not blanket domain roles:
manage exposes only the permissions enumerated for that scope and never
bypasses the acting user's current role-based access.
Query Parameters
Maximum active-work cards returned.
1 <= x <= 500x >= 0Stable card sort; card ID is the deterministic tie-breaker.
created_asc, created_desc, updated_asc, updated_desc, deadline_asc, deadline_desc, effort_asc, effort_desc, name_asc, name_desc Response
Bounded active team planning work.
Hide child attributes
Hide child attributes
Team lifecycle status; active is the database default.
private, internal Hide child attributes
Hide child attributes
Workflow-status lifecycle flag; active is the database default.
not_started, started, closed off, manual, automatic Hide child attributes
Hide child attributes
planned, active, completed Hide child attributes
Hide child attributes
Unit-agnostic estimate, commonly interpreted as story points or hours.
x >= 0full includes Project Card fields. team-board-summary is the
bounded operational projection returned when the caller may see the
Team board but lacks cards:read for this Card's Project.
full, team-board-summary Optional Markdown resolution; closing or reopening the card does not clear it.
10000Display name of the user who created the card, when available.
Timestamp of the latest transition to the closed state; null while open.
Hide child attributes
Hide child attributes
x >= 0