Sign in

v1

latestOpenAPI 3.0.32026-08-061874701.5 MB
workspaces

List workspace children

Retrieves a paginated list of immediate child resources within a specified workspace.

Key Characteristics

  • Shallow representation: It returns metadata for the direct children only, rather than the full content or nested sub-structures.
  • Filtered by type: The results are restricted to the resource types defined in the childrenResourceTypes query parameter.
  • Paginated: The response provides a page of results, implying that for large workspaces, multiple requests may be necessary to view all children.

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

get/workspaces/{workspaceId}/children

Query parameters

childrenResourceTypes'sheets' | 'reports' | 'sights' | 'folders' | 'templates'

A comma-separated list of the child types to include in the response. When templates is included, you must also include sheets in childrenResourceTypes since templates are sheet templates.

include'source' | 'ownerInfo'

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

  • source - adds the Source object indicating which object this resource was created from, if any
  • ownerInfo Returns the user with owner permissions, or the user with admin permissions if there is no owner assigned. If no owner or admins are assigned, the Plan Asset Admin is returned. If no Plan Asset Admin is assigned, the System Admin is returned. If no owner or admins are available, no owner info data is returned.
numericDatesboolean

You can optionally choose to receive and send dates/times in numeric format, as milliseconds since the UNIX epoch (midnight on January 1, 1970 in UTC time), using the query string parameter numericDates with a value of true. This query parameter works for any API request.

accessApiLevelnumber

Allows COMMENTER access for inputs and return values. For backwards-compatibility, VIEWER is the default. For example, to see whether a user has COMMENTER access for a sheet, use accessApiLevel=1.

lastKeystring
Example:abcDefGhIjKlMnOpQrStUvWxYz

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

maxItemsinteger

The maximum number of items to return in the response.

Response

An array of asset references with a pagination token if there are more results.

lastKeystring

A token that is used to retrieve the next page of results when passed as the lastKey query parameter. This value will be absent when there are no further pages.

Example response

{
  "lastKey": "abcDefGhIjKlMnOpQrStUvWxYz"
}