Zum Inhalt springen

Tags

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

POST/api/v1/tags/createCreate a new tag (name + optional hex color)
Pfad
/api/v1/tags/create
Anmeldung
X-API-Key im Header
Server
https://production.cashwerk.io · Sandbox https://cloud-staging.cashwerk.io
curl https://production.cashwerk.io/api/v1/tags/create \
  -X POST \
  -H "X-API-Key: $CASHWERK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ … }'
POST/api/v1/tags/find-or-createFind tags by name or create missing ones; returns the resolved tags (with ids)
Pfad
/api/v1/tags/find-or-create
Anmeldung
X-API-Key im Header
Server
https://production.cashwerk.io · Sandbox https://cloud-staging.cashwerk.io
curl https://production.cashwerk.io/api/v1/tags/find-or-create \
  -X POST \
  -H "X-API-Key: $CASHWERK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ … }'
GET/api/v1/tags/listList all tags for the organization
Pfad
/api/v1/tags/list
Anmeldung
X-API-Key im Header
Server
https://production.cashwerk.io · Sandbox https://cloud-staging.cashwerk.io
curl https://production.cashwerk.io/api/v1/tags/list \
  -H "X-API-Key: $CASHWERK_API_KEY"
POST/api/v1/tags/queryPage through the organization's tags with search, archive filter, sorting and per-entity usage counts
Pfad
/api/v1/tags/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/tags/query \
  -X POST \
  -H "X-API-Key: $CASHWERK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ … }'
GET/api/v1/tags/searchSearch tags by name within the organization
Pfad
/api/v1/tags/search
Anmeldung
X-API-Key im Header
Server
https://production.cashwerk.io · Sandbox https://cloud-staging.cashwerk.io
curl https://production.cashwerk.io/api/v1/tags/search \
  -H "X-API-Key: $CASHWERK_API_KEY"
DELETE/api/v1/tags/{id}Delete a tag; 409 with the usage counts when it is still linked, unless force=true
Pfad
/api/v1/tags/{id}
Anmeldung
X-API-Key im Header
Server
https://production.cashwerk.io · Sandbox https://cloud-staging.cashwerk.io
curl https://production.cashwerk.io/api/v1/tags/{id} \
  -X DELETE \
  -H "X-API-Key: $CASHWERK_API_KEY"
POST/api/v1/tags/{id}/archiveArchive a tag (hidden from pickers, kept on linked entities)
Pfad
/api/v1/tags/{id}/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/tags/{id}/archive \
  -X POST \
  -H "X-API-Key: $CASHWERK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ … }'
POST/api/v1/tags/{id}/restoreRestore an archived tag
Pfad
/api/v1/tags/{id}/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/tags/{id}/restore \
  -X POST \
  -H "X-API-Key: $CASHWERK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ … }'
PATCH/api/v1/tags/{id}/updateUpdate a tag (name and/or color)
Pfad
/api/v1/tags/{id}/update
Anmeldung
X-API-Key im Header
Server
https://production.cashwerk.io · Sandbox https://cloud-staging.cashwerk.io
curl https://production.cashwerk.io/api/v1/tags/{id}/update \
  -X PATCH \
  -H "X-API-Key: $CASHWERK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ … }'
GET/api/v1/tags/{id}/usageCount the entities linked to a tag, per entity kind
Pfad
/api/v1/tags/{id}/usage
Anmeldung
X-API-Key im Header
Server
https://production.cashwerk.io · Sandbox https://cloud-staging.cashwerk.io
curl https://production.cashwerk.io/api/v1/tags/{id}/usage \
  -H "X-API-Key: $CASHWERK_API_KEY"