Unit GET

GET 
/unit_types/:unitTypeId

Required Permissions: UnitType Get or UnitType Admin

Request

Path Parameters

unitTypeId integerrequired

The id of the Unit that you wish to get data from.

Responses

200

A JSON Object containing a unit's data.

application/json

Schema

Schema

unit_type object
id integer
name string
description string
created_at date-time
created_by_user_id integer
updated_at date-timenullable
updated_by_user_id integernullable
created_by object
archived boolean
avatar objectnullable
avatar_file_upload_url string
created_at date-time
created_by_user_id integer
Possible values: >= 1
department string
email email
archived boolean

Example (from schema)

{
  "unit_type": {
    "id": 0,
    "name": "user_id",
    "description": "The ids of our users",
    "created_at": "2024-12-02T14:38:57.881Z",
    "created_by_user_id": 0,
    "updated_at": "2024-12-02T14:38:57.881Z",
    "updated_by_user_id": 0,
    "created_by": {
      "archived": false,
      "avatar": {},
      "avatar_file_upload_url": "/cropUrl/100x100/1.png",
      "created_at": "2024-12-02T14:38:57.881Z",
      "created_by_user_id": 0,
      "department": "Marketing",
      "email": "user@example.com"
    },
    "archived": false
  }
}

Loading...