> For the complete documentation index, see [llms.txt](https://interfacing.gitbook.io/interfacing-help-files/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://interfacing.gitbook.io/interfacing-help-files/solutions-developers/api-and-information-repository/rest-apis/use-cases-and-examples/retrieve-a-list-of-objects.md). # Retrieve a List of Objects The `GET /list` endpoint retrieves a list of objects stored in IMS. It supports various use cases such as: * Duplicating IMS data to a third-party platform * Displaying an overview of IMS objects in an external system or dashboard * Building filterable widgets for internal portals *** ## Quick Start * **Base Endpoint URL:** * **Authentication**: Obtain a valid token (see [Authentication & Token Management](/interfacing-help-files/solutions-developers/api-and-information-repository/rest-apis.md#authentication-and-token-management)) * **Swagger Documentation**: *** ## Request Example ```bash curl --request GET --url 'http://myims.interfacing.com/api/v1/list/1450CEF9-89A3-4B48-98F7-09735BECD54B?draft=true' -b /tmp/cookie.tmp ``` *** ## Scenario & Response Example Suppose there are 3 objects in the database and you retrieve them using a page size of 2. The following response shows the first page of results, containing two of the three total objects (`pageSize: 2`, `currentPage: 1`). ```json "totalRecords": 3, "sortKey": "nodeId", "pageSize": 2, "currentPage": 1, "results": [ { "documentCount": 0, "parent": null, "relatedResourceCount": 0, "roleCount": 0, "nodeSubTypeName": null, "userNodeSubType": null, "@type": "ListElement", "nodeVersionId": "E25E7A35-EE18-4607-924C-C743BAB04E4E", "relatedAssetCount": 0, "publishedNodeVersionId": null, "orgUnitCount": 0, "responsibilities": { "informed": false, "accountable": false, "verifier": false, "responsible": false, "signatory": false, "consulted": false, "support": false }, "referenceNumber": null, "propertyValues": null, "assetCount": 0, "categories": null, "locked": false, "relatedRoleCount": 0, "relatedOrgUnitCount": 0, "locationListItemId": null, "productListItemId": null, "acronym": null, "hasDescription": false, "shortDescription": null, "nodeType": "TASK", "creationDate": "2022-06-15T12:11:37.470-04:00", "nodeStatus": "IN_PROGRESS", "version": "0.0002", "nodeSubType": null, "modificationDate": "2022-06-15T12:11:37.740-04:00", "extensions": null, "deleted": false, "system": false, "resourceCount": 0, "name": "Task 1", "lastModifiedByName": null, "nodeId": "3096BD45-BBA2-4745-B53C-0015A1A774C5", "favorite": false }, { "documentCount": 0, "parent": null, "relatedResourceCount": 0, "roleCount": 0, "nodeSubTypeName": null, "userNodeSubType": null, "@type": "ListElement", "nodeVersionId": "5AF78E44-15FA-48D9-9CCC-4B92E1997216", "relatedAssetCount": 0, "publishedNodeVersionId": "5AF78E44-15FA-48D9-9CCC-4B92E1997216", "orgUnitCount": 0, "responsibilities": { "informed": false, "accountable": false, "verifier": false, "responsible": false, "signatory": false, "consulted": false, "support": false }, "referenceNumber": null, "propertyValues": null, "assetCount": 0, "categories": null, "locked": false, "relatedRoleCount": 0, "relatedOrgUnitCount": 0, "locationListItemId": null, "productListItemId": null, "acronym": null, "hasDescription": false, "shortDescription": null, "nodeType": "DOCUMENT_SET", "creationDate": "2022-06-15T12:11:03.767-04:00", "nodeStatus": "PUBLISHED", "version": "1.0000", "nodeSubType": null, "modificationDate": "2022-06-15T12:11:03.837-04:00", "extensions": null, "deleted": false, "system": false, "resourceCount": 0, "name": "DOC_SET__PUBLISH2022-06-15T12:11:03.744", "lastModifiedByName": null, "nodeId": "FABBF176-2982-44CC-B3CC-00731C18BA22", "favorite": false } ], "order": "ASC" } ``` *** ## Retrieving Lists for Specific Object Types Beyond retrieving all objects, IMS allows you to fetch lists for individual object types. Use the table below to find the right endpoint and Swagger link. | Object Type | Swagger URL | Endpoint URL | | ----------------------------------------------------- | ------------------------------------------------------------------------------ | ----------------------------------------------------------------- | | Capability | | | | Collaboration | | | | Control | | | | Document | | | | Glossary | | | | Governance – Analysis | | | | Governance – Maturity | | | | Governance – Overview | | | | Master Data | | | | Organization | | | | Performance | | | | Process | | | | Risk | | | | Rule | | | *** ## What is this feature in IMS? Retrieving a list of objects through the API is similar to accessing the **Library** in IMS. The Library provides users with a structured list of all the objects they have permission to view, helping them navigate and manage content efficiently. This API endpoint offers a similar capability, but for external systems. It allows developers to fetch and work with IMS object lists programmatically, enabling integration with dashboards, portals, or third-party tools. > To learn more about the Library, [click here.](/interfacing-help-files/drafts/searching-for-objects-in-the-library/library.md) *** ## See Also
Authentication & Token ManagementREST APIsIMS-V16-NAV-Home-Icons-5.png
API Reference (Swagger)API Reference (Swagger)IMS-V16-NAV-Library-Icons-41.png
How to Perform Other Use CasesHow to Perform Other Use CasesIMS-V16-Intro-7.png
--- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://interfacing.gitbook.io/interfacing-help-files/solutions-developers/api-and-information-repository/rest-apis/use-cases-and-examples/retrieve-a-list-of-objects.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.