Retrieve Location Type

Beta

GET/v1/operations/location-types/{id}

This endpoint is idempotent. Learn more

Returns a location type by ID or code.

Permissions requiredValues:locations:read

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

idstring

Location type ID or code, such as building or bin.

idstring

Location type ID.

objectstringenumValues:location_type

Resource type identifier.

codeobject

The level of the storage hierarchy this type represents.

The levels run from largest to smallest: building, section, aisle, rack, shelf, bin.

namestring

Display name of the location type.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last-updated timestamp.

Responses

200

Successful response for Retrieve Location Type

Retrieve Location Type

import OpenMRP from '@openmrp/sdk';

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

const locationType = await client.operations.locationTypes.retrieve('lc_ra08sngd0fxr');

console.log(locationType.id);

import OpenMRP from '@openmrp/sdk';

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

const locationType = await client.operations.locationTypes.retrieve('lc_ra08sngd0fxr');

console.log(locationType.id);

200 example

{
  "id": "lc_ra08sngd0fxr",
  "object": "location_type",
  "code": "building",
  "name": "Building",
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

{
  "id": "lc_ra08sngd0fxr",
  "object": "location_type",
  "code": "building",
  "name": "Building",
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

Retrieve Location Type

Authorization

Path Parameters

Returns

Responses