Get Doc

Get Doc returns information about a chosen Doc. Pass content_format=markdown (default) or content_format=html to include content in the response.

get/api/v4/{workspace-slug}/documents/{doc-public-id}

Request

  • Base URL: https://api.app.shortcut.com
  • URL: https://api.app.shortcut.com/api/v4/{workspace-slug}/documents/{doc-public-id}
  • Auth: HTTP bearer

Path parameters

workspace-slugstring required

The slug for the Workspace.

doc-public-idstring uuid required

The ID of the Doc.

Query parameters

fieldsstring

Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.

Response

Resource

$schemastring required

The URI for the json-schema for this response.

Changes

No recorded changes to this operation across all 1 revision of this API.