Categories

Returns one item category.

Requires ViewInventory. Send the previous ETag as If-None-Match to receive 304 Not Modified when unchanged.

get/api/v1/categories/{id}

Request

  • Base URL: https://app.flexonthejob.com
  • URL: https://app.flexonthejob.com/api/v1/categories/{id}
  • Auth: HTTP bearer

Path parameters

idinteger required

Category id. Example: 4.

Response

The category.

idinteger

Numeric category id, e.g. 4; the categoryId of items and the id used by /api/v1/categories/{id}/properties.

syncIdstring uuid

Globally unique sync id (GUID). Use it as the after pagination cursor.

namestring

Category name, e.g. "Lumber".

descriptionstring nullable

Optional description; null when unset.

parentCategoryIdinteger nullable

Id of the parent category; null for a top-level category.

isTemplateBuilderCategoryboolean

True when the category was generated by a Template Builder (its name and place in the tree are managed there, not on the Item Categories page).

createdAtstring date-time

UTC creation timestamp (ISO-8601).

updatedAtstring date-time nullable

UTC timestamp of the last edit of the category itself; null when never edited. Property changes do not move it.

Changes

No recorded changes to this operation across all 1 revision of this API.