tags

List Post

POST
Lists the available tags.

Request

This endpoint expects an object.
cursor
stringOptional
The cursor to resume iteration from. If not provided, then iteration starts from the beginning.
limit
integerOptional
The maximum number of tags to return. The default is '50'.
mode
enumOptional
The iteration mode to use. If "after", then entries after the provided cursor will be returned, or if no cursor is provided, then from the beginning. If "before", then entries before the provided cursor will be returned, or if no cursor is provided, then from the end. Entries will always be returned in the specified sort-by order.
Allowed values: afterbefore
name
list of stringsOptional
Filters for tags with the provided names.
sort_by
list of stringsOptional
Fields to sort tags by and the direction to sort them.

Response

This endpoint returns an object
tags
list of objects
The list of tags.
next_cursor
stringOptional
The cursor used to iterate subsequent results in accordance to the sort order. If not set, then no later elements exist.
prev_cursor
stringOptional
The cursor used to iterate preceding results in accordance to the sort order. If not set, then no prior elements exist.
POST
1curl -X POST https://api.devrev.ai/tags.list \
2     -H "Authorization: <apiKey>" \
3     -H "Content-Type: application/json" \
4     -d '{}'
Response
1{
2  "tags": [
3    {
4      "id": "id",
5      "name": "name",
6      "allowed_values": [
7        "allowed_values"
8      ],
9      "created_date": "2023-01-01T12:00:00Z",
10      "description": "description",
11      "display_id": "display_id",
12      "modified_date": "2023-01-01T12:00:00Z"
13    }
14  ],
15  "next_cursor": "next_cursor",
16  "prev_cursor": "prev_cursor"
17}
Built with