Everything in the model, available to your tools.

OAuth discovery for the SketchUp client

Public endpoints and the registered client ID a native client needs to start an Authorization Code + PKCE flow. enabled is false when OAuth is not configured on the server.

Responses

• 200Discovery document. Never cached.

  {
    "enabled": true,
    "authorization_endpoint": "https://<project>.supabase.co/auth/v1/oauth/authorize",
    "token_endpoint": "https://<project>.supabase.co/auth/v1/oauth/token",
    "client_id": "…",
    "redirect_uri": "http://127.0.0.1:43821/oauth/callback",
    "scope": "openid email profile"
  }

The organisation's material library

Material types with their materials, dimensions and appearance, plus the organisation's tool configuration: takeoff_groups (every group, with status active or retired so saved models can still resolve retired ones) and tools (the global SketchUp tool catalogue, each with the ids of the groups it may offer in this organisation — configured at /app/tools; nothing is allowed by default and new groups are never linked automatically). A tool runs with one of its groups selected and every item it creates inherits that group. generated_roles is retained for older extensions and reports each role's tool groups. Every id in tools[].takeoff_group_ids and generated_roles[].takeoff_group_ids is present in takeoff_groups; arrays are [] rather than null. The ETag changes when a tool, group, assignment or material changes. Texture objects include one-hour signed_url values for privately stored images; solid colours have signed_url: null and expose color and render_spec instead. When a material has no construction texture, construction_texture falls back to its type's default_texture. ETags roll before signed URLs expire so long-running clients periodically receive fresh URLs.

Headers

Responses

• 200The library, with ETag.

  {
    "api_version": "v1",
    "organisation": { "id": "uuid", "name": "Example Builders" },
    "takeoff_groups": [
      { "id": "uuid", "name": "Concrete slabs", "status": "active" }
    ],
    "tools": [
      { "id": "concrete.slab_from_face", "name": "Concrete Slab", "status": "active",
        "takeoff_group_ids": ["uuid"] },
      { "id": "structure.beam", "name": "Beam", "status": "active", "takeoff_group_ids": [] },
      { "id": "timber.wall_frame", "name": "Timber Wall Framing", "status": "active",
        "takeoff_group_ids": [] }
    ],
    "generated_roles": [
      {
        "id": "concrete.slab_from_face.slab_body",
        "tool_id": "concrete.slab_from_face",
        "takeoff_group_ids": ["uuid"]
      }
    ],
    "material_types": [
      {
        "id": "uuid",
        "name": "LVL",
        "profile": "rectangular",
        "uom": "m",
        "density_kg_m3": 550,
        "notes": null,
        "status": "active",
        "updated_at": "2026-08-20T01:02:03.000Z",
        "default_texture": null,
        "materials": [
          {
            "id": "uuid",
            "name": "240x45 LVL",
            "profile": "rectangular",
            "grade": "E13",
            "finish": null,
            "dimensions_mm": { "width": 45, "depth": 240, "thickness": null, "height": null,
                               "diameter": null, "wall_thickness": null, "flange_width": null,
                               "web_thickness": null, "flange_thickness": null, "girth": null, "folds": null },
            "mass_per_uom": null,
            "status": "active",
            "updated_at": "2026-08-20T01:02:03.000Z",
            "construction_texture": {
              "texture_id": "uuid", "name": "Pine grain", "kind": "labelled",
              "signed_url": "https://…", "color": null, "render_spec": null,
              "aspect_ratio": 1, "natural_width_mm": null, "natural_height_mm": null,
              "fit": "fitted", "width_mm": 45, "height_mm": 45, "rotation": 0
            },
            "display_texture": null
          }
        ]
      }
    ]
  }

• 304Unchanged; reuse the cached body.
• 401Token missing, malformed, unknown, or revoked.
• 500Library or texture signing could not be completed.

Example

curl https://app.basegrid.com.au/api/v1/material-library \
  -H "Authorization: Bearer bgc_…"

The organisation's takeoff groups

The workspace-wide list of headings a takeoff is organised under, in the estimator's order. Use abbreviation for compact item codes and column headings.

Headers

Responses

• 200The groups, with ETag.

  {
    "api_version": "v1",
    "organisation": { "id": "uuid", "name": "Example Builders" },
    "takeoff_groups": [
      {
        "id": "uuid",
        "name": "Wall Framing",
        "abbreviation": "WF",
        "description": "Studs, plates, noggins and lintels.",
        "sort_index": 3,
        "updated_at": "2026-08-27T04:05:06.000Z"
      }
    ]
  }

• 304Unchanged; reuse the cached body.
• 401Token missing, malformed, unknown, or revoked.
• 500The groups could not be loaded.

Example

curl https://app.basegrid.com.au/api/v1/takeoff-groups \
  -H "Authorization: Bearer bgc_…"

Create an account and organisation

Request body · application/json

Responses

• 201Signed in immediately.

  { "redirectTo": "/app" }

• 202Email confirmation required before the session exists.

  { "notice": "Check you@example.com — we've sent a link to confirm your account." }

• 400Validation failed or the email is taken.

  { "error": "Human-readable message." }

Sign in with email and password

Request body · application/json

Responses

• 200Cookies set.

  { "redirectTo": "/app" }

• 401Those details didn't match an account.

  { "error": "Human-readable message." }

Example

curl https://app.basegrid.com.au/api/auth/login \
  -H "Content-Type: application/json" \
  -d '{"email":"you@example.com","password":"…"}' -c cookies.txt

Sign out

Responses

• 200Session cleared.

  { "redirectTo": "/login" }

List takeoff groups

Responses

• 200Ordered by sort_index, then name.

  {
    "takeoffGroups": [
      { "id": "uuid", "org_id": "uuid", "name": "Wall Framing", "abbreviation": "WF",
        "description": null, "sort_index": 3,
        "created_at": "2026-08-27T…", "updated_at": "2026-08-27T…" }
    ]
  }

Create a takeoff group

New groups are appended to the end of the order.

Request body · application/json

Responses

• 201Created.

  { "takeoffGroup": { … } }

• 409Name or abbreviation already used.

  { "error": "Human-readable message." }

Example

curl https://app.basegrid.com.au/api/takeoff-groups -b cookies.txt \
  -H "Content-Type: application/json" \
  -d '{"name":"Wall Framing","abbreviation":"WF"}'

Update a takeoff group

Send only the fields to change. At least one is required.

Request body · application/json

Responses

• 200Updated.

  { "takeoffGroup": { … } }

• 404Not found in your organisation.

  { "error": "Human-readable message." }

• 409Name or abbreviation already used.

  { "error": "Human-readable message." }

Delete a takeoff group

Responses

• 200Deleted (or already gone).

  { "deleted": true }

The tool catalogue with this organisation's available groups

Responses

• 200Every tool with its assigned group ids. roles is the compatibility view for older extensions and mirrors the tool's groups.

  {
    "tools": [
      {
        "id": "concrete.slab_from_face",
        "name": "Concrete Slab",
        "status": "active",
        "description": "…",
        "takeoff_group_ids": ["uuid"],
        "roles": [
          { "id": "concrete.slab_from_face.slab_body", "name": "Slab body", "unit": "m3",
            "takeoff_group_ids": ["uuid"] }
        ]
      },
      { "id": "structure.beam", "name": "Beam", "status": "active", "description": "…",
        "takeoff_group_ids": [], "roles": [] }
    ]
  }

Replace the groups a tool may offer

Sets the complete list for the caller's organisation. Groups must belong to your organisation and be active; a retired group may be kept if it is already assigned but cannot be newly added. Changes the material-library ETag.

Request body · application/json

Responses

• 200Saved.

  { "tool_id": "concrete.slab_from_face", "takeoff_group_ids": ["uuid"] }

• 400Unknown group, or a retired group newly added.

  { "error": "Human-readable message." }

• 404Unknown tool.

  { "error": "Human-readable message." }

Example

curl -X PUT https://app.basegrid.com.au/api/sketchup-tools/concrete.slab_from_face/takeoff-groups   -b cookies.txt -H "Content-Type: application/json"   -d '{"takeoff_group_ids":["<uuid>"]}'

Deprecated: replace a role's groups

Retained for the extension's compatibility window. Configuration is now per tool, so this writes to the role's tool — identical to PUT /api/sketchup-tools/{toolId}/takeoff-groups — and will be removed once the extension migration is confirmed.

Request body · application/json

Responses

• 200Saved.

  { "role_id": "concrete.slab_from_face.slab_body", "tool_id": "concrete.slab_from_face", "takeoff_group_ids": ["uuid"] }

• 400Unknown group, or a retired group newly added.

  { "error": "Human-readable message." }

• 404Unknown role.

  { "error": "Human-readable message." }

Create a material type

Request body · application/json

Responses

• 201Created.

  { "materialType": { … }, "redirectTo": "/app/materials/<id>" }

• 409A type with that name exists.

  { "error": "Human-readable message." }

Rename a material type

Request body · application/json

Responses

• 200Renamed.

  { "materialType": { … } }

• 404Not found in your organisation.

  { "error": "Human-readable message." }

• 409A type with that name exists.

  { "error": "Human-readable message." }

Delete a material type and its materials

Responses

• 200Deleted.

  { "deleted": true, "redirectTo": "/app/materials" }

Add a material to a type

Multipart form. Dimension fields are accepted only if the type's profile uses them, and the profile's required dimensions must be present. Appearance fields describe the construction texture; repeat them with a display_ prefix for the optional display texture. Images must be JPEG, PNG or WebP and 256 KB or smaller.

Request body · multipart/form-data

Responses

• 201Created.

  { "material": { … } }

• 400Validation or image problem.

  { "error": "Human-readable message." }

• 404That material type no longer exists.

  { "error": "Human-readable message." }

Update a material

Send only the fields to change. Use it to rename, set grade/finish, retire, or assign textures: texture_id (construction) and display_texture_id (display) must be textures in your organisation; null clears them. fit is fitted (stretch to the face) or natural (tile at the texture's physical size); when natural, send the size pair.

Request body · application/json

Responses

• 200Updated.

  { "material": { … } }

• 404Material or texture not found in your organisation.

  { "error": "Human-readable message." }

Example

curl -X PATCH https://app.basegrid.com.au/api/materials/<id> -b cookies.txt \
  -H "Content-Type: application/json" \
  -d '{"texture_id":"<texture uuid>","texture_fit":"natural","texture_width_mm":200,"texture_height_mm":200}'

Delete a material

Query parameters

Responses

• 200Deleted.

  { "deleted": true }

List textures

Query parameters

Responses

• 200Ordered by name.

  {
    "textures": [
      {
        "id": "uuid", "name": "40MPa", "kind": "labelled",
        "image_url": "material-textures/<org>/<file>.png", "source_image_url": null, "color": null,
        "aspect_ratio": 1, "width_mm": 200, "height_mm": 200,
        "format": {
          "background": "#b8b8b8", "background_opacity": 1,
          "text": "40MPa", "text_color": "#101614",
          "font_family": "sans", "font_size_percent": 18, "font_weight": 400,
          "text_align": "center", "vertical_align": "middle",
          "line_height": 1.05, "padding_percent": 8
        },
        "created_at": "…", "updated_at": "…"
      }
    ]
  }

Create a solid or labelled texture

Formatting fields are optional and default to the values shown in the list example (centred, 18 % of height, weight 400, ink #101614, 8 % padding). Use \n in text for multiple lines. Labelled textures need text, width_mm and height_mm; the image is rendered 512 px on its long side and must come out under 256 KB.

Request body · application/json

Responses

• 201Created.

  { "texture": { … } }

• 400Validation failed.

  { "error": "Human-readable message." }

• 500Rendering or upload failed.

  { "error": "Human-readable message." }

Example

curl https://app.basegrid.com.au/api/textures -b cookies.txt \
  -H "Content-Type: application/json" \
  -d '{"kind":"labelled","text":"40MPa","background":"#b8b8b8","width_mm":200,"height_mm":200}'

# Text over a picture
curl https://app.basegrid.com.au/api/textures -b cookies.txt   -F kind=labelled -F text="Exposed Aggregate" -F background=#000000 -F background_opacity=0.25   -F width_mm=600 -F height_mm=600 -F image=@exposed-agg.jpg

Get a texture

Includes one-hour signed_url (the rendered texture) and source_signed_url (the picture under a label); null where there is no stored file.

Responses

• 200The texture.

  { "texture": { …, "signed_url": "https://…", "source_signed_url": null } }

• 404Not found in your organisation.

  { "error": "Human-readable message." }

Edit a texture's formatting, size, picture or name

Any subset of the create fields except kind, as JSON or multipart. Solid and labelled textures are re-rendered (a label over a picture is re-composited from the stored source) and superseded files removed; materials using the texture pick up the change. Uploaded image-kind textures accept only name.

Request body · application/json

Responses

• 200Updated.

  { "texture": { … } }

• 404Not found in your organisation.

  { "error": "Human-readable message." }

• 409Formatting sent for an uploaded image.

  { "error": "Human-readable message." }

Example

curl -X PATCH https://app.basegrid.com.au/api/textures/<id> -b cookies.txt \
  -H "Content-Type: application/json" \
  -d '{"text":"40MPa\nN40","font_weight":600,"background":"#b0b0ab"}'

Delete a texture

Materials and types that used it fall back to no texture.

Responses

• 200Deleted.

  { "deleted": true }

Create a project

Request body · application/json

Responses

• 201Created.

  { "project": { "id": "uuid", "code": "029BRO", "name": "…", "address": "…" }, "redirectTo": "/app/projects/<id>" }

• 409Project code already in use.

  { "error": "Human-readable message." }

Add a takeoff item

Request body · application/json

Responses

• 201Created, tagged, source manual.

  { "item": { … } }

Remove a takeoff item

Responses

• 200Deleted.

  { "deleted": true }

Rename the workspace

Request body · application/json

Responses

• 200Renamed.

  { "org": { "id": "uuid", "name": "…" } }

Invite someone

Request body · application/json

Responses

• 201Invite created. token is the only delivery mechanism — put it in /invite/{token} and send that.

  { "invite": { "id": "…", "email": "…", "role": "member", "token": "…", "expires_at": "…" } }

• 409That person already has a pending invite.

  { "error": "Human-readable message." }

Withdraw an invite

Responses

• 200Deleted.

  { "deleted": true }

Start a subscription checkout

Responses

• 200Stripe Checkout URL.

  { "url": "https://checkout.stripe.com/…" }

• 503Stripe is not configured.

  { "error": "Human-readable message." }

Open the customer portal

Responses

• 200Stripe portal URL.

  { "url": "https://billing.stripe.com/…" }

• 409No Stripe customer for this workspace yet.

  { "error": "Human-readable message." }

• 503Stripe is not configured.

  { "error": "Human-readable message." }

Stripe webhook receiver

Receives subscription lifecycle events and writes billing state to the organisation with the service role. Not for client use.

Responses

• 200Event handled.