Skip to main content

Organisations

Organisations are the top-level containers for your work in Freeq. Use these endpoints to create, list, update, soft-delete, and restore organisations that own projects and related resources.

List organisations​

GET /api/v1/organisations

cURL​

curl -s "$FREEQ_API_URL/api/v1/organisations?showDeleted=false" \
  -H "Authorization: Bearer $FREEQ_API_TOKEN"

Create organisation​

POST /api/v1/organisations

cURL​

curl -s -X POST "$FREEQ_API_URL/api/v1/organisations" \
  -H "Authorization: Bearer $FREEQ_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"Acme Ltd"}'

Update organisation​

PUT /api/v1/organisations/{id}

cURL​

curl -s -X PUT "$FREEQ_API_URL/api/v1/organisations/321" \
  -H "Authorization: Bearer $FREEQ_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"Acme (EU) Ltd"}'

Delete / Undelete​

DELETE /api/v1/organisations/{id}
POST /api/v1/organisations/{id}/undelete