Projects

Projects are reached at /rest/v1/project. All requests need the headers described in Authentication.

List projects

Returns the projects belonging to your company.

GET /rest/v1/project

string

default:"*"

Columns to return. Use * for all columns, or a comma-separated list such as id,project_name to reduce the payload.

curl -X GET "https://fqtlkdttexdbenjqgdzg.supabase.co/rest/v1/project?select=*" \
  -H "apikey: YOUR_API_KEY" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "X-API-Secret: YOUR_API_SECRET"

const res = await fetch(
  'https://fqtlkdttexdbenjqgdzg.supabase.co/rest/v1/project?select=*',
  {
    headers: {
      apikey: process.env.BIDENGINE_API_KEY,
      Authorization: `Bearer ${process.env.BIDENGINE_API_KEY}`,
      'X-API-Secret': process.env.BIDENGINE_API_SECRET,
    },
  }
);

const projects = await res.json();

import os
import requests

response = requests.get(
    "https://fqtlkdttexdbenjqgdzg.supabase.co/rest/v1/project",
    params={"select": "*"},
    headers={
        "apikey": os.environ["BIDENGINE_API_KEY"],
        "Authorization": f"Bearer {os.environ['BIDENGINE_API_KEY']}",
        "X-API-Secret": os.environ["BIDENGINE_API_SECRET"],
    },
)

print(response.json())

The response is a JSON array of project objects.

Create a project

POST /rest/v1/project

string

required

UUID of the bid this project belongs to.

string

required

Human-readable name for the project.

curl -X POST "https://fqtlkdttexdbenjqgdzg.supabase.co/rest/v1/project" \
  -H "apikey: YOUR_API_KEY" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "X-API-Secret: YOUR_API_SECRET" \
  -H "Content-Type: application/json" \
  -d '{
    "bid_id": "some-uuid-for-bid",
    "project_name": "New Kitchen Remodel"
  }'

const res = await fetch(
  'https://fqtlkdttexdbenjqgdzg.supabase.co/rest/v1/project',
  {
    method: 'POST',
    headers: {
      apikey: process.env.BIDENGINE_API_KEY,
      Authorization: `Bearer ${process.env.BIDENGINE_API_KEY}`,
      'X-API-Secret': process.env.BIDENGINE_API_SECRET,
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      bid_id: 'some-uuid-for-bid',
      project_name: 'New Kitchen Remodel',
    }),
  }
);

import os
import requests

response = requests.post(
    "https://fqtlkdttexdbenjqgdzg.supabase.co/rest/v1/project",
    headers={
        "apikey": os.environ["BIDENGINE_API_KEY"],
        "Authorization": f"Bearer {os.environ['BIDENGINE_API_KEY']}",
        "X-API-Secret": os.environ["BIDENGINE_API_SECRET"],
        "Content-Type": "application/json",
    },
    json={
        "bid_id": "some-uuid-for-bid",
        "project_name": "New Kitchen Remodel",
    },
)

bid_id must reference an existing bid. Posting a UUID that doesn’t resolve will be rejected.

⌘I

Getting started

Reports

Proposals

API reference

List projects

Create a project

​List projects

​Create a project

List projects

Create a project