Filter workspaces

Filter workspaces on given criteria. At least one of name, module, pencil_client_id, pencil_client_uuid, or is_pencil is required. The logo field is omitted unless include_logo=true.

POST /v1/workspaces/filter

Filter workspaces

cURL

curl --request POST \
  --url https://api.shareofmodel.ai/v1/workspaces/filter \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "module": "<string>",
  "pencil_client_id": 123,
  "pencil_client_uuid": "<string>",
  "is_pencil": true
}
'

200

[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "logo": "<string>",
    "is_pencil": true,
    "pencil_client_id": 0,
    "pencil_client_uuid": "<string>"
  }
]

Authorizations

Authorization · string · header · required

Query Parameters

include_logo · boolean

If set to true, include the logo field in the response. Defaults to false.

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data*/*

name · string

module · string

pencil_client_id · integer

pencil_client_uuid · string

is_pencil · boolean

Response

200 - application/json

id · string<uuid> · required · read-only

organization_id · string<uuid> · required · read-only

name · string · required

Maximum string length: 255

logo · string

is_pencil · boolean

pencil_client_id · integer<int64> | null

Required range: -9223372036854776000 <= x <= 9223372036854776000

pencil_client_uuid · string | null

Maximum string length: 64