Listing your tags
You can access your tags collection at any time with an HTTP GET on the tags endpoint https://api.rebrandly.com/v1/tags.
Understanding pagination and sortings
We recommend you have deep comprehension about how our API manages Pagination and Sorting.
If you want to get only tags matching a given set of conditions, you can attach filters to your request:
QUERY PARAMETERS
| Parameter name | Type | Constraints | Description |
|---|---|---|---|
| orderBy | string enum - name_default_See Sorting | optional | Sorting criteria to apply to your tags collection |
| orderDir | string enum - descdefault - ascSee Sorting | optional | Sorting direction to apply to your tags collection |
| last | string See Pagination | optional | The id of the last tag you fetched in the last listing API call |
| limit | integer default is 25 See Pagination | optional Strictly positive Max 25 | How many tags to load |
GETting tags collection
$ curl 'https://api.rebrandly.com/v1/tags?orderBy=name&orderDir=asc&limit=100' \
-H 'apikey: YOUR_API_KEY'
JSON response (list of tags matching filters)
[
{
"id": "fffa4cc5b6ee45d6g7897b06ac2d16af",
"name": "promo",
"color": "FF9944"
},
{
"id": "abcdecc5b6ee45d6g7897b06ac2d1xyz",
"name": "tracked",
"color": "55223D"
}
// up to 100 tag objects sorted by name asc
]
Handling errors
| HTTP Status | Error type | Description |
|---|---|---|
| 403 | 403 - Invalid format | Invalid query parameters format. Double check value for property query parameter. Details about validation failure in message field |
Updated 6 months ago