Skip to main content
GET
/
api
/
v1
/
projects
List projects
curl --request GET \
  --url https://api.contracting.kukkingu.software/api/v1/projects \
  --header 'Authorization: Bearer <token>' \
  --header 'tenant-id: <tenant-id>'
{
  "data": [
    {
      "id": "prj_8f4d4gk1p9h2x0s7v3n5c1a9",
      "contract": "ctr_z23aoo8naxk68ewcr64tchh5",
      "name": "Website Redesign",
      "createdAt": "2023-10-05T14:48:00.000Z",
      "updatedAt": "2023-10-05T14:48:00.000Z",
      "description": "Revamp the corporate website for the 2025 launch.",
      "order": 13
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
tenant-id
string
required

Specifies the tenant context for the request. All endpoints operate within this tenant scope.

Example:

"tnt_pfh0haxfpzowht3oi213cqos"

Query Parameters

​
expand
string

Comma-separated list of relations to expand. Allowed values: contract, contract.client.

Example:

"contract,contract.client"

​
contractId
string

The ID of the contract.

Example:

"ctr_z23aoo8naxk68ewcr64tchh5"

​
sort
string

Comma-separated list of sort clauses in "field:direction" format. Allowed fields: name, order, createdAt, updatedAt, contract.name. Allowed directions: asc, desc.

Example:

"name:asc,order:desc"

Response

Default Response

Standard success response payload wrapped in a data property.

​
data
object[]
required

List of projects returned by the API.