API Docs

Tags

You can use tags to categorize records using the Blue API.

Get list of tags

To get a list of tags, you can use the following query:

query ListOfTagsWithinProjects {
  tagList(filter: { projectIds: ["ENTER PROJECT ID"], excludeArchivedProjects: false }) {
    items {
      id
      uid
      title
      color
      project {
        id
        name
      }
      createdAt
      updatedAt
    }
    pageInfo {
      totalPages
      totalItems
      page
      perPage
      hasNextPage
      hasPreviousPage
    }
  }
}

Here's a table explaining the fields returned in the ListOfTagsWithinProjects query:

FieldDescription
idThe unique identifier for the tag
uidA user-friendly unique identifier for the tag
titleThe name or title of the tag
colorThe color associated with the tag
project.idThe unique identifier of the project the tag belongs to
project.nameThe name of the project the tag belongs to
createdAtThe timestamp when the tag was created
updatedAtThe timestamp when the tag was last updated

The pageInfo object provides pagination details:

FieldDescription
totalPagesThe total number of pages of results
totalItemsThe total number of items across all pages
pageThe current page number
perPageThe number of items per page
hasNextPageBoolean indicating if there's a next page of results
hasPreviousPageBoolean indicating if there's a previous page of results

Tag a record

To tag a record with an existing tag, you can use:

mutation UpdateExistingRecordAddTag {
  setTodoTags(
    input: {
      todoId: "RECORDID"
      tagIds: ["TAGID1", "TAGID2"]
    }
  )
}