Tags

TerraGo-sourced beneficiary/route tags used to categorize and filter students and zones/locations. Proxied through TerraGo from TerraGo's zone/location and tag registry and re-paginated so links point back at TerraGo; the registry remains the source of truth.

1 endpoint(s)

GET List {{url}}/utility/tags ▸

List beneficiary/route tags available for the organisation. This is read directly from TerraGo's registry — TerraGo forwards the query to the registry, then re-paginates the result so the pagination links point back at TerraGo (not the registry).

Query Parameters

search (string, optional): Filter tags by text.
entity (string, optional): Entity scope (combined with &universal server-side).
per_page (integer, optional, default 10, max 20), page (integer, optional).

Response

Paginated collection of tags (TagResource).

Notes

Depends on the registry; if the registry is unreachable or errors, returns a warning ("Tag Fetching Failed due to WAAS failure").
Requires a bearer token (auth:api).

Auth

Bearer token

Request Body

{
    "per_page": 10,  // Page size — how many results per page
    "page": 1  // Page number (starts at 1)
}

Sample Response (200 OK)

{
    "data": [
        {
            "id": "323c3700-6a64-4b17-acc5-baf7f4f9dc11",
            "name": "School Z",
            "description": "desc",
            "entity": "zone",
            "color_code": "#FF9500"
        },
        {
            "id": "fc49ed94-1521-49cf-9314-99639ec8757c",
            "name": "Carrefour Employee",
            "description": "Account Tag for carrefour employee",
            "entity": "account",
            "color_code": "#EA0D8D"
        },
        {
            "id": "036ad366-7a0a-46b1-8eb3-8dcec63c7589",
            "name": "Carrefour Store",
            "description": "Carrefour Stores",
            "entity": "beneficiary",
            "color_code": "#FF9500"
        },
        {
            "id": "c50eb33d-822e-4409-9196-9867114bf2c2",
            "name": "Carrefour Customer",
            "description": "Tag to describe functions for carrefour Customer",
            "entity": "account",
            "color_code": "#EA0D8D"
        },
        {
            "id": "a6cc8f59-4b10-45fa-b87d-17dd04438bad",
            "name": "Carrefour Embakasi Zone",
            "description": "Carrefour Embakasi Zone Tag",
            "entity": "zone",
            "color_code": "#FF9500"
        },
        {
            "id": "8ec1a686-5c08-4e82-93c6-9bd082605860",
            "name": "BEN WA FISHARY TAG",
            "description": null,
            "entity": "account",
            "color_code": "#FF9500"
        },
        {
            "id": "b85861df-eb37-4b3d-980a-0de36c3a5085",
            "name": "Marcus",
            "description": "marcus",
            "entity": "dependant",
            "color_code": "#FF9500"
        },
        {
            "id": "d625d7bc-81a4-4815-ab0d-b288e47e7d28",
            "name": "Dependant Backstage Access",
            "description": "Dependant Backstage Access",
            "entity": "dependant",
            "color_code": "#EA0D8D"
        },
        {
            "id": "415e9fc8-4206-4dd9-8de7-484dd23a83fa",
            "name": "Backstage Access",
            "description": "Backstage Access",
            "entity": "account",
            "color_code": "#FF9500"
        },
        {
            "id": "82556e35-4593-4fba-9ba5-df73bcb27b61",
            "name": "BACKSTAGE ACCESS",
            "description": "BACKSTAGE ACCESS",
            "entity": "zone",
            "color_code": "#9351E8"
        }
    ],
    "links": {
        "first": "http://localhost:8001/api/tags?page=1",
        "last": "http://localhost:8001/api/tags?page=5",
        "prev": null,
        "next": "http://localhost:8001/api/tags?page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 5,
        "links": [
            {
                "url": null,
                "label": "&laquo; Previous",
                "page": null,
                "active": false
            },
            {
                "url": "http://localhost:8001/api/tags?page=1",
                "label": "1",
                "page": 1,
                "active": true
            },
            {
                "url": "http://localhost:8001/api/tags?page=2",
                "label": "2",
                "page": 2,
                "active": false
            },
            {
                "url": "http://localhost:8001/api/tags?page=3",
                "label": "3",
                "page": 3,
                "active": false
            },
            {
                "url": "http://localhost:8001/api/tags?page=4",
                "label": "4",
                "page": 4,
                "active": false
            },
            {
                "url": "http://localhost:8001/api/tags?page=5",
                "label": "5",
                "page": 5,
                "active": false
            },
            {
                "url": "http://localhost:8001/api/tags?page=2",
                "label": "Next &raquo;",
                "page": 2,
                "active": false
            }
        ],
        "path": "http://localhost:8001/api/tags",
        "per_page": 10,
        "to": 10,
        "total": 41
    },
    "status": 200,
    "message": "Tags Retrieved Successfully"
}