v1

latestOpenAPI 3.0.12026-07-17172067.5 KB
Categories

Get categories list

Retrieves a list of categories with optional filtering and pagination.

get/api/v1/categories

Query parameters

limitinteger

Maximum number of results to return

offsetinteger

Number of results to skip

sort_by'created_at' | 'label' | 'slug'

Field to sort by

sort_order'asc' | 'desc'

Sort order

status'pending' | 'approved' | 'rejected' | 'deleted'

Filter by status

slugstring

Filter by slug

labelstring

Filter by label

Response

Categories retrieved successfully

messagestring
statusinteger

Example response

{
  "message": "Categories retrieved successfully",
  "status": 200,
  "data": [
    {
      "id": 1,
      "uuid": "0199d379-d2d4-76a1-9d2d-f99640a16929",
      "slug": "interview-qna",
      "label": "Interview Q&A",
      "description": "Interview category to manage all interview related sub categories",
      "created_by": 1,
      "updated_by": 1,
      "approved_by": 1,
      "deleted_by": 1,
      "created_at": "2024-01-01T00:00:00Z",
      "updated_at": "2024-01-01T00:00:00Z",
      "approved_at": "2024-01-01T00:00:00Z",
      "deleted_at": "2024-01-01T00:00:00Z",
      "status": "approved"
    }
  ]
}
All 17 operations