GET/notebooks/{id}/comments/teams.json

Get a notebook's teams

Fetches any teams relevant for the specified notebook. i.e.. teams in privacy, or following changes/comments.

Path Params

  • Name
    id
    Type
    string
    required
    Description

Query Params

  • Name
    include
    Type
    string
    Description
  • Name
    page
    Type
    integer
    Description
    Default
    1
  • Name
    pageSize
    Type
    integer
    Description
    Default
    50
  • Name
    sortBy
    Type
    string
    Description
    Default
    name
    Allowed values
    • name
    • picker
    • dateAdded
  • Name
    sortOrder
    Type
    string
    Description

    asc or desc - The order to sort the returned data

    Default
    asc
    Allowed values
    • asc
    • desc
  • Name
    searchTerm
    Type
    string
    Description

    Partial text search by team name or handle (case insensitive).

    Default
  • Name
    accessList
    Type
    string
    Description

    Ensures only teams in the provided access list are returned. e.g. 1, c2, t3 (user, company team)

    Default
  • Name
    getEmoji
    Type
    boolean
    Description
    Default
    true
  • Name
    showDeleted
    Type
    boolean
    Description
    Default
    false
  • Name
    updatedAfterDate
    Type
    string
    Description

    Only return teams updated after a certain datetime (YYYYMMDDHHMMSS)

  • Name
    projectIds
    Type
    string
    Description

    Use this to get back all teams in a subset of projects. e.g. projectIds=123,432

  • Name
    userIds
    Type
    string
    Description

    Use this to get back all teams for a given subset of users in those teams.

  • Name
    teamIds
    Type
    string
    Description

    Use this to get back all teams for a given subset of team ids.

  • Name
    companyIds
    Type
    string
    Description

    Use this to get back all teams matching a given subset of company ids.

  • Name
    parentTeamIds
    Type
    string
    Description

    Use this to get back all teams for a given subset of parent team ids.

  • Name
    excludeTeamIds
    Type
    string
    Description

    Use this to exclude all teams matching a given subset of team ids.

  • Name
    includeGlobalTeams
    Type
    boolean
    Description

    Use this to include all teams from the top site level.

    Default
    true
  • Name
    includeCompanyTeams
    Type
    boolean
    Description

    Use this to include all teams for companies matching the filters.

    Default
    false
  • Name
    includeProjectTeams
    Type
    boolean
    Description

    Use this to include all project level teams that match the filters.

    Default
    false
  • Name
    includePrivateTeams
    Type
    boolean
    Description

    Use this to include all private teams matching the filter.

    Default
    false
  • Name
    includeSubteams
    Type
    boolean
    Description

    Use this to include any subteams matching the filters.

    Default
    false
  • Name
    onlyGlobalTeamsWithProjectMembers
    Type
    boolean
    Description

    Use this to return only global teams that have members on the provided projectIds.

    Default
    false

Responses

  • Code
    200
    Type
    object
    Schema
    Description
    200 Response

Examples

Example

{
  "STATUS": "string",
  "included": [
    {
      "createdByUserId": "string",
      "name": "string",
      "description": "string",
      "logoIcon": "string",
      "deletedDate": "string",
      "handle": "string",
      "dateUpdated": "string",
      "company": {
        "name": "string",
        "id": "string"
      },
      "parentTeam": {
        "name": "string",
        "handle": "string",
        "id": "string"
      },
      "rootTeam": {
        "name": "string",
        "handle": "string",
        "id": "string"
      },
      "numMembers": "string",
      "projectId": "string",
      "logoUrl": "string",
      "members": [
        {
          "id": "string",
          "name": "string"
        }
      ],
      "logoColor": "string",
      "numDirectChildren": "string",
      "canEdit": true,
      "updatedByUserId": "string",
      "isPrivate": true,
      "id": "string",
      "dateCreated": "string",
      "defaultProjectIds": "string",
      "numSubteams": "string",
      "deleted": true,
      "isInPrivacy": true,
      "isResponsible": true,
      "isFollowingChanges": true,
      "isFollowingComments": true,
      "hasAccess": true
    }
  ],
  "teams": [
    {
      "createdByUserId": "string",
      "name": "string",
      "description": "string",
      "logoIcon": "string",
      "deletedDate": "string",
      "handle": "string",
      "dateUpdated": "string",
      "company": {
        "name": "string",
        "id": "string"
      },
      "parentTeam": {
        "name": "string",
        "handle": "string",
        "id": "string"
      },
      "rootTeam": {
        "name": "string",
        "handle": "string",
        "id": "string"
      },
      "numMembers": "string",
      "projectId": "string",
      "logoUrl": "string",
      "members": [
        {
          "id": "string",
          "name": "string"
        }
      ],
      "logoColor": "string",
      "numDirectChildren": "string",
      "canEdit": true,
      "updatedByUserId": "string",
      "isPrivate": true,
      "id": "string",
      "dateCreated": "string",
      "defaultProjectIds": "string",
      "numSubteams": "string",
      "deleted": true,
      "isInPrivacy": true,
      "isResponsible": true,
      "isFollowingChanges": true,
      "isFollowingComments": true,
      "hasAccess": true
    }
  ],
  "users": {},
  "projects": {}
}
Download Swagger