Tags API

v1.0 • REST • JSON

Full CRUD management for tag accounts. Create, retrieve, update, and delete tag records with built-in pagination and role-based access control support.

GET POST PUT DELETE 5 Endpoints
Base URL https://bogusapi.com/api/tags

Quick Reference

GET
/api/tags List all tags (paginated)
200 GET
/api/tags/{id} Get one tag by ID
200 POST
/api/tags Create a new tag
201 PUT
/api/tags/{id} Replace tag data
204 DEL
/api/tags/{id} Remove a tag
204 GET
/api/tags/{id} Tag not found example
404
GET /api/tags 200 OK

Get All Tags

Retrieves a paginated list of all tags in the system. Use the page and limit query parameters to navigate large result sets. The response envelope includes total count and page metadata.

Query Parameters
ParameterTypeDefaultDescription
page integer 1 Page number, 1-based index
limit integer 10 Number of records per page
Response: 200 OK
GET /api/tags/{id} 200 OK

Get Single Tag

Fetch the full profile for a specific tag using their numeric ID. Returns all tag fields including assigned role names and account metadata.

Path Parameters
ParameterTypeRequiredDescription
id integer Required Unique tag identifier
Response: 200 OK
GET /api/tags/{id} 404 Not Found

Tag Not Found

Returned when the requested tag ID does not exist in the system. Use this example to test error-handling logic and build graceful fallback UI for missing tag resources.

Response: 404 Not Found
POST /api/tags 201 Created

Create Tag

Registers a new tag with the provided details. On success, returns the newly created tag object including the auto-generated ID, timestamp, and resolved role names.

Request Body
Field Type Required Description
name string Required Name
slug string Required Slug
description string Required Description
color string Required Color
isActive boolean Required Is active
Body
Response: 201 Created
PUT /api/tags/{id} 200 OK

Update Tag

Fully replaces an existing tag's data with the values in the request body. A successful update returns 200 OK with response body.

Request Body
Field Type Required Description
name string Required Name
slug string Required Slug
description string Required Description
color string Required Color
isActive boolean Required Is active
Body
Response: 200 OK
DELETE /api/tags/{id} 204 No Content

Delete Tag

Permanently removes a tag from the system by their ID. This action is irreversible once deleted, the tag record and all associated data cannot be recovered through the API.

Path Parameters
ParameterTypeRequiredDescription
id integer Required ID of the tag to delete
Response: 204 No Content