GET/projects/api/v3/notebooks.json

Get a list of notebooks.

Query Params

  • Name
    updatedAfterDate
    Type
    string
    Description
    filter by updated after date (deprecated, use updatedAfter)
  • Name
    updatedAfter
    Type
    string
    Description
    filter by updated after date
  • Name
    searchTerm
    Type
    string
    Description
    filter by notebook name and description
  • Name
    projectType
    Type
    string
    Description
    filter by project type
    Default
    normal
  • Name
    projectStatuses
    Type
    string
    Description
    filter by project statuses
  • Name
    orderMode
    Type
    string
    Description
    order mode
    Default
    asc
  • Name
    orderBy
    Type
    string
    Description
    order by
    Default
    dateUpdated
  • Name
    createdAfterDate
    Type
    string
    Description
    filter by created after date (deprecated, use createdAfter)
  • Name
    createdAfter
    Type
    string
    Description
    filter by created after date
  • Name
    pageSize
    Type
    integer
    Description
    number of items in a page
    Default
    50
  • Name
    page
    Type
    integer
    Description
    page number
    Default
    1
  • Name
    showDeleted
    Type
    boolean
    Description
    include deleted items
    Default
    false
  • Name
    secureOnly
    Type
    boolean
    Description
    filter by showing only secure notebooks
    Default
    false
  • Name
    matchAllTags
    Type
    boolean
    Description
    match all notebook tags
  • Name
    matchAllProjectTags
    Type
    boolean
    Description
    match all project tags
  • Name
    lockedOnly
    Type
    boolean
    Description
    filter by showing only locked notebooks
    Default
    false
  • Name
    includeContents
    Type
    boolean
    Description
    include contents.
    Default
    true
  • Name
    includeArchivedProjects
    Type
    boolean
    Description
    include archived projects
  • Name
    getEmoji
    Type
    boolean
    Description
    parse emojis to unicode
    Default
    true
  • Name
    tagIds
    Type
    array[integer]
    Description
    filter by notebook tag ids
    Format
    Comma separated values
  • Name
    projectTagIds
    Type
    array[integer]
    Description
    filter by project tag ids
    Format
    Comma separated values
  • Name
    projectOwnerIds
    Type
    array[integer]
    Description
    filter by project owner ids
    Format
    Comma separated values
  • Name
    projectIds
    Type
    array[integer]
    Description
    filter by project ids
    Format
    Comma separated values
  • Name
    projectHealths
    Type
    array[integer]
    Description
    filter by project healths

    0: not set
    1: bad
    2: ok
    3: good
    Format
    Comma separated values
    Allowed values
    • 0
    • 1
    • 2
    • 3
  • Name
    projectCompanyIds
    Type
    array[integer]
    Description
    filter by company ids
    Format
    Comma separated values
  • Name
    projectCategoryIds
    Type
    array[integer]
    Description
    filter by project category ids
    Format
    Comma separated values
  • Name
    include
    Type
    array[string]
    Description
    include
    Format
    Comma separated values
    Allowed values
    • projects
    • tags
    • users
    • notebookCategories
    • companies
    • teams
  • Name
    ids
    Type
    array[integer]
    Description
    filter by ids
    Format
    Comma separated values
  • Name
    fields[users]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • firstName
    • lastName
    • title
    • email
    • companyId
    • company
    • isAdmin
    • isClientUser
    • isServiceAccount
    • type
    • deleted
    • avatarUrl
    • lengthOfDay
    • workingHoursId
    • workingHour
    • userRate
    • userCost
    • canAddProjects
  • Name
    fields[teams]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • name
    • teamLogo
    • teamLogoIcon
    • teamLogoColor
  • Name
    fields[tags]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • name
    • color
    • count
  • Name
    fields[projects]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • name
  • Name
    fields[notebooks]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • name
    • description
    • contents
    • type
    • isPrivate
    • locked
    • lockdownId
    • secureContent
    • projectId
    • createdByUserID
    • updatedByUserID
    • deletedByUserID
    • dateUpdated
    • dateCreated
    • dateDeleted
    • deleted
    • categoryId
    • notebookVersionID
    • notebookVersionCreatedDateTime
    • notebookVersionUpdatedDateTime
    • latestVersionNo
    • commentsCount
    • readCommentsCount
    • contentHTML
    • privacy
    • commentFollowers
    • changeFollowers
    • projectNotifyCommentIncludeCreator
    • tagIds
  • Name
    fields[notebookCategories]
    Type
    array[string]
    Description
    Format
    Comma separated values
  • Name
    fields[companies]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • name
    • logoUploadedToServer
    • logoImage
  • Name
    creatorIds
    Type
    array[integer]
    Description
    filter by creators' ids
    Format
    Comma separated values
  • Name
    categoryIds
    Type
    array[integer]
    Description
    filter by notebook category ids
    Format
    Comma separated values

Responses

  • Code
    200
    Type
    object
    Schema
    Description
    200 OK
    NotebooksResponse contains information about a group of notebooks.
  • Code
    400
    Type
    object
    Schema
    Description
    400 Bad Request
    ErrorResponse defines how []Error should be marshaled to JSON.
  • Code
    403
    Type
    object
    Schema
    Description
    403 Forbidden
    ErrorResponse defines how []Error should be marshaled to JSON.
  • Code
    404
    Description
    404 Not Found No Data

Examples

200 OK

NotebooksResponse
{  "included": {    "companies": {      "additionalProp": {        "accounts": 0,        "addressOne": "string",        "addressTwo": "string",        "budgetDistribution": [          {            "companyId": 0,            "count": 0,            "from": 0,            "to": 0          }        ],        "canSeePrivate": true,        "cid": "string",        "city": "string",