Skip to main content
Version: 2023-02-21

Get List

GET 
/projects/lists/:listId

Fetches one list by id. parentId is the parent folder or space. Statuses: GET /projects/lists/{listId}/statuses.

Request​

Version stringrequired

API Version

Available optionsv3
listId stringrequired

List id

locationId string

Location id. Required for channel: APP. Ignored for OAuth/PIT — those use the location on the auth token. Do not send in path, body, or headers.

application/json

Successful response

Schema
    idstringrequired

    Resource id

    typestringrequired

    Resource type. Allowed: space, folder, list.

    Available optionsspacefolderlist
    namestringrequired

    Display name

    locationIdstring

    Location id

    parentIdstringnullable

    Parent id. A folder’s parent is a space. A list’s parent is a space when the list was created directly under that space, otherwise a folder. Spaces omit this. Statuses: call Get List Statuses — do not walk parents.

    effectiveStatusSourceIdstringnullable

    Id of the space whose status set applies. Null when the default set applies. Prefer Get List Statuses.

    colorstringnullable

    Hierarchy palette swatch (same 16 values accepted on create/update). Status color on status groups is unrestricted hex — not this enum. Allowed: #3B82F6, #6366F1, #8B5CF6, #A855F7, #EC4899, #EF4444, #F97316, #F59E0B, #EAB308, #84CC16, #22C55E, #10B981, #14B8A6, #06B6D4, #0EA5E9, #6B7280.

    Available options#3B82F6#6366F1#8B5CF6#A855F7#EC4899#EF4444#F97316#F59E0B#EAB308#84CC16#22C55E#10B981
    isPrivateboolean

    Whether the resource is private. When true, access is gated by direct grants (and ancestors). When false, the resource is public for the location; existing direct grants remain but do not gate access while public.

    positionstringnullable

    Opaque sibling sort key (lexorank). Compare as strings; do not parse as a number. Server-assigned — there is no public reorder endpoint.

    createdAtstring

    When the space, folder, or list was created (ISO-8601)

    updatedAtstring

    When the space, folder, or list was last updated (ISO-8601)