API-Referenz

62 Bereiche, 612 Operationen. Basis-URL https://production.cashwerk.io, Anmeldung mit X-API-Key.

POST/api/v1/projects/archive-manyArchive multiple projects

Pfad: /api/v1/projects/archive-many
Anmeldung: X-API-Key im Header
Server: https://production.cashwerk.io · Sandbox https://cloud-staging.cashwerk.io

curl https://production.cashwerk.io/api/v1/projects/archive-many \
  -X POST \
  -H "X-API-Key: $CASHWERK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ … }'

const res = await fetch("https://production.cashwerk.io/api/v1/projects/archive-many", {
  method: "POST",
  headers: { "X-API-Key": process.env.CASHWERK_API_KEY }
});
const data = await res.json();

POST/api/v1/projects/delete-manyDelete multiple projects

Pfad: /api/v1/projects/delete-many
Anmeldung: X-API-Key im Header
Server: https://production.cashwerk.io · Sandbox https://cloud-staging.cashwerk.io

curl https://production.cashwerk.io/api/v1/projects/delete-many \
  -X POST \
  -H "X-API-Key: $CASHWERK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ … }'

const res = await fetch("https://production.cashwerk.io/api/v1/projects/delete-many", {
  method: "POST",
  headers: { "X-API-Key": process.env.CASHWERK_API_KEY }
});
const data = await res.json();

POST/api/v1/projects/newCreate a new project

Pfad: /api/v1/projects/new
Anmeldung: X-API-Key im Header
Server: https://production.cashwerk.io · Sandbox https://cloud-staging.cashwerk.io

curl https://production.cashwerk.io/api/v1/projects/new \
  -X POST \
  -H "X-API-Key: $CASHWERK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ … }'

const res = await fetch("https://production.cashwerk.io/api/v1/projects/new", {
  method: "POST",
  headers: { "X-API-Key": process.env.CASHWERK_API_KEY }
});
const data = await res.json();

GET/api/v1/projects/organization/{orgId}List all projects for an organization

Pfad: /api/v1/projects/organization/{orgId}
Anmeldung: X-API-Key im Header
Server: https://production.cashwerk.io · Sandbox https://cloud-staging.cashwerk.io

curl https://production.cashwerk.io/api/v1/projects/organization/{orgId} \
  -H "X-API-Key: $CASHWERK_API_KEY"

const res = await fetch("https://production.cashwerk.io/api/v1/projects/organization/{orgId}", {
  method: "GET",
  headers: { "X-API-Key": process.env.CASHWERK_API_KEY }
});
const data = await res.json();

GET/api/v1/projects/queryList projects with pagination and filters

Pfad: /api/v1/projects/query
Anmeldung: X-API-Key im Header
Server: https://production.cashwerk.io · Sandbox https://cloud-staging.cashwerk.io

curl https://production.cashwerk.io/api/v1/projects/query \
  -H "X-API-Key: $CASHWERK_API_KEY"

const res = await fetch("https://production.cashwerk.io/api/v1/projects/query", {
  method: "GET",
  headers: { "X-API-Key": process.env.CASHWERK_API_KEY }
});
const data = await res.json();

POST/api/v1/projects/restore-manyRestore multiple archived projects

Pfad: /api/v1/projects/restore-many
Anmeldung: X-API-Key im Header
Server: https://production.cashwerk.io · Sandbox https://cloud-staging.cashwerk.io

curl https://production.cashwerk.io/api/v1/projects/restore-many \
  -X POST \
  -H "X-API-Key: $CASHWERK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ … }'

const res = await fetch("https://production.cashwerk.io/api/v1/projects/restore-many", {
  method: "POST",
  headers: { "X-API-Key": process.env.CASHWERK_API_KEY }
});
const data = await res.json();

GET/api/v1/projects/statusesGet project status options

Pfad: /api/v1/projects/statuses
Anmeldung: X-API-Key im Header
Server: https://production.cashwerk.io · Sandbox https://cloud-staging.cashwerk.io

curl https://production.cashwerk.io/api/v1/projects/statuses \
  -H "X-API-Key: $CASHWERK_API_KEY"

const res = await fetch("https://production.cashwerk.io/api/v1/projects/statuses", {
  method: "GET",
  headers: { "X-API-Key": process.env.CASHWERK_API_KEY }
});
const data = await res.json();

DELETE/api/v1/projects/{projectId}Delete a project by ID

Pfad: /api/v1/projects/{projectId}
Anmeldung: X-API-Key im Header
Server: https://production.cashwerk.io · Sandbox https://cloud-staging.cashwerk.io

curl https://production.cashwerk.io/api/v1/projects/{projectId} \
  -X DELETE \
  -H "X-API-Key: $CASHWERK_API_KEY"

const res = await fetch("https://production.cashwerk.io/api/v1/projects/{projectId}", {
  method: "DELETE",
  headers: { "X-API-Key": process.env.CASHWERK_API_KEY }
});
const data = await res.json();

GET/api/v1/projects/{projectId}Get a single project by ID

Pfad: /api/v1/projects/{projectId}
Anmeldung: X-API-Key im Header
Server: https://production.cashwerk.io · Sandbox https://cloud-staging.cashwerk.io

curl https://production.cashwerk.io/api/v1/projects/{projectId} \
  -H "X-API-Key: $CASHWERK_API_KEY"

const res = await fetch("https://production.cashwerk.io/api/v1/projects/{projectId}", {
  method: "GET",
  headers: { "X-API-Key": process.env.CASHWERK_API_KEY }
});
const data = await res.json();

PATCH/api/v1/projects/{projectId}Update a project by ID

Pfad: /api/v1/projects/{projectId}
Anmeldung: X-API-Key im Header
Server: https://production.cashwerk.io · Sandbox https://cloud-staging.cashwerk.io

curl https://production.cashwerk.io/api/v1/projects/{projectId} \
  -X PATCH \
  -H "X-API-Key: $CASHWERK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ … }'

const res = await fetch("https://production.cashwerk.io/api/v1/projects/{projectId}", {
  method: "PATCH",
  headers: { "X-API-Key": process.env.CASHWERK_API_KEY }
});
const data = await res.json();

PATCH/api/v1/projects/{projectId}/address-with-portfolioSave the project address in a portfolio of the project customer and link it: the linked portfolio is updated, or with portfolioId null (or none linked) a new one is created

Pfad: /api/v1/projects/{projectId}/address-with-portfolio
Anmeldung: X-API-Key im Header
Server: https://production.cashwerk.io · Sandbox https://cloud-staging.cashwerk.io

curl https://production.cashwerk.io/api/v1/projects/{projectId}/address-with-portfolio \
  -X PATCH \
  -H "X-API-Key: $CASHWERK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ … }'

const res = await fetch("https://production.cashwerk.io/api/v1/projects/{projectId}/address-with-portfolio", {
  method: "PATCH",
  headers: { "X-API-Key": process.env.CASHWERK_API_KEY }
});
const data = await res.json();

PATCH/api/v1/projects/{projectId}/archiveArchive a project

Pfad: /api/v1/projects/{projectId}/archive
Anmeldung: X-API-Key im Header
Server: https://production.cashwerk.io · Sandbox https://cloud-staging.cashwerk.io

curl https://production.cashwerk.io/api/v1/projects/{projectId}/archive \
  -X PATCH \
  -H "X-API-Key: $CASHWERK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ … }'

const res = await fetch("https://production.cashwerk.io/api/v1/projects/{projectId}/archive", {
  method: "PATCH",
  headers: { "X-API-Key": process.env.CASHWERK_API_KEY }
});
const data = await res.json();

GET/api/v1/projects/{projectId}/assigneesGet project assignees

Pfad: /api/v1/projects/{projectId}/assignees
Anmeldung: X-API-Key im Header
Server: https://production.cashwerk.io · Sandbox https://cloud-staging.cashwerk.io

curl https://production.cashwerk.io/api/v1/projects/{projectId}/assignees \
  -H "X-API-Key: $CASHWERK_API_KEY"

const res = await fetch("https://production.cashwerk.io/api/v1/projects/{projectId}/assignees", {
  method: "GET",
  headers: { "X-API-Key": process.env.CASHWERK_API_KEY }
});
const data = await res.json();

PATCH/api/v1/projects/{projectId}/assigneesUpdate project assignees

Pfad: /api/v1/projects/{projectId}/assignees
Anmeldung: X-API-Key im Header
Server: https://production.cashwerk.io · Sandbox https://cloud-staging.cashwerk.io

curl https://production.cashwerk.io/api/v1/projects/{projectId}/assignees \
  -X PATCH \
  -H "X-API-Key: $CASHWERK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ … }'

const res = await fetch("https://production.cashwerk.io/api/v1/projects/{projectId}/assignees", {
  method: "PATCH",
  headers: { "X-API-Key": process.env.CASHWERK_API_KEY }
});
const data = await res.json();

POST/api/v1/projects/{projectId}/assigneesAdd assignees to a project

Pfad: /api/v1/projects/{projectId}/assignees
Anmeldung: X-API-Key im Header
Server: https://production.cashwerk.io · Sandbox https://cloud-staging.cashwerk.io

curl https://production.cashwerk.io/api/v1/projects/{projectId}/assignees \
  -X POST \
  -H "X-API-Key: $CASHWERK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ … }'

const res = await fetch("https://production.cashwerk.io/api/v1/projects/{projectId}/assignees", {
  method: "POST",
  headers: { "X-API-Key": process.env.CASHWERK_API_KEY }
});
const data = await res.json();

DELETE/api/v1/projects/{projectId}/assignees/{userId}Remove assignee from project

Pfad: /api/v1/projects/{projectId}/assignees/{userId}
Anmeldung: X-API-Key im Header
Server: https://production.cashwerk.io · Sandbox https://cloud-staging.cashwerk.io

curl https://production.cashwerk.io/api/v1/projects/{projectId}/assignees/{userId} \
  -X DELETE \
  -H "X-API-Key: $CASHWERK_API_KEY"

const res = await fetch("https://production.cashwerk.io/api/v1/projects/{projectId}/assignees/{userId}", {
  method: "DELETE",
  headers: { "X-API-Key": process.env.CASHWERK_API_KEY }
});
const data = await res.json();

POST/api/v1/projects/{projectId}/contactAdd contact to project

Pfad: /api/v1/projects/{projectId}/contact
Anmeldung: X-API-Key im Header
Server: https://production.cashwerk.io · Sandbox https://cloud-staging.cashwerk.io

curl https://production.cashwerk.io/api/v1/projects/{projectId}/contact \
  -X POST \
  -H "X-API-Key: $CASHWERK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ … }'

const res = await fetch("https://production.cashwerk.io/api/v1/projects/{projectId}/contact", {
  method: "POST",
  headers: { "X-API-Key": process.env.CASHWERK_API_KEY }
});
const data = await res.json();

DELETE/api/v1/projects/{projectId}/contact/{contactId}Remove contact from project

Pfad: /api/v1/projects/{projectId}/contact/{contactId}
Anmeldung: X-API-Key im Header
Server: https://production.cashwerk.io · Sandbox https://cloud-staging.cashwerk.io

curl https://production.cashwerk.io/api/v1/projects/{projectId}/contact/{contactId} \
  -X DELETE \
  -H "X-API-Key: $CASHWERK_API_KEY"

const res = await fetch("https://production.cashwerk.io/api/v1/projects/{projectId}/contact/{contactId}", {
  method: "DELETE",
  headers: { "X-API-Key": process.env.CASHWERK_API_KEY }
});
const data = await res.json();

GET/api/v1/projects/{projectId}/contactsGet project contacts

Pfad: /api/v1/projects/{projectId}/contacts
Anmeldung: X-API-Key im Header
Server: https://production.cashwerk.io · Sandbox https://cloud-staging.cashwerk.io

curl https://production.cashwerk.io/api/v1/projects/{projectId}/contacts \
  -H "X-API-Key: $CASHWERK_API_KEY"

const res = await fetch("https://production.cashwerk.io/api/v1/projects/{projectId}/contacts", {
  method: "GET",
  headers: { "X-API-Key": process.env.CASHWERK_API_KEY }
});
const data = await res.json();

POST/api/v1/projects/{projectId}/contactsAdd contacts to project

Pfad: /api/v1/projects/{projectId}/contacts
Anmeldung: X-API-Key im Header
Server: https://production.cashwerk.io · Sandbox https://cloud-staging.cashwerk.io

curl https://production.cashwerk.io/api/v1/projects/{projectId}/contacts \
  -X POST \
  -H "X-API-Key: $CASHWERK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ … }'

const res = await fetch("https://production.cashwerk.io/api/v1/projects/{projectId}/contacts", {
  method: "POST",
  headers: { "X-API-Key": process.env.CASHWERK_API_KEY }
});
const data = await res.json();

GET/api/v1/projects/{projectId}/dashboardGet project dashboard

Pfad: /api/v1/projects/{projectId}/dashboard
Anmeldung: X-API-Key im Header
Server: https://production.cashwerk.io · Sandbox https://cloud-staging.cashwerk.io

curl https://production.cashwerk.io/api/v1/projects/{projectId}/dashboard \
  -H "X-API-Key: $CASHWERK_API_KEY"

const res = await fetch("https://production.cashwerk.io/api/v1/projects/{projectId}/dashboard", {
  method: "GET",
  headers: { "X-API-Key": process.env.CASHWERK_API_KEY }
});
const data = await res.json();

POST/api/v1/projects/{projectId}/drive-folderGet or create the project documents folder

Pfad: /api/v1/projects/{projectId}/drive-folder
Anmeldung: X-API-Key im Header
Server: https://production.cashwerk.io · Sandbox https://cloud-staging.cashwerk.io

curl https://production.cashwerk.io/api/v1/projects/{projectId}/drive-folder \
  -X POST \
  -H "X-API-Key: $CASHWERK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ … }'

const res = await fetch("https://production.cashwerk.io/api/v1/projects/{projectId}/drive-folder", {
  method: "POST",
  headers: { "X-API-Key": process.env.CASHWERK_API_KEY }
});
const data = await res.json();

POST/api/v1/projects/{projectId}/duplicateDuplicate a project

Pfad: /api/v1/projects/{projectId}/duplicate
Anmeldung: X-API-Key im Header
Server: https://production.cashwerk.io · Sandbox https://cloud-staging.cashwerk.io

curl https://production.cashwerk.io/api/v1/projects/{projectId}/duplicate \
  -X POST \
  -H "X-API-Key: $CASHWERK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ … }'

const res = await fetch("https://production.cashwerk.io/api/v1/projects/{projectId}/duplicate", {
  method: "POST",
  headers: { "X-API-Key": process.env.CASHWERK_API_KEY }
});
const data = await res.json();

GET/api/v1/projects/{projectId}/financial-summaryGet all-time controlling figures (labor cost & hours, invoiced/offered totals) for a project

Pfad: /api/v1/projects/{projectId}/financial-summary
Anmeldung: X-API-Key im Header
Server: https://production.cashwerk.io · Sandbox https://cloud-staging.cashwerk.io

curl https://production.cashwerk.io/api/v1/projects/{projectId}/financial-summary \
  -H "X-API-Key: $CASHWERK_API_KEY"

const res = await fetch("https://production.cashwerk.io/api/v1/projects/{projectId}/financial-summary", {
  method: "GET",
  headers: { "X-API-Key": process.env.CASHWERK_API_KEY }
});
const data = await res.json();

POST/api/v1/projects/{projectId}/imageUpload project image

Pfad: /api/v1/projects/{projectId}/image
Anmeldung: X-API-Key im Header
Server: https://production.cashwerk.io · Sandbox https://cloud-staging.cashwerk.io

curl https://production.cashwerk.io/api/v1/projects/{projectId}/image \
  -X POST \
  -H "X-API-Key: $CASHWERK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ … }'

const res = await fetch("https://production.cashwerk.io/api/v1/projects/{projectId}/image", {
  method: "POST",
  headers: { "X-API-Key": process.env.CASHWERK_API_KEY }
});
const data = await res.json();

GET/api/v1/projects/{projectId}/metrics/{year}/{month}Get project metrics for a specific month

Pfad: /api/v1/projects/{projectId}/metrics/{year}/{month}
Anmeldung: X-API-Key im Header
Server: https://production.cashwerk.io · Sandbox https://cloud-staging.cashwerk.io

curl https://production.cashwerk.io/api/v1/projects/{projectId}/metrics/{year}/{month} \
  -H "X-API-Key: $CASHWERK_API_KEY"

const res = await fetch("https://production.cashwerk.io/api/v1/projects/{projectId}/metrics/{year}/{month}", {
  method: "GET",
  headers: { "X-API-Key": process.env.CASHWERK_API_KEY }
});
const data = await res.json();

GET/api/v1/projects/{projectId}/portfolio/customerGet project customer

Pfad: /api/v1/projects/{projectId}/portfolio/customer
Anmeldung: X-API-Key im Header
Server: https://production.cashwerk.io · Sandbox https://cloud-staging.cashwerk.io

curl https://production.cashwerk.io/api/v1/projects/{projectId}/portfolio/customer \
  -H "X-API-Key: $CASHWERK_API_KEY"

const res = await fetch("https://production.cashwerk.io/api/v1/projects/{projectId}/portfolio/customer", {
  method: "GET",
  headers: { "X-API-Key": process.env.CASHWERK_API_KEY }
});
const data = await res.json();

POST/api/v1/projects/{projectId}/portfolio/customerUpdate project customer

Pfad: /api/v1/projects/{projectId}/portfolio/customer
Anmeldung: X-API-Key im Header
Server: https://production.cashwerk.io · Sandbox https://cloud-staging.cashwerk.io

curl https://production.cashwerk.io/api/v1/projects/{projectId}/portfolio/customer \
  -X POST \
  -H "X-API-Key: $CASHWERK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ … }'

const res = await fetch("https://production.cashwerk.io/api/v1/projects/{projectId}/portfolio/customer", {
  method: "POST",
  headers: { "X-API-Key": process.env.CASHWERK_API_KEY }
});
const data = await res.json();

PATCH/api/v1/projects/{projectId}/restoreRestore an archived project

Pfad: /api/v1/projects/{projectId}/restore
Anmeldung: X-API-Key im Header
Server: https://production.cashwerk.io · Sandbox https://cloud-staging.cashwerk.io

curl https://production.cashwerk.io/api/v1/projects/{projectId}/restore \
  -X PATCH \
  -H "X-API-Key: $CASHWERK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ … }'

const res = await fetch("https://production.cashwerk.io/api/v1/projects/{projectId}/restore", {
  method: "PATCH",
  headers: { "X-API-Key": process.env.CASHWERK_API_KEY }
});
const data = await res.json();

POST/api/v1/projects/{projectId}/update-default-task-boardUpdate default task board for a project

Pfad: /api/v1/projects/{projectId}/update-default-task-board
Anmeldung: X-API-Key im Header
Server: https://production.cashwerk.io · Sandbox https://cloud-staging.cashwerk.io

curl https://production.cashwerk.io/api/v1/projects/{projectId}/update-default-task-board \
  -X POST \
  -H "X-API-Key: $CASHWERK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ … }'

const res = await fetch("https://production.cashwerk.io/api/v1/projects/{projectId}/update-default-task-board", {
  method: "POST",
  headers: { "X-API-Key": process.env.CASHWERK_API_KEY }
});
const data = await res.json();