Retrieve Department

Beta

GET/v1/operations/departments/{id}

This endpoint is idempotent. Learn more

Returns a department by ID.

Permissions requiredValues:departments:read

The role behind your API key or agent must grant every one of these permissions.

idstring

ID of the department to retrieve.

include[]optional arrayenumValues:locationscanning_stationsmachines

Sub-objects to expand in the response. When omitted, sub-objects are returned as null.

idstring

Department ID.

objectstringenumValues:department

Resource type identifier.

namestring

Display name of the department.

Unique within the account.

notesstringnullable

Free-form notes about the department.

locationlocationExpandablenullable

The storage location where this department operates.

idstring

Location ID.

objectstringenumValues:location

Resource type identifier.

namestring

Display name of the location.

typeobject

This location's level in the storage hierarchy.

The levels run from largest to smallest: building, section, aisle, rack, shelf, bin. They are descriptive labels rather than a rule — a location's parent is not required to be the next level up.

Always returned as null in this endpoint.

parentlocationnullable

The location directly above this one in the storage hierarchy.

Absent for top-level locations.

Always returned as null in this endpoint.

childrenlistnullable

The locations directly below this one in the storage hierarchy.

Always returned as null in this endpoint.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last-updated timestamp.

scanning_stationslistExpandablenullable

Scanning stations in this department.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

Relative URL that fetches the next page of results.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of scanning_station

Resources in this page.

idstring

Scanning station ID.

objectstringenumValues:scanning_station

Resource type identifier.

namestring

Display name of the scanning station.

Unique within the account.

notesstringnullable

Free-form notes about the scanning station.

typestringenumValues:init_batchmerge_batchmove_batch

Scanning station type, determining which batch operation an operator performs when they scan here.

init_batch: starts a new batch at the beginning of a production flow.
merge_batch: combines several scanned batches into one.
move_batch: advances a batch through a production step connected to this station.
split_batch: divides a batch into several batches.

Fixed when the station is created.

label_sizestringnullableenumValues:1x11x31x4

Size of the labels printed at this station, given as width-by-height (for example, 1x1).

label_typestringnullableenumValues:tagtraveler

Type of label printed at this station.

tag: a label attached to the physical product.
traveler: a routing sheet that accompanies the batch through every production step.

operator_requirementstringenumValues:nonematerial_check

Whether operators must perform a material check at this station.

none: no additional operator check is required.
material_check: a material check is expected before the operation.

departmentdepartmentnullable

The department this scanning station belongs to.

Assigned when the station is created and cannot be reassigned afterward.

Always returned as null in this endpoint.

production_stepslistnullable

Production steps connected to this station.

A production step can be connected to at most one scanning station, so connecting a step here disconnects it from any other station. Manage the connections with Connect Production Steps to Scanning Station.

Always returned as null in this endpoint.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

machineslistExpandablenullable

Machines in this department.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

Relative URL that fetches the next page of results.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of machine

Resources in this page.

idstring

Machine ID.

objectstringenumValues:machine

Resource type identifier.

namestring

Display name of the machine.

Unique within the account.

serial_numberstring

Serial number of the machine.

notesstringnullable

Free-form notes about the machine.

departmentdepartmentnullable

The department this machine belongs to.

Set when the machine is created; a machine cannot be moved to another department afterwards.

Always returned as null in this endpoint.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

labor_rateratenullable

Hourly labor rate for work done in this department, such as a changeover technician.

Production scheduling costs changeovers with the constraint department's rate when one is set, falling back to the account-wide changeover labor rate setting.

idstring

Rate ID.

objectstringenumValues:rate

Resource type identifier.

valuestring (decimal)

Decimal value of the rate, as a string to preserve precision.

Expressed as the amount of the numerator unit per one denominator unit.

numerator_unitunitnullable

Unit of the rate's numerator (e.g. the currency of a price).

denominator_unitunitnullable

Unit of the rate's denominator (the per-unit basis, e.g. kilograms for a price per kilogram).

display_valuestring

Human-readable formatted value (e.g. "$25.50 / kg" or "100 kg / hr").

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last update timestamp.

Responses

200

Successful response for Retrieve Department

Retrieve Department

import Augno from '@augno/sdk';

const client = new Augno({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const department = await client.operations.departments.retrieve('dp_m0jayebxnkos');

console.log(department.id);

import Augno from '@augno/sdk';

const client = new Augno({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const department = await client.operations.departments.retrieve('dp_m0jayebxnkos');

console.log(department.id);

200 example

{
  "id": "dp_m0jayebxnkos",
  "object": "department",
  "name": "Fabrication",
  "notes": null,
  "location": {
    "id": "lc_yonnys0hx3ju",
    "object": "location",
    "name": "Warehouse A",
    "type": null,
    "parent": null,
    "children": null,
    "created_at": "2026-05-10T00:00:00Z",
    "updated_at": "2026-05-10T00:23:00Z"
  },
  "scanning_stations": {
    "object": "list",
    "page_info": {
      "next_page_url": null,
      "previous_page_url": null,
      "has_next_page": false,
      "has_prev_page": false
    },
    "data": [
      {
        "id": "scst_t71bn7lq5yov",
        "object": "scanning_station",
        "name": "Packaging Line 1",
        "notes": "Initializes batches at the start of the packaging line.",
        "type": "init_batch",
        "label_size": "2x4",
        "label_type": "traveler",
        "operator_requirement": "none",
        "department": null,
        "production_steps": null,
        "created_at": "2026-05-10T00:00:00Z",
        "updated_at": "2026-05-10T00:23:00Z"
      }
    ]
  },
  "machines": {
    "object": "list",
    "page_info": {
      "next_page_url": null,
      "previous_page_url": null,
      "has_next_page": false,
      "has_prev_page": false
    },
    "data": [
      {
        "id": "mc_ffcfk9dxixis",
        "object": "machine",
        "name": "CNC Router",
        "serial_number": "SN-2024-0001",
        "notes": "Spindle rebuilt March 2026; torque calibration due quarterly.",
        "department": null,
        "created_at": "2026-05-10T00:00:00Z",
        "updated_at": "2026-05-10T00:23:00Z"
      }
    ]
  },
  "labor_rate": null,
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

{
  "id": "dp_m0jayebxnkos",
  "object": "department",
  "name": "Fabrication",
  "notes": null,
  "location": {
    "id": "lc_yonnys0hx3ju",
    "object": "location",
    "name": "Warehouse A",
    "type": null,
    "parent": null,
    "children": null,
    "created_at": "2026-05-10T00:00:00Z",
    "updated_at": "2026-05-10T00:23:00Z"
  },
  "scanning_stations": {
    "object": "list",
    "page_info": {
      "next_page_url": null,
      "previous_page_url": null,
      "has_next_page": false,
      "has_prev_page": false
    },
    "data": [
      {
        "id": "scst_t71bn7lq5yov",
        "object": "scanning_station",
        "name": "Packaging Line 1",
        "notes": "Initializes batches at the start of the packaging line.",
        "type": "init_batch",
        "label_size": "2x4",
        "label_type": "traveler",
        "operator_requirement": "none",
        "department": null,
        "production_steps": null,
        "created_at": "2026-05-10T00:00:00Z",
        "updated_at": "2026-05-10T00:23:00Z"
      }
    ]
  },
  "machines": {
    "object": "list",
    "page_info": {
      "next_page_url": null,
      "previous_page_url": null,
      "has_next_page": false,
      "has_prev_page": false
    },
    "data": [
      {
        "id": "mc_ffcfk9dxixis",
        "object": "machine",
        "name": "CNC Router",
        "serial_number": "SN-2024-0001",
        "notes": "Spindle rebuilt March 2026; torque calibration due quarterly.",
        "department": null,
        "created_at": "2026-05-10T00:00:00Z",
        "updated_at": "2026-05-10T00:23:00Z"
      }
    ]
  },
  "labor_rate": null,
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

Retrieve Department

Authorization

Path Parameters

Query Parameters

Returns

Responses