---
title: "Search resource instances"
method: GET
path: "/lifecycle-manager/resources/{modelId}/instances"
tags: ["Lifecycle Manager"]
---

# Search resource instances

`GET /lifecycle-manager/resources/{modelId}/instances`

## Request

- Base URL: `https://example.itential.io`
- URL: `https://example.itential.io/lifecycle-manager/resources/{modelId}/instances`
- Auth: none declared

Searches resource instances.

## Path parameters

- `modelId` string, required: A MongoDB ObjectId

## Query parameters

- `skip` string
- `limit` string
- `sort` string
- `order` 'asc' | 'desc': This parameter specifies the direction to sort the search results over.
- `equals` LifecycleManagerResourcesModelIdInstancesGetParametersEquals
  - `modelName` string: The name of the resource model
  - `stateName` string: The name of the current state of the resource instance
  - `_id` unknown
  - `name` string: The name of the resource instance
  - `modelId` unknown
  - `created` unknown
  - `createdBy` unknown
  - `lastUpdated` unknown
  - `lastUpdatedBy` unknown
  - `instanceData` object: Custom data associated with the resource instance, stored as a nested object. To filter on a specific value inside it, use dot notation as the property name with equals, in, or starts-with. For example, use instanceData.region. Property names beginning with '$' are not supported.
  - `lastAction` object: Details about the most recently executed action on the resource instance, stored as a nested object. To filter on a specific value inside it, use dot notation as the property name with equals, in, or starts-with. For example, use lastAction.status. Property names beginning with '$' are not supported.
- `in` LifecycleManagerResourcesModelIdInstancesGetParametersIn: This parameter specifies a comma-delimited list of values to search for in the given field(s).
  - `lastAction` LifecycleManagerResourcesModelIdInstancesGetParametersInSchemaLastAction: Details about the most recently executed action on the resource instance, stored as a nested object. To filter on a specific value inside it, use dot notation as the property name with equals, in, or starts-with. For example, use lastAction.status. Property names beginning with '$' are not supported.
    - `type` LifecycleManagerResourcesModelIdInstancesGetParametersInSchemaLastActionTypeItems[]
  - `instanceData` object: Custom data associated with the resource instance, stored as a nested object. To filter on a specific value inside it, use dot notation as the property name with equals, in, or starts-with. For example, use instanceData.region. Property names beginning with '$' are not supported.
- `include-deleted` 'true' | 'false'
- `starts-with` LifecycleManagerResourcesModelIdInstancesGetParametersStartsWith
  - `name` string: The name of the resource instance
  - `instanceData` object: Custom data associated with the resource instance, stored as a nested object. To filter on a specific value inside it, use dot notation as the property name with equals, in, or starts-with. For example, use instanceData.region. Property names beginning with '$' are not supported.
  - `lastAction` object: Details about the most recently executed action on the resource instance, stored as a nested object. To filter on a specific value inside it, use dot notation as the property name with equals, in, or starts-with. For example, use lastAction.status. Property names beginning with '$' are not supported.
- `group` string
- `instanceGroups` 'true' | 'false'
- `lt` LifecycleManagerResourcesModelIdInstancesGetParametersLt
  - `created` unknown
  - `lastUpdated` unknown
- `lte` LifecycleManagerResourcesModelIdInstancesGetParametersLte
  - `created` unknown
  - `lastUpdated` unknown
- `gt` LifecycleManagerResourcesModelIdInstancesGetParametersGt
  - `created` unknown
  - `lastUpdated` unknown
- `gte` LifecycleManagerResourcesModelIdInstancesGetParametersGte
  - `created` unknown
  - `lastUpdated` unknown
- `include` LifecycleManagerResourcesModelIdInstancesGetParametersIncludeSchemaItems[]
- `exclude` LifecycleManagerResourcesModelIdInstancesGetParametersExcludeSchemaItems[]
- `dereference` unknown

## Response `200`

response

- LifecycleManagerGetResourceInstancesHttpResponse200
  - `data` LifecycleManagerResourceInstanceHttp[]
    - `_id` unknown, required
    - `name` string, required: The name of the resource instance
    - `description` string, required: Free-form text describing the resource instance
    - `modelId` unknown, required
    - `instanceData` LifecycleManagerResourceInstanceHttpInstanceData, required: The data for the resource instance
    - `lastAction` LifecycleManagerResourceInstanceHttpLastAction, required: The last action that was run on this instance
      - `_id` unknown, required
      - `executionId` unknown, required
      - `name` string, required: The name of the action
      - `type` 'import' | 'create' | 'update' | 'delete', required: The type of the action
      - `status` 'running' | 'error' | 'complete' | 'canceled' | 'paused', required: A single string describing the current activity status of this action
    - `created` unknown, required
    - `createdBy` unknown, required
    - `lastUpdated` unknown, required
    - `lastUpdatedBy` unknown, required
    - `instanceGroups` LifecycleManagerResourceInstanceHttpInstanceGroupsItems[]: The groups that this resource instance is a member of
      - `_id` string: A string which is formatted like an ObjectId, Distinct from an actual ObjectId.
      - `name` string: The name of the document
  - `metadata` LifecycleManagerCommonHttpPaginationMetadata: Properties describing search result pagination
    - `skip` integer
    - `limit` integer
    - `total` integer
    - `nextPageSkip` integer
    - `previousPageSkip` integer
    - `currentPageSize` integer

## Other responses

- `500`: Error response from API

## Changes

- **2026-10-31** `2095cc90e583`: 2 info
  - api tag `Lifecycle Manager` added
  - api tag `lifecycleManager` removed

[Operation history](https://skmtc.dev/itential/apis/itential-2/changes/lifecycle-manager/resources/:modelId/instances/get.md)

---

[API](https://skmtc.dev/itential/apis/itential-2.md) - [All operations](https://skmtc.dev/itential/apis/itential-2/llms.txt) - [OpenAPI document](https://skmtc.dev/itential/apis/itential-2/revisions/2095cc90e583?raw)