v1

latestOpenAPI 3.0.12026-07-2464217456.8 KB
Space Documents

Get all space documents

get/1.0/space-documents

Query parameters

projectIdinteger required

You can use this param to specify some value as project id and the responses will contain exact matches of space documents that match the given value.

pageSizenumber
Example:100

This parameter sets the maximum number of responses to be displayed per page. If the page size is insufficient to accommodate the whole number of responses obtained, the pagination object will include a link to the next page as well as the next page token. If left blank, it defaults to 100.

pageTokenstring
Example:59c12a42-dd10-11ed-afa1-0242ac120002

Use this parameter to specify the pageToken of a page to which you want to navigate. This pageToken can be obtained from a previous request which specified a limit and will only be active for 15 minutes after it is created.

sortBy'spaceTabName'

You can use the sortBy param to sort the responses by the given field.

sortOrder'ASC' | 'DESC'

The sortOrder param can be used to specify the sorting order, which can be Ascending (ASC) or Descending (DESC). Descending is the default option.

match'all' | 'any'

You can use the match param to specify if we need to filter the entries using either AND(all) / OR(any). Defaults to AND.

spaceDocumentName.eqstring
Example:Stark Onboarding

You can use this param to specify some space document name and the responses will contain exact matches of space documents that match the given name.

spaceDocumentName.cnstring
Example:Stark Onboarding

You can use this param to specify some space document name and the responses will contain matches of space documents that match the given name.

spaceDocumentName.ncstring
Example:Stark Onboarding

You can use this param to specify some space document name and the responses will not contain matches of space documents that match the given name.

createdAt.gtinteger
Example:1625164800000

You can use this param to provide an epoch milli value and the responses will contain space documents whose date are greater than the given space documents created date.

createdAt.eqinteger
Example:1625164800000

You can use this param to provide an epoch milli value and the responses will contain exact matches of space documents that match the given space documents created date.

createdAt.ltinteger
Example:1625164800000

You can use this param to provide an epoch milli value and the responses will contain space documents whose date are less than the given space documents created date.

createdAt.geinteger
Example:1625164800000

You can use this param to provide an epoch milli value and the responses will contain space documents whose date are greater than or equal to the given space documents created date.

createdAt.leinteger
Example:1625164800000

You can use this param to provide an epoch milli value and the responses will contain space documents whose date are less than or equal to the given space documents created date.

updatedAt.gtinteger
Example:1625164800000

You can use this param to provide an epoch milli value and the responses will contain space documents whose date are greater than the given space documents updated date.

updatedAt.eqinteger
Example:1625164800000

You can use this param to provide an epoch milli value and the responses will contain exact matches of space documents that match the given space documents updated date.

updatedAt.ltinteger
Example:1625164800000

You can use this param to provide an epoch milli value and the responses will contain space documents whose date are less than the given space documents updated date.

updatedAt.geinteger
Example:1625164800000

You can use this param to provide an epoch milli value and the responses will contain space documents whose date are greater than or equal to the given space documents updated date.

updatedAt.leinteger
Example:1625164800000

You can use this param to provide an epoch milli value and the responses will contain space documents whose date are less than or equal to the given space documents updated date.

spaceId.eqnumber
Example:10000

You can use this param to specify some value as space id and the responses will contain exact matches of space documents that match the given value.

Response

The requested action was successfully executed.

Example response

{
  "data": [
    {
      "spaceDocumentId": 201,
      "spaceDocumentName": "Sample file",
      "space": {
        "spaceId": 201,
        "spaceName": "General space"
      },
      "spaceDocumentType": "ROCKETLANE_DOCUMENT",
      "url": "https://www.google.com",
      "source": {
        "templateId": 201,
        "templateName": "Meeting Notes"
      },
      "createdAt": 1680616174929,
      "createdBy": {
        "emailId": "john.doe@rocketlane.com",
        "userId": 201,
        "firstName": "John",
        "lastName": "Doe"
      },
      "updatedAt": 1680616174929,
      "updatedBy": {
        "emailId": "john.doe@rocketlane.com",
        "userId": 201,
        "firstName": "John",
        "lastName": "Doe"
      },
      "private": true
    }
  ],
  "pagination": {
    "pageSize": 100,
    "hasMore": true,
    "totalRecordCount": 10398,
    "nextPage": "https://api.rocketlane.com/api/1.0/space-documents?includeFields=category,minutes&billable.eq=false&sortBy=startDate&sortOrder=desc&pageToken=e4a3dd8e-e338-11ed-b5ea-0242ac120002&limit=100&assignee.any=1&startDate.gt=2022-01-02",
    "nextPageToken": "e4a3dd8e-e338-11ed-b5ea-0242ac120002"
  }
}