Skip to main content
GET
List projects

Authorizations

x-api-key
string
header
required

API key for authentication. Get yours at app.heffl.com/settings/developers

Query Parameters

cursor
string

Cursor for pagination. Pass the previous response meta.nextCursor value to fetch the next page.

pageSize
integer
default:30

Number of items to return per page (max 100)

Required range: 1 <= x <= 100

Search by project title, number, or description

status
enum<string>

Filter by project status

Available options:
ACTIVE,
COMPLETED,
CANCELLED
type
enum<string>

Filter by project type

Available options:
flat_rate,
retainer
pipelineId
string

Filter by project pipeline ID (ppl_ prefix)

stageId
string

Filter by project pipeline stage ID (pps_ prefix)

clientId
string

Filter by client ID (clt_ prefix)

projectLeadId
string

Filter by project lead user ID (usr_ prefix)

Response

OK

data
object[]
required
meta
object
required