GET /api/v1.0/labels

This endpoint fetch list of all the tag based on given query parameters.

Query parameters

  • limit number Required

    Maximum number of labels to return per page. Used for pagination. Pass as query string (e.g. "25").

    Minimum value is 1, maximum value is 100. Default value is 25.

  • offset number Required

    Number of records to skip. Used with limit for pagination: first page = "0", second page = limit value, etc. Pass as query string (e.g. "0").

    Minimum value is 0. Default value is 0.

  • type number

    Filter labels by type(0 for Task labels & 1 for Members label). Returns only labels of the specified type. Omit to get all label types.

    Values are 0 or 1.

Responses

  • 200 application/json

    Success Response

    Hide response attributes Show response attributes object
    • hasMore boolean

      True if there are more record else false

      Default value is false.

    • items array[object] Required

      List of Label records

      Hide items attributes Show items attributes object
      • id string Required

        Unique identifier of the label.

      • name string Required

        Display name of the label.

      • color string Required

        Hex color code for the label.

      • type string Required

        Label type (e.g. others, member). Determines scope of the label.

      • created_by string Required

        ID of the team member who created the label.

      • team string Required

        ID of the team this label belongs to.

      • default boolean Required

        Whether this label is a default/system label for the team.

  • 401

    The client request has not been completed because it lacks valid authentication credentials for the requested resource.

  • 403

    The client does not have access rights to the content.

  • 405

    The request method is known by the server but is not supported by the target resource.

GET /api/v1.0/labels
curl \
 --request GET 'https://openapi.niftypm.com/api/v1.0/labels?limit=25&offset=0' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
{
  "hasMore": false,
  "items": [
    {
      "id": "a1b2c3d4-e5f6",
      "name": "Urgent",
      "color": "#4A90D9",
      "type": "others",
      "created_by": "b2c3d4e5-f6a",
      "team": "c3d4e5f6-a7b8",
      "default": false
    }
  ]
}