Skip to main content
GET
/
api
/
v1
/
spaces
/
search
Search for a space by name
curl --request GET \
  --url https://api.example.com/api/v1/spaces/search \
  --header 'Authorization: Bearer <token>'
{
  "id": 123,
  "name": "<string>",
  "description": "<string>",
  "organizationId": 123,
  "created": "2023-11-07T05:31:56Z",
  "updated": "2023-11-07T05:31:56Z",
  "isDefaultAccess": true
}

Authorizations

​
Authorization
string
header
required

API Key authorization header. Example: "Authorization: ApiKey {your-api-key}"

​
Authorization
string
header
required

OAuth 2.0 Bearer token. Example: "Authorization: Bearer {access-token}"

Query Parameters

​
name
string

The name of the space to search for

Response

Returns the matching space

Response model for a space in the External API

​
id
integer<int32>
​
name
string | null
​
description
string | null
​
organizationId
integer<int32>
​
created
string<date-time>
​
updated
string<date-time>
​
isDefaultAccess
boolean