Get all space documents

get

https://api.rocketlane.com/api/1.0/space-documents

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

projectId

int64

required

≥ 0

Defaults to 1

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.

pageSize

number

≥ 0

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.

pageToken

string

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

string

enum

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

Allowed:

sortOrder

string

enum

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

Allowed:

match

string

enum

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

Allowed:

spaceDocumentName.eq

string

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.cn

string

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.nc

string

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.gt

int64

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.eq

int64

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.lt

int64

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.ge

int64

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.le

int64

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.gt

int64

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.eq

int64

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.lt

int64

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.ge

int64

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.le

int64

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.eq

number

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.

Responses

200The requested action was successfully executed.

400This error typically happens when the request payload contains an error. If you want to make sure that the request's parameters are named correctly and are the right data types, you can examine the request's syntax.

401You see this error when trying to access this resource without being authenticated. Check the API request header to make sure it is not empty and has a valid api-key that you acquired from the Rocketlane API Settings tab.