Spaces

List spaces

GET /api/v1/spaces

Parameters

Name	In	Type	Required	Description
`organizationId`	query	string	No	—
`projectId`	query	string	No	—

Example request

curl -X GET \
"https://api.example.com/api/v1/spaces?organizationId=<organizationId>&projectId=<projectId>" \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"

Response body type

—

Create space

POST /api/v1/spaces

Example request

curl -X POST \
"https://api.example.com/api/v1/spaces" \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"

Response body type

—

Get space

GET /api/v1/spaces/{id}

Parameters

Name	In	Type	Required	Description
`id`	path	string	Yes	Convex document id

Example request

curl -X GET \
"https://api.example.com/api/v1/spaces/<id>" \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"

Response body type

—

Update space

PATCH /api/v1/spaces/{id}

Parameters

Name	In	Type	Required	Description
`id`	path	string	Yes	Convex document id

Example request

curl -X PATCH \
"https://api.example.com/api/v1/spaces/<id>" \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"

Response body type

—

Delete space

DELETE /api/v1/spaces/{id}

Parameters

Name	In	Type	Required	Description
`id`	path	string	Yes	Convex document id

Example request

curl -X DELETE \
"https://api.example.com/api/v1/spaces/<id>" \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"

Response body type

—