Aller au contenu

Touch2build API

En anglais

Cette section s'adresse aux développeurs et, comme l'API, elle est rédigée en anglais.

The Touch2build API lets your own tools read and update your projects: export tasks to a BI tool, create tasks from another system, attach photos, render plans, print QR codes.

  • API keys


    Create a key in your account and call the API with it.

  • Reference


    Every endpoint, its parameters and responses, and a console to try them. The OpenAPI document is at /openapi.json.

  • Conventions


    JSON, pagination, partial updates, idempotent creations, files and rate limits.

  • Errors


    Every error is a problem document with a stable code.

Base URL

https://api.touch2build.com

Every path starts with the version: https://api.touch2build.com/v1/projects. Only HTTPS is accepted.

Quick start

  1. In the web app, open My account, tab API keys, and create a key (how).
  2. Send it as a bearer token:

    export T2B_API_KEY="t2b_live_..."
    
    curl https://api.touch2build.com/v1/projects?limit=5 \
      -H "Authorization: Bearer $T2B_API_KEY"
    
  3. Use an id from the answer to list the open tasks of a project:

    curl "https://api.touch2build.com/v1/projects/$PROJECT_ID/tasks?status=open&sort=due_date" \
      -H "Authorization: Bearer $T2B_API_KEY"
    
{
  "data": [
    {
      "id": "8f4c1e2a-...",
      "number": 42,
      "name": "Missing fire seal around the duct",
      "status": "open",
      "priority": "high",
      "dueDate": "2026-11-15",
      "assignee": { "id": "...", "name": "Dupont Plomberie" },
      "updatedAt": "2026-10-16T08:12:44Z"
    }
  ],
  "pagination": { "limit": 50, "hasMore": false }
}

What the API covers

Area Resources
Projects projects, members and their permissions, tags
Tasks tasks and their status changes, comments, work logs, photos, history
Documents folders, plans (PDF), geo maps, points of interest, QR codes, photo gallery

Organisation administration, reports and the mobile synchronisation are not part of the API.

Your data, your permissions

The API acts as the user who owns the key or the token. It reaches only the projects that user can open in the app, with the same permissions in each, and the same license: what the app refuses, the API refuses too.

Versions

The API is versioned in its path. Within v1, changes are backward compatible: new endpoints, new optional parameters, new fields in responses, new values in enumerations. Ignore the fields you do not know, and handle unknown enumeration values. A change that breaks clients goes to a new version.