Categories

API for managing Categories

List Categories

GET https://www.magloft.com/api/portal/v1/categories/:app_id

This endpoint returns a list of all categories that belong to the publication

Path Parameters

Name	Type	Description
app_id	String	App ID (Publication) to scope this request for.

200

{
  "id": 1234,
  "title": "Business",
  "color": "#444444",
  "position": 0
}

Get Category

GET https://www.magloft.com/api/portal/v1/categories/:app_id/:id

This endpoint returns a specific category by id

Path Parameters

Name	Type	Description
app_id	String	App ID (Publication) to scope this request for.
id	Integer	Category ID

200

{
  "id": 1234,
  "title": "Business",
  "color": "#444444",
  "position": 0
}

Sort Categories

POST https://www.magloft.com/api/portal/v1/categories/:app_id/sort

This endpoint sorts all categories by position and returns an empty response with status 204

Path Parameters

Name	Type	Description
app_id	String	App ID (Publication) to scope this request for.

Request Body

Name	Type	Description
positions	Array
positions[id]	Integer
positions[position]	Integer

204

null

Create Category

POST https://www.magloft.com/api/portal/v1/categories/:app_id

This endpoint creates a new category and returns the saved category

Path Parameters

Name	Type	Description
app_id	String	App ID (Publication) to scope this request for.

Request Body

Name	Type	Description
title	String	Title of a category
color	String	Hex color of a category

200

{
  "id": 1234,
  "title": "Business",
  "color": "#444444",
  "position": 0
}

Update Category

PUT https://www.magloft.com/api/portal/v1/categories/:app_id/:id

This endpoint updates a specific category by id and returns the updated category

Path Parameters

Name	Type	Description
app_id	String	App ID (Publication) to scope this request for.
id	Integer	Category ID

Request Body

Name	Type	Description
title	String	Title of a category
color	String	Hex color of a category

200

{
  "id": 1234,
  "title": "Business",
  "color": "#444444",
  "position": 0
}

Delete Category

DELETE https://www.magloft.com/api/portal/v1/categories/:app_id/:id

This endpoint deletes a specific category by id and returns an empty response with status 204

Path Parameters

Name	Type	Description
app_id	String	App ID (Publication) to scope this request for.
id	Integer	Category ID

204

null