Retrieve a Category

GET 
/v1/categories/:id

Retrieve a Category

Request

Path Parameters

id stringrequired

Id of the Category

Responses

200

Successfully retrieved a Category

application/json

Schema

Schema

data object
id string
name string
imageUrl stringnullable
createdAt date-time
object string

Example (from schema)

{
  "data": {
    "id": "category_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "name": "Environmental",
    "imageUrl": "categories/3.png",
    "createdAt": "2020-10-13T17:46:54.000Z"
  },
  "object": "Category"
}

400

Error validating inputs

application/json

Schema

Schema

error object
code string
title string
message string
reasons string[]

Example (from schema)

{
  "error": {
    "code": "bad_request",
    "title": "Bad request",
    "message": "One or more of the inputs were invalid",
    "reasons": [
      "pageSize must be greater than or equal to 0"
    ]
  }
}

401

Unauthorized

403

Forbidden

application/json

Schema

Schema

error object
code string
title string
message string

Example (from schema)

{
  "error": {
    "code": "forbidden",
    "title": "Forbidden",
    "message": "Access is denied due to insufficient privileges"
  }
}

404

The specified resource was not found

application/json

Schema

Schema

error object
code string
title string
message string

Example (from schema)

{
  "error": {
    "code": "not_found",
    "title": "Resource not found",
    "message": "This endpoint is unavailable or can not be found"
  }
}

Loading...