ISisometric

Project Documents

Changed on

A paginated list of all project documents for the given project.

Returned list of documents will be sorted alphabetically by document name.

get/projects/{id}/documents

Request

  • Base URL
    https://api.isometric.com/registry/v0
  • URL
    https://api.isometric.com/registry/v0/projects/{id}/documents
  • Auth
    HTTP bearer

Path parameters

idstring required
Example:prj_1CTWZQGKE1S0VAXA

Query parameters

lastinteger

An integer number of items to retrieve before the item represented by the cursor passed in the before parameter. Defaults to 10 with a maximum value of 50.

beforestring nullable

An opaque cursor representing the first item in the previously requested page to select items ordered before it. Submit the previously requested page’s start_cursor here when paginated backwards.

firstinteger

An integer number of items to retrieve after the item represented by the cursor passed in the after parameter. Defaults to 10 with a maximum value of 50.

afterstring nullable

An opaque cursor representing the last item in the previously requested page to select items ordered after it. Submit the previously requested page’s end_cursor here when paginated forwards.

Headers

x-client-secretstring required

A secret token identifying the client connecting to the API

Example:Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP

Response

Successful Response

total_countinteger required

Example response

{
  "nodes": [
    {
      "id": "pjd_1ESC3V76T1S0S6J3",
      "project_id": "prj_1CTWZQGKE1S0VAXA"
    }
  ]
}

Changes

  • 385518aba17dRevision changes
    • breaking

      for the path request parameter id, the minLength was increased from 0 to 20

    • warning

      for the path request parameter id, the maxLength was set to 37

    • info

      for the path request parameter id, the type was generalized from no type to string

  • f1623e0dc2e1Revision changes
    • info

      for the path request parameter id, the type was generalized from string to no type

    • info

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

    • info

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

    • info

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