Get Category By ID

GET

/v1/categories/{companyId}/{brandId}/{categoryId}

curl --request GET \
  --url https://api.dev.caspeco.net/api/am/v1/categories/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0

Returns the category with the given internal category ID

Parameters

Path Parameters

companyId

required

string format: uuid

brandId

required

string format: uuid

categoryId

required

string format: uuid

Responses

200

Returns the category

object

categoryId

required

string format: uuid

parentCategoryId

string format: uuid

nullable

name

required

string

description

required

string

nullable

externalId

string

nullable

parentExternalId

string

nullable

object

categoryId

required

string format: uuid

parentCategoryId

string format: uuid

nullable

name

required

string

description

required

string

nullable

externalId

string

nullable

parentExternalId

string

nullable

Example^generated

{
  "categoryId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "parentCategoryId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "name": "example",
  "description": "example",
  "externalId": "example",
  "parentExternalId": "example"
}

object

categoryId

required

string format: uuid

parentCategoryId

string format: uuid

nullable

name

required

string

description

required

string

nullable

externalId

string

nullable

parentExternalId

string

nullable

Example^generated

{
  "categoryId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "parentCategoryId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "name": "example",
  "description": "example",
  "externalId": "example",
  "parentExternalId": "example"
}

401

Unauthorized

403

Forbidden

404

Not Found

object

statusCode

integer format: int32

message

string

validationErrors

Array<object>

nullable

object

field

required

string

errorId

required

string

entity

string

nullable

object

statusCode

integer format: int32

message

string

validationErrors

Array<object>

nullable

object

field

required

string

errorId

required

string

entity

string

nullable

Example^generated

{
  "statusCode": 1,
  "message": "example",
  "validationErrors": [
    {
      "field": "example",
      "errorId": "example"
    }
  ],
  "entity": "example"
}

object

statusCode

integer format: int32

message

string

validationErrors

Array<object>

nullable

object

field

required

string

errorId

required

string

entity

string

nullable

Example^generated

{
  "statusCode": 1,
  "message": "example",
  "validationErrors": [
    {
      "field": "example",
      "errorId": "example"
    }
  ],
  "entity": "example"
}

500

Internal Server Error