Get a list of Spaces

Get a list of Spaces accessible by the account associated with your API key

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
≥ 1
Defaults to 1

(Optional) - The page number of the items to return. The number of items in a page is controlled by the pageSize parameter.

integer
1 to 100
Defaults to 25

(Optional) - The max number of items to return. Setting a larger pageSize will default to 100 spaces.

string

Filter Spaces using a Base64-encoded JSON object.

Omit filters when you do not want to supply filter criteria.

Choose the fields below, serialize the object to JSON, and Base64-encode the UTF-8 bytes. Enter the encoded value in the filters input. These fields belong inside the JSON object; they are not separate query parameters.

Decoded filter fields

FieldTypeDescription
querystringThe search key you'd like to search as part of the filter. This typically matches the title of the object and is a substring match. Example: "My First Space".
sitesarray of stringsFilter by site Each item: mongodb id (12 byte hex string). Example: ["507f1f77bcf86cd799439011"].
hostsarray of stringsFilter by Space hosts Each item: mongodb id (12 byte hex string). Example: ["507f1f77bcf86cd799439012"].
participantsarray of stringsFilter by Space participants Each item: mongodb id (12 byte hex string). Example: ["507f1f77bcf86cd799439013"].
ownerstringFilter by a particular Space owner userId. Format: mongodb id (12 byte hex string). Example: "507f1f77bcf86cd799439014".
externalIdstringFilter by a particular Space externalId. Example: "abc123".
archiveStatusstringWhether to show or hide archived Spaces Allowed values: ARCHIVED, NON_ARCHIVED, ALL. Example: "ARCHIVED".
customAttributesarray of stringsFilter by Space custom attributes Example: ["NydvLFSpxOJe2aO07hGxU"].
createdRangeobjectFilter by Space creation date
createdRange.startstringStart of the range. Format: RFC3339 timestamp with mandatory time zone offset - e.g., YYYY-mm-ddTHH:MM:ss+00:00. Example: "2099-01-12T00:00:00.000+00:00".
createdRange.endstringEnd of the range. Format: RFC3339 timestamp with mandatory time zone offset - e.g., YYYY-mm-ddTHH:MM:ss+00:00. Example: "2099-01-12T00:00:00.000+00:00".

Example before encoding

{
  "query": "My First Space",
  "archiveStatus": "NON_ARCHIVED"
}

Base64 value for the filters input

eyJxdWVyeSI6Ik15IEZpcnN0IFNwYWNlIiwiYXJjaGl2ZVN0YXR1cyI6Ik5PTl9BUkNISVZFRCJ9

Example request

/spaces?filters=eyJxdWVyeSI6Ik15IEZpcnN0IFNwYWNlIiwiYXJjaGl2ZVN0YXR1cyI6Ik5PTl9BUkNISVZFRCJ9

Encode inline in Node.js

const criteria = {"query":"My First Space","archiveStatus":"NON_ARCHIVED"};
const params = new URLSearchParams({
  filters: Buffer.from(JSON.stringify(criteria), "utf8").toString("base64")
});
const path = "/spaces?" + params.toString();

Base64 encoding and URL encoding are separate steps. An HTTP client query-parameter helper can URL-encode the Base64 value for you. If constructing the URL manually, URL-encode the value once so +, /, and = are preserved.

Responses

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json