SMsmartsheet
reports

List report columns

Lists the columns for the specified report.

Note: For pagination guidance, refer to Token-based pagination.

get/reports/{reportId}/columns

Request

  • Base URL
    https://api.smartsheet.com/2.0
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://app.smartsheet.com/b/authorize
      Token URL: https://api.smartsheet.com/2.0/token scopes: READ_SHEETS

Query parameters

lastKeystring
Example:abcDefGhIjKlMnOpQrStUvWxYz

The lastKey token returned from the previous page of results. If not specified, the first page of results is returned.

maxItemsinteger
Example:100

Request query parameter used in endpoints that support token based pagination.

The maximum amount of items to return in the response. The default and minimum are 100.

levelinteger

specifies whether new functionality, such as multi-contact data is returned in a backwards-compatible, text format (level=0, default), multi-contact data (level=1), or multi-picklist data (level=3).

Response

A paginated list of report column objects.

lastKeystring

The ID of the last item returned in the set. Use as lastKey (query parameter) in the request for the next page.

Example response

{
  "lastKey": "48569348493401200",
  "data": [
    {
      "type": "PICKLIST",
      "systemColumnType": "CREATED_BY",
      "autoNumberFormat": {
        "fill": "",
        "prefix": "",
        "startingNumber": 1,
        "suffix": ""
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 16 revisions of this API.