Documentation

Organizations

Organization lists and managed organization records.

Playground

Send these requests to your own running sidecar. Values stay in this browser.

Not connected

Base URL Bearer token optional Session token optional

How this works

The sidecar listens on a loopback port chosen at startup and prints it in its ready line; use that URL and the CADCAMFUN_TOKEN it was started with. Requests go straight from this page to that address.

The sidecar sends CORS headers only to the Tauri origins and to http://localhost or http://127.0.0.1 on any port. From the hosted docs the browser blocks the response, so run the docs locally (bun run dev in packages/web) to use the playground, or copy the request as curl. To experiment without touching real data, start the sidecar with CADCAMFUN_DATA_DIR pointed at a throwaway directory — see the API walkthrough.

Operations

5 endpoints in the organizations group, generated from the sidecar's own OpenAPI document. Protected operations take Authorization: Bearer $CADCAMFUN_TOKEN; see authentication. Behaviour and limits are in the subsystem guide.

get	/api/organizations	organizations.list
post	/api/organizations	organizations.create
get	/api/organizations/{id}	organizations.get
put	/api/organizations/{id}	organizations.update
delete	/api/organizations/{id}	organizations.remove

Organizations operations in 3D Drag to orbit · scroll to zoom · right-drag to pan

One block per operation (5), stacked per resource section of this page and coloured by method: green GET, orange POST, blue PUT, violet PATCH, red DELETE. Generated from the OpenAPI document at build time.

/api/organizations

get /api/organizations # organizations.list

Requires Authorization: Bearer <token>.

Responses

200 Array<object> application/json

Array<{
  id: string
  name: string
  description: string | null
  createdAt: string
  updatedAt: string
  role: "ADMIN" | "MANAGER" | "MEMBER"
  userCount: number | "Infinity" | "-Infinity" | "NaN"
  projectCount: number | "Infinity" | "-Infinity" | "NaN"
}>

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Example response captured · 200

GET /api/organizations

[]

SDK example

organizations.list

import { CadCam } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

// no input
const result = await client.organizations.list()

curl

GET /api/organizations

curl --request GET "${CADCAMFUN_URL}/api/organizations" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}"

Try it

post /api/organizations # organizations.create

Requires Authorization: Bearer <token>.

Request body · required · application/json

{
  name: string
  description?: string | null
}

Responses

201 object application/json

{
  id: string
  name: string
  description: string | null
  createdAt: string
  updatedAt: string
}

400 BadRequestEncoded application/json

BadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

SDK example

organizations.create

import { CadCam } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

// OrganizationsCreateInput
const result = await client.organizations.create({
  name: "",
  description: ""
})

curl

POST /api/organizations

curl --request POST "${CADCAMFUN_URL}/api/organizations" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-binary @request.json

Try it

Request body application/json

get /api/organizations/{id} # organizations.get

Requires Authorization: Bearer <token>.

Parameters

Name	In	Type	Required
id	path	string	required

Responses

200 object application/json

{
  id: string
  name: string
  description: string | null
  createdAt: string
  updatedAt: string
  members: Array<{
    id: string
    name: string | null
    email: string | null
    image: string | null
    role: "ADMIN" | "MANAGER" | "MEMBER"
    joinedAt: string
  }>
  projectCount: number | "Infinity" | "-Infinity" | "NaN"
  userRole: "ADMIN" | "MANAGER" | "MEMBER"
}

400 BadRequestEncoded application/json

BadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

403 ForbiddenEncoded application/json

ForbiddenEncoded

404 NotFoundEncoded application/json

NotFoundEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

SDK example

organizations.get

import { CadCam } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

// OrganizationsGetInput
const result = await client.organizations.get({
  id: "<id>"
})

curl

GET /api/organizations/{id}

curl --request GET "${CADCAMFUN_URL}/api/organizations/<id>" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}"

Try it

id path · required

put /api/organizations/{id} # organizations.update

Requires Authorization: Bearer <token>.

Parameters

Name	In	Type	Required
id	path	string	required

Request body · required · application/json

{
  name: string
  description?: string | null
}

Responses

200 object application/json

{
  id: string
  name: string
  description: string | null
  createdAt: string
  updatedAt: string
}

400 BadRequestEncoded application/json

BadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

403 ForbiddenEncoded application/json

ForbiddenEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

SDK example

organizations.update

import { CadCam } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

// OrganizationsUpdateInput
const result = await client.organizations.update({
  id: "<id>",
  name: "",
  description: ""
})

curl

PUT /api/organizations/{id}

curl --request PUT "${CADCAMFUN_URL}/api/organizations/<id>" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-binary @request.json

Try it

id path · required

Request body application/json

delete /api/organizations/{id} # organizations.remove

Requires Authorization: Bearer <token>.

Parameters

Name	In	Type	Required
id	path	string	required

Responses

200 object application/json

{
  message: string
}

400 BadRequestEncoded application/json

BadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

403 ForbiddenEncoded application/json

ForbiddenEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

SDK example

organizations.remove

import { CadCam } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

// OrganizationsRemoveInput
const result = await client.organizations.remove({
  id: "<id>"
})

curl

DELETE /api/organizations/{id}

curl --request DELETE "${CADCAMFUN_URL}/api/organizations/<id>" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}"

Try it

id path · required

Schemas

Named schemas reachable from this group's parameters, bodies and responses. A ? marks an optional field; | null marks a field that may be present with a null value.

BadRequestEncoded

{
  _tag: "BadRequest"
  message: string
}

ForbiddenEncoded

{
  _tag: "Forbidden"
  message: string
}

InternalErrorEncoded

{
  _tag: "InternalError"
  message: string
}

NotFoundEncoded

{
  _tag: "NotFound"
  message: string
}

UnauthorizedEncoded

{
  _tag: "Unauthorized"
  message: string
}

Calling this group

Operation ids have the form organizations.<name>. The generated Promise SDK (@cadcamfun/api/sdk) exposes most of them as client.<namespace>.<method>(input), where input is one flat object of path parameters and body fields; each card's SDK example shows the exact accessor and input type. Multipart uploads, binary or JavaScript responses and raw webhooks are not generated; those cards show fetch instead.

Errors from the Promise SDK

import { CadCam, ClientError } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

try {
  await client.projects.list()
} catch (error) {
  if (error instanceof ClientError) {
    // Transport | UnexpectedStatus | UnsupportedContentType | MalformedResponse | SseEventTooLarge
  } else {
    // a declared error body: switch on error._tag
  }
}

Troubleshooting

Symptom	Likely cause	Fix
401 on every call	Token from a previous launch, or missing `Bearer` prefix	Send `Authorization: Bearer <token>` with the token the sidecar was started with.
400 before anything happens	Body or parameter does not match the schema	Compare the payload with the request schema on the card.
403 or 404 on a record you can see elsewhere	The acting account differs	Send the right `x-session-token`, or use the local profile that owns the record.
409	Conflicting state, such as a duplicate name or a stale branch head	Re-read the resource and retry with current data.
Try it says "blocked by CORS"	The docs are served from a non-loopback origin	Run the docs locally or copy the request as curl.
Connection refused	The sidecar restarted on a new port	Read the port from the new `ready` line.