Skip to main content
GET
/
v2
/
lists
/
{listId}
Details
curl --request GET \
  --url https://api.bizzy.ai/v2/lists/{listId} \
  --header 'Authorization: Bearer <token>'
{
    "data": {
        "listId": "420055",
        "name": "Example List",
        "objectType": "COMPANY",
        "statusMode": "MANUAL",
        "defaultView": "LIST",
        "statuses": [
            {
                "key": "new",
                "label": "New",
                "color": "#3F8EFF",
                "position": 0,
                "isArchivedBucket": false
            }
        ],
        "createdAt": "2026-05-20T08:45:00.000Z",
        "updatedAt": "2026-06-18T10:30:00.000Z"
    }
}

Request

Path

listId
string
required
Obfuscated listId returned by the overview endpoint.

Response

objectType
string
One of COMPANY, LEGAL_ENTITY or CONTACT.
statusMode
string
One of MANUAL or CRM_MIRRORED.
defaultView
string
One of LIST, BOARD or MAP.
statuses
object[]
The status buckets configured for this list. Each status has a key, label, color, position and an isArchivedBucket flag.
{
    "data": {
        "listId": "420055",
        "name": "Example List",
        "objectType": "COMPANY",
        "statusMode": "MANUAL",
        "defaultView": "LIST",
        "statuses": [
            {
                "key": "new",
                "label": "New",
                "color": "#3F8EFF",
                "position": 0,
                "isArchivedBucket": false
            }
        ],
        "createdAt": "2026-05-20T08:45:00.000Z",
        "updatedAt": "2026-06-18T10:30:00.000Z"
    }
}