GET Categories

Overview

---

The following table contains information about the GET method for managing the process of retrieving all available categories.

GET Categories
Method	GET
URL or Endpoint	/api​/v1/categories/select-list
Parameters	Not applicable
Body	Not applicable

Response

{
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": 1,
      "name": "Arts",
      "value": "ARTS",
      "description": null
    },
    {
      "id": 2,
      "name": "Business",
      "value": "BUSINESS",
      "description": null
    },
    {
      "id": 3,
      "name": "Comedy",
      "value": "COMEDY",
      "description": null
    },
    {
      "id": 4,
      "name": "Education",
      "value": "EDUCATION",
      "description": null
    },
    {
      "id": 5,
      "name": "Fiction",
      "value": "FICTION",
      "description": null
    },
    {
      "id": 6,
      "name": "Government",
      "value": "GOVERNMENT",
      "description": null
    },
    {
      "id": 7,
      "name": "History",
      "value": "HISTORY",
      "description": null
    },
    {
      "id": 8,
      "name": "Health & Fitness",
      "value": "HEALTH & FITNESS",
      "description": null
    },
    {
      "id": 9,
      "name": "Kids & Family",
      "value": "KIDS & FAMILY",
      "description": null
    },
    {
      "id": 10,
      "name": "Leisure",
      "value": "LEISTURE",
      "description": null
    },
    {
      "id": 11,
      "name": "Music",
      "value": "MUSIC",
      "description": null
    },
    {
      "id": 12,
      "name": "News",
      "value": "NEWS",
      "description": null
    },
    {
      "id": 13,
      "name": "Religion & Spirituality",
      "value": "RELIGION & SPIRITUALITY",
      "description": null
    },
    {
      "id": 14,
      "name": "Science",
      "value": "SCIENCE",
      "description": null
    },
    {
      "id": 15,
      "name": "Society & Culture",
      "value": "SOCIETY & CULTURE",
      "description": null
    },
    {
      "id": 16,
      "name": "Sports",
      "value": "SPORTS",
      "description": null
    },
    {
      "id": 17,
      "name": "Technology",
      "value": "TECHNOLOGY",
      "description": null
    },
    {
      "id": 18,
      "name": "True Crime",
      "value": "TRUE CRIME",
      "description": null
    },
    {
      "id": 19,
      "name": "TV & Film",
      "value": "TV & FILM",
      "description": null
    }
  ],
  "resultInfo": null,
  "statusCode": 200
}

Information about the fields that appear when you receive the response are displayed in the table below.

Field Name	Type	Description
success	bool	If the response is successful, it will return true. Otherwise, it will return false.
errors	array[string]	Indicates if there was an error.
messages	array[string]	Returns the response message from the backend.
result	array[object]	Returns the response array containing the detailed result objects.
id	integer	The unique identifier for the category.
name	string	The name of the category.
value	string	The value of the category
description	string	A description of the category (nullable).
resultInfo	object	Additional information about the result
statusCode	integer	The HTTP status code of the response.

Errors

For information about the errors that are common to all actions, see Common Errors:

• HTTP Status Code 400: Bad Request

• HTTP Status Code 401: Unauthorized

• HTTP Status Code 403: Forbidden

• HTTP Status Code 404: Result Not Found

• HTTP Status Code 500: Internal Server Error

• HTTP Status Code 503: Backend Fetch Failed