Get organization board list¶

GET /api/v5/org/{owner}/kanban/list

This endpoint retrieves the list of boards under the specified organization. It supports filtering by state and visibility, searching by name, sorting by newest or oldest, and paginated responses, and also provides statistics on the total number of boards and the number of normal and closed boards.

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
`status`	query	integer	No	State, `0`: normal, `1`: closed; by default, all are returned when not passed
`sort`	query	string	No	Sort order, `newest`: newest, `oldest`: oldest
`visibility`	query	integer	No	Visibility, `1`: public, `2`: private
`search`	query	string	No	Search by name
`page`	query	string	No	Current page number
`per_page`	query	string	No	Number per page

Response parameters¶

Field	Type	Always returned	Nullable	Description
`close_count`	integer	Yes	No	Number of closed boards
`open_count`	integer	Yes	No	Number of normal-state boards
`all_count`	integer	Yes	No	Total number of boards
`content`	array	Yes	No	Board list

content object

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

Error responses¶

400 Invalid parameters

{
  "error": "invalid_request",
  "message": "Invalid parameters"
}

401 Unauthenticated

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

Note: The actual error field names are determined by what the backend returns.

HTTP response status codes¶

Status code	Description
`200`	Success (OK)
`400`	Invalid parameters (Bad Request)
`401`	Requires authentication
`403`	Forbidden
`404`	Request path does not exist (Not Found)
`429`	Too many requests; rate limit triggered (Too Many Requests)
`500`	Internal system error (Internal Server Error)

Request example¶

Parameter description¶

Replace <owner> with the organization path (the address path of an enterprise, organization, or individual); This endpoint allows anonymous access; you may also authenticate with an AtomGit user access token (append ?access_token=<token>).

cURL¶

curl -X GET 'https://api.atomgit.com/api/v5/org/<owner>/kanban/list?status=0&sort=newest&visibility=1&page=1&per_page=20' \
  -H 'Accept: application/json'

JavaScript¶

// Native fetch (Node.js 18+ / browser)
const owner = "<owner>";
const params = new URLSearchParams({
  status: "0",
  sort: "newest",
  visibility: "1",
  page: "1",
  per_page: "20",
});

const response = await fetch(`https://api.atomgit.com/api/v5/org/${owner}/kanban/list?${params}`, {
  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/list",
    params={
        "status": 0,
        "sort": "newest",
        "visibility": 1,
        "page": 1,
        "per_page": 20,
    },
    headers={
        "Accept": "application/json",
    },
    timeout=10,
)
resp.raise_for_status()

print(resp.json())

Response example¶

Status code: 200

{
  "close_count": 0,
  "open_count": 0,
  "all_count": 0,
  "content": [
    {
      "id": "string",
      "iid": 0,
      "name": "string",
      "description": "string",
      "status": 0,
      "visibility": 0,
      "updated_at": "string"
    }
  ]
}

Error codes¶

Error code	Description
`401`	Unauthenticated or invalid credentials (missing or invalid access credentials)
`400`	Invalid parameters or unparseable request
`404`	Request path does not exist
`405`	Request method not supported
`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