List Location Types

Beta

GET/v1/operations/location-types

This endpoint is idempotent. Learn more

Returns a paginated list of location types.

Location types are platform-defined and the same for every account, so this list is the complete set of levels you can assign when creating a location. The q search term matches on location type name.

Permissions requiredValues:locations:read

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

cursoroptional string

Opaque cursor token identifying where the page of results starts.

Use the cursor value embedded in a previous response's next_page_url or previous_page_url to fetch the adjacent page. Omit to start from the first page.

limitoptional integer

Maximum number of results to return in a single page.

qoptional string

Free-text search term used to filter results.

Which fields are matched against the term varies by endpoint.

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 location_type

Resources in this page.

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 List Location Types

List Location Types

import OpenMRP from '@openmrp/sdk';

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

const listLocationType = await client.operations.locationTypes.list();

console.log(listLocationType.data);

import OpenMRP from '@openmrp/sdk';

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

const listLocationType = await client.operations.locationTypes.list();

console.log(listLocationType.data);

200 example

{
  "object": "list",
  "page_info": {
    "next_page_url": "/v1/operations/location-types?cursor=eyJjIjoiMjAyNi0wNS0xMFQwMDowMDowMFoiLCJzIjoibGNfcmEwOHNuZ2QwZnhyIiwiZCI6ImYifQ.MXBh7VXFvDf5DtvWwjNTmbkRYvbW_-WaJerAMqyu9qU",
    "previous_page_url": null,
    "has_next_page": true,
    "has_prev_page": false
  },
  "data": [
    {
      "id": "lc_ra08sngd0fxr",
      "object": "location_type",
      "code": "building",
      "name": "Building",
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    }
  ]
}

{
  "object": "list",
  "page_info": {
    "next_page_url": "/v1/operations/location-types?cursor=eyJjIjoiMjAyNi0wNS0xMFQwMDowMDowMFoiLCJzIjoibGNfcmEwOHNuZ2QwZnhyIiwiZCI6ImYifQ.MXBh7VXFvDf5DtvWwjNTmbkRYvbW_-WaJerAMqyu9qU",
    "previous_page_url": null,
    "has_next_page": true,
    "has_prev_page": false
  },
  "data": [
    {
      "id": "lc_ra08sngd0fxr",
      "object": "location_type",
      "code": "building",
      "name": "Building",
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    }
  ]
}

List Location Types

Authorization

Query Parameters

Returns

Responses