Documentation

List Business Tags: GET /tags API Reference & Documentation

Last updated on May 6, 2026

GET /tags API Documentation   

Retrieves a paginated list of tags associated with the authenticated business. This endpoint is used to Get tags within the Engage module.

 

Authentication 

Required: Bearer Token

Follow these mechanisms to authenticate your requests:

  • Bearer Token (preferred): 
    Authorization: Bearer <ACCESS_TOKEN>;

Example Headers:

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
Accept: application/json

Error States:

HTTP StatusError CodeMessageDescription
401UNAUTHORIZEDUnAuthorized Access-Token!Missing, invalid, or expired token

Warning: Requests without valid authentication will be rejected with a 401 Unauthorized error.

 

Request Specifications 

HTTP Method & URL

GET /tags

Required Headers:

HeaderValueRequiredDescription
AuthorizationBearerYes*Bearer token for authentication
Acceptapplication/jsonYesExpected response format

*Either Authorization or auth-key must be provided.

Query Parameters:

NameTypeDefaultRequiredDescription
pageint1NoPage number for pagination
limitint20NoItems per page

 

Request Body 

None. GET requests to this endpoint do not accept a request body.

 

Response Handling 

Success Response:

  • HTTP Status: 200 OK
  • Content-Type: application/json

Response Schema:

{
  "payload": {
    "data": [
      {
        "id": 1,
        "name": "string",
        "business_id": 123,
        "created_at": "2024-04-25T12:34:56.000Z",
        "updated_at": "2024-04-25T12:34:56.000Z"
      }
    ],
    "meta": {
      "total": 100,
      "per_page": 20,
      "current_page": 1,
      "last_page": 5
    }
  },
  "message": "Tags fetched successfully!",
  "status": 200,
  "success": true
}

Field Descriptions:

FieldTypeDescription
payload.dataarrayList of tag objects
payload.data[].idintUnique tag identifier
payload.data[].namestringTag name

 

Advanced Details 

Pagination:

  • Type: Page-based
  • Parameters: page, limit