Skip to main content

GET List Test Case Labels

This API endpoint retrieve list of Test Case labels when used with appropriate parameters

Updated this week

API Endpoint


{{apiUrl}}/api/v1/category/labels?startAt={{startAt}}&limit={{limit}}

Headers


To authenticate the API request, you need to provide the Vansah Connect Token that is generated from the Jira workspace's Vansah configuration page.

Authorization

{{vansahConnectToken}}


Generate a Token from Vansah

Request Query Parameter


startAt

{{startAt}}

Optional Rows start at e.g start at 5 out of 15 rows , it will fetch 10 rows from 5 to 15 (for pagination)

limit

{{limit}}

Optional Number of rows to be displayed , default 1000

Response Body


  • success:
    A boolean indicating whether the request was successful.

  • message:
    A message providing additional details about the response.

  • pagination:
    Provides information about the pagination of the data.

    • total: Total number of labels available.

    • startAt: The starting point for the data returned.

    • limit: The number of labels that can be retrieved per request.

  • data:
    A list of Test Case labels returned from the API. Each label has a name field.

Example Response Body


{

"success": true,

"message": "Labels returned successfully",

"pagination": {

"total": 15,

"startAt": 0,

"limit": 1000

},

"data": [

{

"name": "Functional"

},

{

"name": "Integration"

},

{

"name": "Non-Functional"

},

{

"name": "Smoke"

},

{

"name": "backend"

},

{

"name": "frontend"

}

]

}

Did this answer your question?