Filter organizations

Filter organizations by workspace_id, pencil_customer_id and/or is_pencil. At least one criterion is required. The logo field is omitted unless include_logo=true.

POST /v1/organizations/filter

Filter organizations

cURL

curl --request POST \
  --url https://api.shareofmodel.ai/v1/organizations/filter \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "pencil_customer_id": 123,
  "is_pencil": true
}
'

200

[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<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*/*

workspace_id · string<uuid>

pencil_customer_id · integer

is_pencil · boolean

Response

200 - application/json

id · string<uuid>

name · string