Sign in

v1

latestOpenAPI 3.0.22026-07-146168117.0 KB
Papersign Spaces

This endpoint returns a list of Papersign spaces. Please note that this feature is exclusively available as part of the Papersign API.

get/papersign/spaces

Query parameters

searchstring

Search spaces by name.

Request body

idnumber

The unique identifier of the folder.

namestring

The name of the space.

root_folder_idnumber

The unique identifier of the root folder.

allow_team_accessboolean

Whether to allow team access to this space.

Example request

{
  "id": 9999,
  "name": "My Space",
  "root_folder_id": 9999,
  "allow_team_access": true
}

Response

Successfully returned a list of Papersign spaces

status'ok'
totalinteger

The total number of items.

has_moreboolean

Whether there are more items.

limitinteger

The limit of items per page.

skipinteger

The number of items to skip.

Example response

{
  "results": {
    "spaces": [
      {
        "id": 9999,
        "name": "My Space",
        "root_folder_id": 9999,
        "allow_team_access": true
      }
    ]
  },
  "total": 57,
  "has_more": true,
  "limit": 20
}