GET/projects/api/v3/customitems/{customItemId}.json

Get a custom item by id.

This returns all details about an individual custom item.

Path Params

  • Name
    customItemId
    Type
    integer
    required
    Description

Query Params

  • Name
    updatedAfter
    Type
    string
    Description

    filter by custom items updated after specified date

  • Name
    orderMode
    Type
    string
    Description

    sort order

    Allowed values
    • asc
    • desc
  • Name
    orderBy
    Type
    string
    Description

    sort by

    Allowed values
    • name
  • Name
    pageSize
    Type
    integer
    Description

    number of items in a page

    Default
    50
  • Name
    page
    Type
    integer
    Description

    page number

    Default
    1
  • Name
    skipCounts
    Type
    boolean
    Description

    SkipCounts allows you to skip doing counts on a list API endpoint for performance reasons.

  • Name
    showDeleted
    Type
    boolean
    Description

    include deleted items

    Default
    false
  • Name
    includeArchivedProjects
    Type
    boolean
    Description

    include archived projects

  • Name
    projectIds
    Type
    array[integer]
    Description

    filter by project ids

    Format
    Comma separated values
  • Name
    include
    Type
    array[string]
    Description

    include

    Format
    Comma separated values
    Allowed values
    • createdBy
    • updatedBy
    • deletedBy
    • customItemViews
    • customItemFields
  • Name
    ids
    Type
    array[integer]
    Description

    filter by specific ids

    Format
    Comma separated values
  • Name
    fields[users]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • firstName
    • lastName
    • title
    • email
    • companyId
    • company
    • isAdmin
    • isClientUser
    • isServiceAccount
    • type
    • deleted
    • avatarUrl
    • lengthOfDay
    • workingHoursId
    • workingHour
    • userRate
    • userCost
    • canAddProjects
  • Name
    fields[customItems]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • displayName
    • labelSingular
    • labelPlural
    • state
    • relations
    • fields
    • views
    • sections
    • createdBy
    • createdAt
    • updatedBy
    • updatedAt
    • deletedBy
    • deletedAt
  • Name
    fields[customItemViews]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • customItemId
    • viewTypeId
    • displayName
    • state
    • displayOrder
    • configuration
    • createdBy
    • createdAt
    • updatedBy
    • updatedAt
    • deletedBy
    • deletedAt
  • Name
    fields[customItemFields]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • customItemId
    • displayName
    • type
    • definition
    • twType
    • twId
    • state
    • displayOrder
    • options
    • createdBy
    • createdAt
    • updatedBy
    • updatedAt
    • deletedBy
    • deletedAt

Responses

  • Code
    200
    Type
    object
    Schema
    Description
    200 OK
    Response contains information about a specific customitem.
  • Code
    400
    Type
    object
    Schema
    Description
    400 Bad Request
    ErrorResponse defines how []Error should be marshaled to JSON.

Examples

200 OK

Response
{
  "customItem": {
    "createdAt": "string",
    "createdBy": {
      "id": 0,
      "meta": {},
      "type": "string"
    },
    "deletedAt": "string",
    "deletedBy": {
      "id": 0,
      "meta": {},
      "type": "string"
    },
    "displayName": "string",
    "fields": [
      {
        "id": 0,
        "meta": {},
        "type": "string"
      }
    ],
    "id": 0,
    "labelPlural": "string",
    "labelSingular": "string",
    "relations": [
      {
        "id": 0,
        "meta": {},
        "type": "string"
      }
    ],
    "sections": [
      {
        "id": 0,
        "meta": {},
        "type": "string"
      }
    ],
    "state": "string",
    "updatedAt": "string",
    "updatedBy": {
      "id": 0,
      "meta": {},
      "type": "string"
    },
    "views": [
      {
        "id": 0,
        "meta": {},
        "type": "string"
      }
    ]
  },
  "included": {
    "customItemFields": {
      "additionalProp": {
        "createdAt": "string",
        "createdBy": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "customItem": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "definition": "string",
        "deletedAt": "string",
        "deletedBy": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "displayName": "string",
        "displayOrder": 0,
        "id": 0,
        "options": [
          {
            "color": "string",
            "displayOrder": 0,
            "id": 0,
            "isDefault": true,
            "label": "string",
            "twId": "string"
          }
        ],
        "state": "string",
        "twId": "string",
        "twType": "string",
        "type": "string",
        "updatedAt": "string",
        "updatedBy": {
          "id": 0,
          "meta": {},
          "type": "string"
        }
      }
    },
    "customItemViews": {
      "additionalProp": {
        "configuration": "string",
        "createdAt": "string",
        "createdBy": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "customItem": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "deletedAt": "string",
        "deletedBy": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "displayName": "string",
        "displayOrder": 0,
        "id": 0,
        "state": "string",
        "updatedAt": "string",
        "updatedBy": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "viewTypeId": 0
      }
    },
    "users": {
      "additionalProp": {
        "avatarUrl": "string",
        "canAccessPortfolio": true,
        "canAddProjects": true,
        "canManagePortfolio": true,
        "company": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "companyId": 0,
        "companyRoleId": 0,
        "createdAt": "string",
        "createdBy": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "deleted": true,
        "email": "string",
        "firstName": "string",
        "id": 0,
        "isAdmin": true,
        "isClientUser": true,
        "isPlaceholderResource": true,
        "isServiceAccount": true,
        "jobRoles": [
          {
            "id": 0,
            "meta": {},
            "type": "string"
          }
        ],
        "lastLogin": "string",
        "lastName": "string",
        "lengthOfDay": 0,
        "meta": {},
        "skills": [
          {
            "id": 0,
            "meta": {},
            "type": "string"
          }
        ],
        "teams": [
          {
            "id": 0,
            "meta": {},
            "type": "string"
          }
        ],
        "timezone": "string",
        "title": "string",
        "type": "string",
        "updatedAt": "string",
        "updatedBy": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "userCost": 0,
        "userRate": 0,
        "userRates": {
          "additionalProp": {
            "amount": 0,
            "currency": {
              "id": 0,
              "meta": {},
              "type": "string"
            }
          }
        },
        "workingHour": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "workingHoursId": 0
      }
    }
  }
}
Download Swagger