SMsmartsheet
users

List user plans

Changed on

List plans to which the user belongs.

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

get/users/{userId}/plans

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: ADMIN_USERS

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.

displayContributorSeatTypeboolean
Example:true

When true, displays seatType as CONTRIBUTOR for all free-tier plans the user belongs to.

include'planName'
Example:planName

A comma-separated list of optional enrichments to include in the response:

  • planName — populates each plan's planName with the name of the organization that owns the plan.

Note: An unrecognized value, or the same value more than once, returns a 400 error.

Response

Returns result object.

Note: For pagination guidance, refer to Pagination.

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": [
    {
      "planId": 4843937635559300,
      "seatType": "MEMBER",
      "seatTypeLastChangedAt": "2025-06-14T09:55:30Z",
      "isInternal": true,
      "provisionalExpirationDate": "2025-06-14T09:55:30Z",
      "planName": "Acme Corporation"
    }
  ]
}

Changes

  • 5dedc4bd492cRevision changes
    • info

      added the new optional query request parameter include

    • info

      added the optional property /// to the response with the status