GET /objecttype/{id}/attributes

Changed on Sep 29, 2026

Find all attributes for this object type

get/objecttype/{id}/attributes

Request

Base URL
https://api.atlassian.com/ex/jira/{cloudId}/jsm/assets/workspace/workspaceId/v1
URL
https://api.atlassian.com/ex/jira/{cloudId}/jsm/assets/workspace/workspaceId/v1/objecttype/{id}/attributes
Auth
- OAuth 2
  Authorization code: https://auth.atlassian.com/authorize
  Token URL: https://auth.atlassian.com/oauth/token scopes: read:cmdb-attribute:jira
- or HTTP bearer

Query parameters

onlyValueEditableboolean

orderByNameboolean

querystring

A comma-separated list of case-insensitive prefixes; an attribute is included when its name or display name starts with any value

includeValuesExistboolean

excludeParentAttributesboolean

includeChildrenboolean

orderByRequiredboolean

Response

workspaceIdstring required

globalIdstring required

idstring required

namestring

displayNamestring

labelboolean required

typeinteger

Value	Description
0	Default
1	Object reference
2	User
4	Group
7	Status

descriptionstring

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

typeValuestring

typeValueMultistring[]

additionalValuestring

referenceObjectTypeIdstring

editableboolean

systemboolean

indexedboolean 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.

sortableboolean

summableboolean

minimumCardinalityinteger

maximumCardinalityinteger

suffixstring

removableboolean

objectAttributeExistsboolean

hiddenboolean

includeChildObjectTypesboolean

uniqueAttributeboolean

regexValidationstring

iqlstring

Deprecated. Use qlQuery instead.

qlQuerystring

optionsstring

positioninteger required

Example response

[
  {
    "workspaceId": "g2778e1d-939d-581d-c8e2-9d5g59de456b",
    "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:134",
    "id": "134",
    "objectType": {
      "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a",
      "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:23",
      "id": "23",
      "name": "Office",
      "displayName": "Office",
      "type": 0,
      "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin nec ex.",
      "icon": {
        "id": "13",
        "name": "Building",
        "url16": "https://api.atlassian.com/ex/jira/{cloudId}/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/23/icon.png?size=16",
        "url48": "https://api.atlassian.com/ex/jira/{cloudId}/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/23/icon.png?size=48"
      },
      "position": 2,
      "created": "2021-02-16T19:36:51.951Z",
      "updated": "2021-04-16T15:17:03.384Z",
      "objectCount": 0,
      "objectSchemaId": "6",
      "inherited": false,
      "abstractObjectType": false,
      "parentObjectTypeInherited": false
    },
    "name": "Key",
    "displayName": "Key",
    "label": false,
    "defaultType": {
      "id": 0,
      "name": "Text"
    },
    "editable": false,
    "system": true,
    "sortable": true,
    "summable": false,
    "indexed": true,
    "minimumCardinality": 1,
    "maximumCardinality": 1,
    "removable": false,
    "hidden": false,
    "includeChildObjectTypes": false,
    "uniqueAttribute": false,
    "options": "",
    "position": 0
  },
  {
    "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a",
    "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:135",
    "id": "135",
    "objectType": {
      "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a",
      "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:23",
      "id": "23",
      "name": "Office",
      "displayName": "Office",
      "type": 0,
      "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin nec ex.",
      "icon": {
        "id": "13",
        "name": "Building",
        "url16": "https://api.atlassian.com/ex/jira/{cloudId}/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/23/icon.png?size=16",
        "url48": "https://api.atlassian.com/ex/jira/{cloudId}/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/23/icon.png?size=48"
      },
      "position": 2,
      "created": "2021-02-16T19:36:51.951Z",
      "updated": "2021-04-16T15:17:03.384Z",
      "objectCount": 0,
      "objectSchemaId": "6",
      "inherited": false,
      "abstractObjectType": false,
      "parentObjectTypeInherited": false
    },
    "name": "Name",
    "displayName": "Name",
    "label": true,
    "description": "The name of the object",
    "defaultType": {
      "id": 0,
      "name": "Text"
    },
    "editable": true,
    "system": false,
    "sortable": true,
    "summable": false,
    "indexed": true,
    "minimumCardinality": 1,
    "maximumCardinality": 1,
    "suffix": "",
    "removable": false,
    "hidden": false,
    "includeChildObjectTypes": false,
    "uniqueAttribute": true,
    "regexValidation": "",
    "options": "",
    "position": 1
  },
  {
    "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a",
    "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:136",
    "id": "136",
    "objectType": {
      "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a",
      "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:23",
      "id": "23",
      "name": "Office",
      "displayName": "Office",
      "type": 0,
      "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin nec ex.",
      "icon": {
        "id": "13",
        "name": "Building",
        "url16": "https://api.atlassian.com/ex/jira/{cloudId}/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/23/icon.png?size=16",
        "url48": "https://api.atlassian.com/ex/jira/{cloudId}/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/23/icon.png?size=48"
      },
      "position": 2,
      "created": "2021-02-16T19:36:51.951Z",
      "updated": "2021-04-16T15:17:03.384Z",
      "objectCount": 0,
      "objectSchemaId": "6",
      "inherited": false,
      "abstractObjectType": false,
      "parentObjectTypeInherited": false
    },
    "name": "Created",
    "displayName": "Created",
    "label": false,
    "defaultType": {
      "id": 6,
      "name": "DateTime"
    },
    "editable": false,
    "system": true,
    "sortable": true,
    "summable": false,
    "indexed": true,
    "minimumCardinality": 1,
    "maximumCardinality": 1,
    "removable": false,
    "hidden": false,
    "includeChildObjectTypes": false,
    "uniqueAttribute": false,
    "options": "",
    "position": 2
  },
  {
    "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a",
    "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:137",
    "id": "137",
    "objectType": {
      "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a",
      "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:23",
      "id": "23",
      "name": "Office",
      "displayName": "Office",
      "type": 0,
      "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin nec ex.",
      "icon": {
        "id": "13",
        "name": "Building",
        "url16": "https://api.atlassian.com/ex/jira/{cloudId}/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/23/icon.png?size=16",
        "url48": "https://api.atlassian.com/ex/jira/{cloudId}/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/23/icon.png?size=48"
      },
      "position": 2,
      "created": "2021-02-16T19:36:51.951Z",
      "updated": "2021-04-16T15:17:03.384Z",
      "objectCount": 0,
      "objectSchemaId": "6",
      "inherited": false,
      "abstractObjectType": false,
      "parentObjectTypeInherited": false
    },
    "name": "Updated",
    "displayName": "Updated",
    "label": false,
    "defaultType": {
      "id": 6,
      "name": "DateTime"
    },
    "editable": false,
    "system": true,
    "sortable": true,
    "summable": false,
    "indexed": true,
    "minimumCardinality": 1,
    "maximumCardinality": 1,
    "removable": false,
    "hidden": false,
    "includeChildObjectTypes": false,
    "uniqueAttribute": false,
    "options": "",
    "position": 3
  },
  {
    "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a",
    "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:144",
    "id": "144",
    "objectType": {
      "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a",
      "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:23",
      "id": "23",
      "name": "Office",
      "displayName": "Office",
      "type": 0,
      "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin nec ex.",
      "icon": {
        "id": "13",
        "name": "Building",
        "url16": "https://api.atlassian.com/ex/jira/{cloudId}/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/23/icon.png?size=16",
        "url48": "https://api.atlassian.com/ex/jira/{cloudId}/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/23/icon.png?size=48"
      },
      "position": 2,
      "created": "2021-02-16T19:36:51.951Z",
      "updated": "2021-04-16T15:17:03.384Z",
      "objectCount": 0,
      "objectSchemaId": "6",
      "inherited": false,
      "abstractObjectType": false,
      "parentObjectTypeInherited": false
    },
    "name": "City",
    "displayName": "Office location",
    "label": false,
    "referenceType": {
      "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a",
      "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:4",
      "id": "4",
      "name": "Reference",
      "displayName": "Reference",
      "description": "Reference",
      "color": "49a6ed",
      "url16": "https://api.atlassian.com/ex/jira/{cloudId}/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/config/referencetype/4/image.png?size=16"
    },
    "referenceObjectTypeId": "24",
    "referenceObjectType": {
      "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a",
      "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:24",
      "id": "24",
      "name": "City",
      "displayName": "City",
      "type": 0,
      "icon": {
        "id": "28",
        "name": "Cottage",
        "url16": "https://api.atlassian.com/ex/jira/{cloudId}/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/24/icon.png?size=16",
        "url48": "https://api.atlassian.com/ex/jira/{cloudId}/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/24/icon.png?size=48"
      },
      "position": 3,
      "created": "2021-02-16T19:58:45.698Z",
      "updated": "2021-04-16T15:17:03.393Z",
      "objectCount": 0,
      "objectSchemaId": "6",
      "inherited": false,
      "abstractObjectType": false,
      "parentObjectTypeInherited": false
    },
    "editable": true,
    "system": false,
    "sortable": true,
    "summable": false,
    "indexed": true,
    "minimumCardinality": 0,
    "maximumCardinality": 1,
    "removable": true,
    "hidden": false,
    "includeChildObjectTypes": false,
    "uniqueAttribute": false,
    "options": "",
    "position": 4
  },
  {
    "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a",
    "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:265",
    "id": "265",
    "objectType": {
      "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a",
      "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:23",
      "id": "23",
      "name": "Office",
      "displayName": "Office",
      "type": 0,
      "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin nec ex.",
      "icon": {
        "id": "13",
        "name": "Building",
        "url16": "https://api.atlassian.com/ex/jira/{cloudId}/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/23/icon.png?size=16",
        "url48": "https://api.atlassian.com/ex/jira/{cloudId}/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/23/icon.png?size=48"
      },
      "position": 2,
      "created": "2021-02-16T19:36:51.951Z",
      "updated": "2021-04-16T15:17:03.384Z",
      "objectCount": 0,
      "objectSchemaId": "6",
      "inherited": false,
      "abstractObjectType": false,
      "parentObjectTypeInherited": false
    },
    "name": "Placeholder",
    "displayName": "Additional information",
    "label": false,
    "defaultType": {
      "id": 0,
      "name": "Text"
    },
    "editable": true,
    "system": false,
    "sortable": true,
    "summable": false,
    "indexed": true,
    "minimumCardinality": 0,
    "maximumCardinality": 1,
    "removable": true,
    "hidden": false,
    "includeChildObjectTypes": false,
    "uniqueAttribute": false,
    "options": "",
    "position": 5
  }
]

Changes

Sep 29, 202683fc72ce3b1e Revision changes
- breaking
  for the query request parameter query, default value was changed from "" to
- info
  added the optional property / to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status

Operation history

Request

Query parameters

Response 200OK

Example response

Changes

Response