---
title: "How to retrieve tag data using Flowbox's API "
url: "https://kb.getflowbox.com/en/article/how-to-retrieve-tag-data-using-flowboxs-api"
language: "en"
last_updated: "2026-06-03T12:54:05.755Z"
---

# How to retrieve tag data using Flowbox's API 

This guide will show you how to retrieve tag data from Flowbox’s API

## Prerequisites

Before you start, ensure you have the following:

-   **API key**: Your unique API authentication key. If you don't have it yet, please contact your CSM and they'll provide it to you.

## API Endpoint

To retrieve tag data from Flowbox, use the following 'GET' request:

```
https://external-api.getflowbox.com/v2/tags
```

| You can find more information and make test calls in our [Swaggerhub page](https://app.swaggerhub.com/apis-docs/FlowboxAB/External-API/v2#/External%20API/GetTags).

## Purpose

This endpoint returns a paginated list of tags for your company. You can optionally filter results by post permalinks and/or approval status. Results can be ordered by creation date or alphabetically by tag name.

## Required Parameters

| Parameter | Type | Location | Description |
| --- | --- | --- | --- |
| `api-key` | string | header | Your API authentication key. Must be included in every request. |

## Optional Parameters

| Parameter | Type | Location | Description |
| --- | --- | --- | --- |
| `permalinks` | array<string> | query | One or more post permalinks to filter tags by. Can be provided as repeated query parameters or as a single comma-separated string, e.g. `permalinks=https://example.com/post1,` [`https://example.com/post2`](https://example.com/post2). |
| `is_approved` | boolean | query | Filter tags by approval status. Omit to return tags regardless of approval status. |
| `page` | integer | query | Page number (1-based). Defaults to `1`. |
| `limit` | integer | query | Number of tags to return per page. Defaults to `50`. |
| `order_by` | string | query | Sort order for the returned tags. `latest_created_at`: most recently created first (default). `tag_name`: alphabetical by tag name. |

## Example API Request

```
curl -X 'GET' \
  'https://virtserver.swaggerhub.com/FlowboxAB/External-API/v2/tags?permalinks=https%3A%2F%2Fexample.com%2Fpost1&page=1&limit=50&order_by=latest_created_at' \
  -H 'accept: application/json' \
  -H 'api-key: INSERT_API_KEY_HERE'
```

In this example, the request would retrieve tags assigned to post: '`https://example.com/post1`'

## Response

The API will return a paginated data object containing a list of tags matching your query:

**Root:**

| Field | Type | Description |
| --- | --- | --- |
| `status` | string | Request status. One of: `"success"`, `"error"`. |
| `data.tags` | array<string> | List of tag strings matching the query. |
| `data.total_items` | integer | Total number of tags matching the query across all pages. |
| `data.total_pages` | integer | Total number of pages available. |
| `data.next_page` | integer | Page number of the next page. `null` if on the last page. |
| `data.prev_page` | integer | Page number of the previous page. `null` if on the first page. |

###   

> You can find more information and make test calls in our [Swaggerhub page](https://app.swaggerhub.com/apis-docs/FlowboxAB/External-API/v2#/External%20API/GetTags).