Get single board details¶

GET /api/v5/org/{owner}/kanban/{kanban_id}/detail

This endpoint retrieves the details of a single board under the specified organization, including the board's ID, name, description, state, visibility, and update time, so that users can view and understand the board's specific configuration and state.

Access token support¶

AtomGit user access token (AtomGit user access tokens)

Anonymous access¶

This endpoint allows anonymous access.

Request parameters¶

Parameter	Location	Type	Required	Description
`owner`	path	string	Yes	Organization path (path/login)
`kanban_id`	path	integer	Yes	Board ID

Response parameters¶

Field	Type	Always returned	Nullable	Description
`id`	string	Yes	No	Board ID
`iid`	integer	No	Yes	Project ID
`name`	string	Yes	No	Board name
`description`	string	Yes	No	Board description
`status`	integer	Yes	No	State: `0` normal, `1` closed
`visibility`	integer	Yes	No	Visibility: `1` public, `2` private
`updatedAt`	string	No	Yes	Update time

Error responses¶

400 Invalid parameters

{
  "error": "invalid_request",
  "message": "The kanban_id parameter must be a number"
}

401 Unauthenticated

{
  "error": "unauthorized",
  "message": "Missing or invalid access token"
}

404 Resource not found

{
  "error": "not_found",
  "message": "The board or organization does not exist"
}

HTTP response status codes¶

Status code	Description
`200`	Success (OK)
`400`	Invalid parameters (Bad Request)
`401`	Requires authentication
`403`	Forbidden
`404`	Resource not found (Not Found)
`429`	Too many requests (Too Many Requests)
`500`	Internal system error (Internal Server Error)

Request example¶

Parameter description¶

Replace <owner> with the organization path name (the address path of an enterprise, organization, or individual); Replace <kanban_id> with the board ID.

This endpoint allows anonymous access; no access token is required. To access a private board, you may also provide an AtomGit user access token.

cURL¶

curl -X GET 'https://api.atomgit.com/api/v5/org/<owner>/kanban/<kanban_id>/detail' \
  -H 'Accept: application/json'

JavaScript¶

// Native fetch (Node.js 18+ / browser)
const response = await fetch(
  "https://api.atomgit.com/api/v5/org/<owner>/kanban/<kanban_id>/detail",
  {
    headers: {
      "Accept": "application/json",
    },
  }
);

if (!response.ok) {
  throw new Error(`Request failed: ${response.status}`);
}

const data = await response.json();
console.log(data);

Python¶

import requests

resp = requests.get(
    "https://api.atomgit.com/api/v5/org/<owner>/kanban/<kanban_id>/detail",
    headers={"Accept": "application/json"},
    timeout=10,
)
resp.raise_for_status()

print(resp.json())

Response example¶

Status code: 200

{
  "id": "1",
  "iid": 1,
  "name": "Product iteration board",
  "description": "Product iteration task tracking",
  "status": 0,
  "visibility": 1,
  "updatedAt": "2026-10-14T05:09:53+08:00"
}

Error codes¶

Error code	Description
`400`	Invalid parameters or unparseable request
`401`	Unauthenticated or invalid credentials (missing or invalid access credentials)
`403`	Forbidden
`404`	Resource not found
`429`	Too many requests; rate limit triggered
`500`	Internal system error

Markdown source: View on AtomGit·Content from the open-source project gitcode-dev/atomgit-api-doc