---
title: "GET /iql/objects"
method: GET
path: "/iql/objects"
deprecated: true
---

# GET /iql/objects

`GET /iql/objects`

> **Deprecated.**

This endpoint is deprecated and will be removed on <b>18th of September 2024</b>. Please use POST `/object/aql` instead.

## Query parameters

- `iql` string
- `page` integer
- `resultPerPage` integer
- `includeAttributes` boolean
- `includeAttributesDeep` integer
- `includeTypeAttributes` boolean
- `includeExtendedInfo` boolean

## Response `200`

A object result set that can be used to paginate through the result list of objects

- ObjectListResult — A result list containing objects
  - `objectEntries` Object[], required — The actual objects
    - `workspaceId` string, required
    - `globalId` string, required
    - `id` string, required
    - `label` string, required — The name of the object. This value is fetched from the attribute that is currently marked as label for the object type of this object
    - `objectKey` string, required — The external identifier for this object
    - `avatar` Avatar, required — The object avatar is a custom image that represents an object. If the object has no avatar the icon for the object type will be used
      - `workspaceId` string, required
      - `globalId` string, required
      - `id` string
      - `avatarUUID` string
      - `url16` string, required
      - `url48` string, required
      - `url72` string, required
      - `url144` string, required
      - `url288` string, required
      - `objectId` string, required — A reference to the object that this avatar is associated with
    - `objectType` ObjectType, required — The Assets object type
      - `workspaceId` string, required
      - `globalId` string, required
      - `id` string, required
      - `name` string, required
      - `description` string
      - `icon` Icon, required — A visual representation of something, usually associated as the icon of an object type
        - `id` string, required
        - `name` string, required
        - `url16` string, required — A url to the icon to display with small resolution
        - `url48` string, required — A url to the icon to display with large resolution
      - `position` integer, required
      - `created` string, date-time, required
      - `updated` string, date-time, required
      - `objectCount` integer, required
      - `parentObjectTypeId` integer — The id of the parent object type
      - `type` integer — The type of the attribute
      - `objectSchemaId` string, required
      - `inherited` boolean, required — Describes if this object type is configured for inheritance i.e. it's children inherits the attributes of this object type
      - `abstractObjectType` boolean, required
      - `parentObjectTypeInherited` boolean, required — Describes if this object types parent is inherited i.e. this object type has attributes that are inherited from one or more parents
    - `created` string, date-time, required
    - `updated` string, date-time, required
    - `hasAvatar` boolean, required
    - `timestamp` number, required
    - `attributes` ObjectAttribute[]
      - `workspaceId` string, required
      - `globalId` string, required
      - `id` string, required
      - `objectTypeAttribute` ObjectTypeAttribute — The definition of the attribute that is associated with an object type
        - `workspaceId` string, required
        - `globalId` string, required
        - `id` string, required
        - `objectType` ObjectType — The Assets object type
          - `workspaceId` string, required
          - `globalId` string, required
          - `id` string, required
          - `name` string, required
          - `description` string
          - `icon` Icon, required — A visual representation of something, usually associated as the icon of an object type
            - `id` string, required
            - `name` string, required
            - `url16` string, required — A url to the icon to display with small resolution
            - `url48` string, required — A url to the icon to display with large resolution
          - `position` integer, required
          - `created` string, date-time, required
          - `updated` string, date-time, required
          - `objectCount` integer, required
          - `parentObjectTypeId` integer — The id of the parent object type
          - `type` integer — The type of the attribute
          - `objectSchemaId` string, required
          - `inherited` boolean, required — Describes if this object type is configured for inheritance i.e. it's children inherits the attributes of this object type
          - `abstractObjectType` boolean, required
          - `parentObjectTypeInherited` boolean, required — Describes if this object types parent is inherited i.e. this object type has attributes that are inherited from one or more parents
        - `name` string
        - `label` boolean, required
        - `type` integer — | Value | Description| | ----- | ----------- | | 0 | Default| | 1 | Object reference| | 2 | User| | 4 | Group | | 7 | Status |
        - `description` string
        - `defaultType` DefaultType — | Id | Description | | -- | ----------- | | -1 | None | | 0 | Text | | 1 | Integer | | 2 | Boolean | | 3 | Double | | 4 | Date | | 5 | Time | | 6 | DateTime | | 7 | Url | | 8 | Email | | 9 | Textarea | | 10 | Select | | 11 | IP Address |
          - `id` integer, required
          - `name` string, required
        - `typeValue` string
        - `typeValueMulti` string[]
        - `additionalValue` string
        - `referenceType` ReferenceType
          - `workspaceId` string, required
          - `globalId` string, required
          - `id` string
          - `name` string, required
          - `description` string
          - `color` string
          - `url16` string
          - `removable` boolean
          - `objectSchemaId` string
          - `cdmData` ReferenceTypeCdmData
            - `types` ReferenceTypeCdmType[]
              - …
        - `referenceObjectTypeId` string
        - `referenceObjectType` ObjectType — The Assets object type
          - `workspaceId` string, required
          - `globalId` string, required
          - `id` string, required
          - `name` string, required
          - `description` string
          - `icon` Icon, required — A visual representation of something, usually associated as the icon of an object type
            - `id` string, required
            - `name` string, required
            - `url16` string, required — A url to the icon to display with small resolution
            - `url48` string, required — A url to the icon to display with large resolution
          - `position` integer, required
          - `created` string, date-time, required
          - `updated` string, date-time, required
          - `objectCount` integer, required
          - `parentObjectTypeId` integer — The id of the parent object type
          - `type` integer — The type of the attribute
          - `objectSchemaId` string, required
          - `inherited` boolean, required — Describes if this object type is configured for inheritance i.e. it's children inherits the attributes of this object type
          - `abstractObjectType` boolean, required
          - `parentObjectTypeInherited` boolean, required — Describes if this object types parent is inherited i.e. this object type has attributes that are inherited from one or more parents
        - `editable` boolean
        - `system` boolean
        - `indexed` boolean, required — Describes if this object type attribute is indexed. For an indexed attribute the AQL search will be faster, but this will affect memory consumption.
        - `sortable` boolean
        - `summable` boolean
        - `minimumCardinality` integer
        - `maximumCardinality` integer
        - `suffix` string
        - `removable` boolean
        - `objectAttributeExists` boolean
        - `hidden` boolean
        - `includeChildObjectTypes` boolean
        - `uniqueAttribute` boolean
        - `regexValidation` string
        - `iql` string — Deprecated. Use `qlQuery` instead.
        - `qlQuery` string
        - `options` string
        - `position` integer, required
      - `objectTypeAttributeId` string, required
      - `objectAttributeValues` ObjectAttributeValue[], required — The actual values of the object attribute. The size of the values array is determined by the cardinality constraints on the object type attribute as well as how many values are associated with the object attribute
        - `value` union
          - string
          - string, date-time
        - `displayValue` string, required — The value as displayable text e.g. for a date time attribute this value will be formatted to the user settings
        - `searchValue` string — A value to use when searching for the specific object
        - `referencedObject` object — The same response body as an Assets object
        - `user` User — The Assets user type
          - `avatarUrl` string
          - `displayName` string
          - `name` string
          - `key` string
          - `emailAddress` string
          - `html` string
          - `renderedLink` string
          - `isDeleted` boolean
          - `lastSeenVersion` string
          - `self` string
        - `group` Group — The Assets Group type
          - `avatarUrl` string, required
          - `name` string, required
        - `status` Status — An Assets status type that can be associated with objects
          - `id` string, required
          - `name` string, required
          - `description` string
          - `category` integer, required — | Name | Value | Color | | ---- | ----- | ----- | | ACTIVE | 1 | Green | | INACTIVE | 0 | Red | | PENDING | 2 | Yellow |
          - `objectSchemaId` string
        - `additionalValue` string
    - `_links` object, required
      - `self` string, required
  - `objectTypeAttributes` ObjectTypeAttribute[] — The object type attributes that are present in the object entries
    - `workspaceId` string, required
    - `globalId` string, required
    - `id` string, required
    - `objectType` ObjectType — The Assets object type
      - `workspaceId` string, required
      - `globalId` string, required
      - `id` string, required
      - `name` string, required
      - `description` string
      - `icon` Icon, required — A visual representation of something, usually associated as the icon of an object type
        - `id` string, required
        - `name` string, required
        - `url16` string, required — A url to the icon to display with small resolution
        - `url48` string, required — A url to the icon to display with large resolution
      - `position` integer, required
      - `created` string, date-time, required
      - `updated` string, date-time, required
      - `objectCount` integer, required
      - `parentObjectTypeId` integer — The id of the parent object type
      - `type` integer — The type of the attribute
      - `objectSchemaId` string, required
      - `inherited` boolean, required — Describes if this object type is configured for inheritance i.e. it's children inherits the attributes of this object type
      - `abstractObjectType` boolean, required
      - `parentObjectTypeInherited` boolean, required — Describes if this object types parent is inherited i.e. this object type has attributes that are inherited from one or more parents
    - `name` string
    - `label` boolean, required
    - `type` integer — | Value | Description| | ----- | ----------- | | 0 | Default| | 1 | Object reference| | 2 | User| | 4 | Group | | 7 | Status |
    - `description` string
    - `defaultType` DefaultType — | Id | Description | | -- | ----------- | | -1 | None | | 0 | Text | | 1 | Integer | | 2 | Boolean | | 3 | Double | | 4 | Date | | 5 | Time | | 6 | DateTime | | 7 | Url | | 8 | Email | | 9 | Textarea | | 10 | Select | | 11 | IP Address |
      - `id` integer, required
      - `name` string, required
    - `typeValue` string
    - `typeValueMulti` string[]
    - `additionalValue` string
    - `referenceType` ReferenceType
      - `workspaceId` string, required
      - `globalId` string, required
      - `id` string
      - `name` string, required
      - `description` string
      - `color` string
      - `url16` string
      - `removable` boolean
      - `objectSchemaId` string
      - `cdmData` ReferenceTypeCdmData
        - `types` ReferenceTypeCdmType[]
          - `key` string
          - `version` integer
          - `opinionated` boolean
    - `referenceObjectTypeId` string
    - `referenceObjectType` ObjectType — The Assets object type
      - `workspaceId` string, required
      - `globalId` string, required
      - `id` string, required
      - `name` string, required
      - `description` string
      - `icon` Icon, required — A visual representation of something, usually associated as the icon of an object type
        - `id` string, required
        - `name` string, required
        - `url16` string, required — A url to the icon to display with small resolution
        - `url48` string, required — A url to the icon to display with large resolution
      - `position` integer, required
      - `created` string, date-time, required
      - `updated` string, date-time, required
      - `objectCount` integer, required
      - `parentObjectTypeId` integer — The id of the parent object type
      - `type` integer — The type of the attribute
      - `objectSchemaId` string, required
      - `inherited` boolean, required — Describes if this object type is configured for inheritance i.e. it's children inherits the attributes of this object type
      - `abstractObjectType` boolean, required
      - `parentObjectTypeInherited` boolean, required — Describes if this object types parent is inherited i.e. this object type has attributes that are inherited from one or more parents
    - `editable` boolean
    - `system` boolean
    - `indexed` boolean, required — Describes if this object type attribute is indexed. For an indexed attribute the AQL search will be faster, but this will affect memory consumption.
    - `sortable` boolean
    - `summable` boolean
    - `minimumCardinality` integer
    - `maximumCardinality` integer
    - `suffix` string
    - `removable` boolean
    - `objectAttributeExists` boolean
    - `hidden` boolean
    - `includeChildObjectTypes` boolean
    - `uniqueAttribute` boolean
    - `regexValidation` string
    - `iql` string — Deprecated. Use `qlQuery` instead.
    - `qlQuery` string
    - `options` string
    - `position` integer, required
  - `objectTypeId` string — Deprecated field that shows which object type id the result is for. Not applicable when using AQL
  - `objectTypeIsInherited` boolean — Deprecated field should not be used.
  - `abstractObjectType` boolean — Deprecated field should not be used.
  - `totalFilterCount` integer — Deprecated from <b>30 September 2024</b> please use POST /object/totalcount instead. The total amount of objects that was matched in the search query. This number may be greater than the amount of objects currently shown
  - `startIndex` integer, required — The offset of the first object in the search query that is present in the result, used for pagination
  - `toIndex` integer, required — The index of the last object present in the result of the search query
  - `pageObjectSize` integer, required — The amount of objects currently returned per page in the result set
  - `pageNumber` integer, required — The current page of objects in the result set pagination
  - `orderByTypeAttrId` integer — Deprecated field - The object type attribute id used for sorting
  - `orderWay` string — Deprecated field - The sort order, used in conjunction with the orderByTypeAttrId
  - `filters` object — Deprecated field - The field is used for basic search
  - `qlQuery` string, required — The AQL that was used to find the object result set
  - `qlQuerySearchResult` boolean — Determines if the query was based on an AQL or by basic search
  - `iql` string, required — Deprecated, use `qlQuery` instead
  - `iqlSearchResult` boolean — Deprecated, use `qlQuerySearchResult` instead
  - `conversionPossible` boolean — Is it possible to transform this AQL to basic search or vice versa
  - `matchedFilterValues` object — Deprecated field should not be used
  - `inheritanceTree` object — Deprecated field should not be used

## Other responses

- `400` — The system cannot fulfill the request due to validation errors. See the response body for more details.
- `401` — Client must be authenticated to access this resource.
- `429` — The request has been rate limited by the system. Every API key is allowed to perform 500 requests per minute to this endpoint.
- `500` — Something went wrong. Please try again later. If the error persists, contact our support team.

---

[API](https://skmtc.net/atlassian/apis/rest.md) · [All operations](https://skmtc.net/atlassian/apis/rest/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/atlassian/rest/versions/07137e668210/schema)