Create a project

Create a task project with a name, a unique key (an uppercase letter followed by up to nine uppercase letters or digits, used in task keys such as DEV-12), an optional icon and description.

The project is created with the default board columns.
A key already used by another project of your company returns 409 project_key_in_use.

Client-generated opaque key (up to 255 characters; UUID v7 recommended) that makes retries safe: the first response is cached and replayed for repeats without re-executing the mutation. Reusing a key with a different body returns 409 idempotency_key_reused. See the Idempotency guide.

Length1 <= length <= 255

Factuarea-Version?string

Pin the API version (YYYY-MM-DD, Stripe-style date versioning) for this request; omit to use the key's pinned version, or the latest if none. Unsupported version → 400 unsupported_api_version; malformed → 400 parameter_invalid_format. The effective version is echoed in the Factuarea-Version response header. See the Versioning guide.

Formatdate

X-Active-Profile?string

Operate on behalf of a child company (gestoría master key): pass its public id (UUID v7) and the request runs against that child's data without changing the key's scope, tier or environment (omit to use the key's own company). Invalid UUID → 400 parameter_invalid_uuid; unknown or non-owned id → 404 profile_not_found. See the Acting on behalf guide.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Project name (1-120 characters, no control characters).

Match^[^\p{Cc}]+$

Lengthlength <= 120

key*string

Project key (DEV): one letter followed by up to 9 letters or digits; it prefixes the keys of its tasks.

Match^[A-Z][A-Z0-9]{0,9}$

icon?|

Icon from the closed catalog; the default icon when omitted.

Value in

"folder" | "briefcase" | "rocket" | "code" | "bug" | "wrench" | "hammer" | "truck" | "package" | "shopping-cart" | "calculator" | "receipt" | "file-text" | "landmark" | "users" | "user" | "building" | "home" | "calendar" | "clock" | "flag" | "star" | "heart" | "lightbulb" | "target" | "trophy" | "book" | "graduation-cap" | "megaphone" | "palette" | "camera" | "music" | "globe" | "leaf" | "coffee" | "car" | "plane" | "shield" | "zap" | "layers" | null

description?|

Optional project description (up to 5,000 characters).

Lengthlength <= 5000

Response Body

`application/json`

Request example

const apiKey = process.env.FACTUAREA_API_KEY;if (!apiKey) throw new Error("Set FACTUAREA_API_KEY");const response = await fetch("https://api.factuarea.com/v1/projects", {  method: "POST",  headers: { Authorization: `Bearer ${apiKey}`, ...{"Accept":"application/json","Content-Type":"application/json","Idempotency-Key":"erp-2026-public-api-v1-projects-create"} },  body: JSON.stringify({  "name": "Tienda principal",  "key": "TIENDA"}),});if (!response.ok) throw new Error(await response.text());if (response.status !== 204) console.log(await response.json());

Response example

{
  "data": {
    "id": "0193a4f2-7c20-7a11-8b52-4d6e8f0a2c01",
    "object": "project",
    "key": "DEV",
    "name": "Desarrollo web",
    "icon": "code",
    "description": "Evolutivos y correcciones de la tienda online.",
    "position": 0,
    "is_archived": false,
    "archived_at": null,
    "billing_contact_id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a01",
    "billing_hourly_rate": "45.00",
    "billing_product_id": null,
    "stats": {
      "total_tasks": 0,
      "completed_tasks": 0,
      "completion_percentage": 0,
      "next_due_on": null
    },
    "created_at": "2026-06-02T09:15:00+02:00",
    "updated_at": "2026-06-02T09:15:00+02:00"
  }
}

{
  "error": {
    "type": "authentication_error",
    "code": "missing_api_key",
    "message": "Falta header Authorization o X-API-Key.",
    "doc_url": "https://docs.factuarea.com/guides/errors#missing_api_key",
    "request_id": "req_b979c0b3c4c4369b5039c1510e"
  }
}

{
  "error": {
    "type": "authorization_error",
    "code": "insufficient_scope",
    "message": "Esta operación requiere el scope 'projects:write'. Tu API key solo tiene los scopes: projects:read.",
    "doc_url": "https://docs.factuarea.com/guides/errors#insufficient_scope",
    "request_id": "req_1181542150a83180cf17eb5e4e"
  }
}

POST /v1/projects · 409 project_key_in_use

{
  "error": {
    "type": "conflict_error",
    "code": "project_key_in_use",
    "message": "La clave de proyecto «DEV» ya está en uso en la empresa.",
    "param": "key",
    "doc_url": "https://docs.factuarea.com/guides/errors#project_key_in_use",
    "request_id": "req_f5c75ecffb51743ee4a68c7c41"
  }
}

POST /v1/projects · 409 idempotency_key_reused

{
  "error": {
    "type": "idempotency_error",
    "code": "idempotency_key_reused",
    "message": "Esa `Idempotency-Key` ya se usó con un payload distinto. La clave identifica una operación concreta, así que reutilizarla para otra vaciaría de sentido el replay.",
    "doc_url": "https://docs.factuarea.com/guides/errors#idempotency_key_reused",
    "request_id": "req_1618ae682908241453d5d21112"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_param_value",
    "message": "El nombre del proyecto es obligatorio.",
    "param": "name",
    "doc_url": "https://docs.factuarea.com/guides/errors#invalid_param_value",
    "request_id": "req_172cb702ec3a410fc342fee35e"
  }
}

{
  "error": {
    "type": "rate_limit_error",
    "code": "rate_limit_exceeded",
    "message": "Has excedido el límite de requests permitido. Reintenta más tarde.",
    "doc_url": "https://docs.factuarea.com/guides/errors#rate_limit_exceeded",
    "request_id": "req_7e9874d09b4dfbe2ffd2d8242b"
  }
}

{
  "error": {
    "type": "api_error",
    "code": "internal_error",
    "message": "Algo se rompió en nuestro lado al procesar la petición. La condición no la provoca tu payload.",
    "doc_url": "https://docs.factuarea.com/guides/errors#internal_error",
    "request_id": "req_2d3ee9d7fcbd2e4803d904c7fb"
  }
}

Create a project

Authorization

Headers

Request Body

Response Body

201application/json

401application/json

403application/json

409application/json

422application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`