iotoms Docs

Get a department

GET
/api/v1/catalog/attributes/departments/{id}

Returns one product department by its numeric ID, directly without the status/message envelope, or not found if it does not exist.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Path Parameters

id*integer

ID of the record.

Formatint64

Response Body

OK

*/*
  1. response
id?|

Numeric department ID. Set by the server; use it as departmentId on items.

Formatint64
name*string

Department name, e.g. the top-level grouping of items in the catalog. Required, must be unique and not blank.

modifiedTime*string

Timestamp stored when the department was created (ISO 8601). Renaming it does not change it.

Formatdate-time
Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/catalog/attributes/departments/0'
Example Response
{  "id": 0,  "name": "string",  "modifiedTime": "2019-08-24T14:15:22Z"}