List cards on a team board

curl --request GET \
  --url https://davinci-app.com/api/v2/orgs/{orgId}/teams/{teamId}/cards \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://davinci-app.com/api/v2/orgs/{orgId}/teams/{teamId}/cards"

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}/cards', 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}/cards', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "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>",
      "requiredCardFields": [
        "name"
      ],
      "requiredFieldsCompliant": true,
      "missingRequiredFields": [
        "name"
      ],
      "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",
      "assignees": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "display_name": "<string>"
        }
      ],
      "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
  },
  "filterOptions": {
    "projects": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      }
    ],
    "tags": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "color": "<string>"
      }
    ],
    "teams": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      }
    ],
    "assignees": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "display_name": "<string>"
      }
    ],
    "statuses": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "color": "<string>"
      }
    ],
    "sprints": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "status": "<string>"
      }
    ]
  }
}

{
  "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

api

orgs

{orgId}

teams

{teamId}

cards

List cards on a team board

curl --request GET \
  --url https://davinci-app.com/api/v2/orgs/{orgId}/teams/{teamId}/cards \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://davinci-app.com/api/v2/orgs/{orgId}/teams/{teamId}/cards"

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}/cards', 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}/cards', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "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>",
      "requiredCardFields": [
        "name"
      ],
      "requiredFieldsCompliant": true,
      "missingRequiredFields": [
        "name"
      ],
      "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",
      "assignees": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "display_name": "<string>"
        }
      ],
      "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
  },
  "filterOptions": {
    "projects": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      }
    ],
    "tags": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "color": "<string>"
      }
    ],
    "teams": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      }
    ],
    "assignees": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "display_name": "<string>"
      }
    ],
    "statuses": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "color": "<string>"
      }
    ],
    "sprints": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "status": "<string>"
      }
    ]
  }
}

{
  "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

Authorization

string

header

default:dav_ak_live_your_token

required

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.

Path Parameters

orgId

string<uuid>

required

Organization id.

teamId

string<uuid>

required

Agile team id.

Query Parameters

sprintId

Sprint id, or the literal null for cards not in a sprint.

statusId

string<uuid>

isOpen

boolean

string

Case-insensitive substring search across card name, description, and resolution.

Maximum string length: 200

state

enum<string>

default:open

Project-global card lifecycle state.

Available options:

open,

closed,

all

tagIds

string<uuid>[]

Match cards carrying any selected project tag.

Maximum array length: 50

assigneeIds

string<uuid>[]

Match cards assigned to any selected project member.

Maximum array length: 50

includeUnassigned

boolean

default:false

OR cards with no user links into the assignee facet. This is not a sentinel assignee ID.

statusIds

string<uuid>[]

Match cards whose selected-team placement uses any selected status.

Maximum array length: 50

sprintIds

string<uuid>[]

Match cards whose team placement uses any selected sprint.

Maximum array length: 50

deadlineFrom

string<date-time>

Inclusive ISO 8601 instant lower bound for non-null card deadlines.

deadlineTo

string<date-time>

Inclusive ISO 8601 instant upper bound for non-null card deadlines.

includeNoDeadline

boolean

default:false

OR cards with a null deadline into bounded deadline matches. With no deadline bounds, match only cards with no deadline.

effortMin

integer

Inclusive lower bound for non-null card effort.

Required range: x >= 0

effortMax

integer

Inclusive upper bound for non-null card effort.

Required range: x >= 0

includeNoEffort

boolean

default:false

OR cards with null effort into bounded effort matches. With no effort bounds, match only cards with no effort.

sort

enum<string>

default:created_desc

Stable card sort; card ID is the deterministic tie-breaker.

Available options:

created_asc,

created_desc,

updated_asc,

updated_desc,

deadline_asc,

deadline_desc,

effort_asc,

effort_desc,

name_asc,

name_desc

projectIds

string<uuid>[]

Repeated or comma-separated Project IDs.

Include distinct Team card filter catalogs in the response.

limit

integer

default:100

Maximum cards returned.

Required range: 1 <= x <= 500

offset

integer

default:0

Required range: x >= 0

Response

Filtered board cards.

cards

object[]

required

Hide child attributes

cards.id

string<uuid>

required

cards.name

string

required

cards.created_at

string<date-time> | null

required

cards.updated_at

string<date-time> | null

required

cards.deadline

string<date-time> | null

required

cards.is_open

boolean

required

cards.project_id

string<uuid>

required

cards.effort

integer | null

required

Unit-agnostic estimate, commonly interpreted as story points or hours.

Required range: x >= 0

cards.link_id

string<uuid>

required

cards.sprint_id

string<uuid> | null

required

cards.status_id

string<uuid> | null

required

cards.project_name

string | null

required

cards.requiredCardFields

enum<string>[]

required

User-editable scalar card field that a workflow status may require.

Available options:

name,

description,

resolution,

deadline,

effort

cards.requiredFieldsCompliant

boolean

required

cards.missingRequiredFields

enum<string>[]

required

User-editable scalar card field that a workflow status may require.

Available options:

name,

description,

resolution,

deadline,

effort

cards.cardAccess

enum<string>

required

full 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.

Available options:

full,

team-board-summary

cards.capabilities

object

required

Hide child attributes

cards.capabilities.canReadCards

boolean

required

cards.capabilities.canWriteCards

boolean

required

cards.capabilities.canDeleteCards

boolean

required

cards.description

string | null

cards.resolution

string | null

Optional Markdown resolution; closing or reopening the card does not clear it.

Maximum string length: 10000

cards.created_by_user

string<uuid> | null

cards.author_display_name

string | null

Display name of the user who created the card, when available.

cards.closed_at

string<date-time> | null

read-only

Timestamp of the latest transition to the closed state; null while open.

cards.assignees

object[]

Hide child attributes

cards.assignees.id

string<uuid>

required

cards.assignees.display_name

string | null

required

cards.tag_ids

string<uuid>[]

cards.tags

object[]

Hide child attributes

cards.tags.id

string<uuid>

required

cards.tags.name

string

required

cards.tags.color

string

required

Getting Started

Davinci Browser

Davinci Editor

Integrations

Modeling Guide

Administration

Developer API

Examples

Release Notes

List cards on a team board

Authorizations

Path Parameters

Query Parameters

Response