Finance

List projects

Retrieve matching projects.

GET/v1/projects

Query parameters

filter[id] string

Filter projects by id. Use operator.value syntax.

eq, neq, in, is operators

Exampleeq.01JQ2T5Y5Q3R8W9N6M4K2H7P1A
filter[clientId] string

Filter projects by clientId. Use operator.value syntax.

eq, neq, in, is operators

Exampleeq.01JQ2T5Y5Q3R8W9N6M4K2H7P1C
filter[name] string

Filter projects by name. Use operator.value syntax.

eq, neq, in, is operators

Exampleeq.example
filter[description] string

Filter projects by description. Use operator.value syntax.

eq, neq, gt, gte, lt, lte, in, is operators

Exampleeq.example
filter[website] string

Filter projects by website. Use operator.value syntax.

eq, neq, in, is operators

Exampleeq.example
filter[tags] string

Filter projects by tags. Use operator.value syntax.

in, is operators

Examplein.(example)
filter[createdAt] string

Filter projects by createdAt. Use operator.value syntax.

eq, neq, gt, gte, lt, lte, is operators

Exampleeq.2026-01-15T12:00:00Z
filter[updatedAt] string

Filter projects by updatedAt. Use operator.value syntax.

eq, neq, gt, gte, lt, lte, is operators

Exampleeq.2026-01-15T12:00:00Z
select string

Comma-separated fields. Select a declared relation with relation(field,field).

declared fields and relations only

Exampleid,clientId
order string

Order by field.asc or field.desc. Repeat fields with commas.

repeat fields separated by commas

Exampleid.asc,clientId.asc
limit integer

Maximum records returned. Defaults to 25.

1 to 1000

Example25
cursor string

Opaque continuation cursor returned by the previous page.

Exampleopaque-cursor
count string

Request an exact count. This may cost more than a normal page.

exact

Exampleexact
Query options

Use filter, select, order, limit, cursor, count, search. The default limit is 25; the maximum is 1000.

Filterable: id, clientId, name, description, website, tags, createdAt, updatedAt.

Selectable: id, clientId, name, description, website, tags, createdAt, updatedAt, clientName, clientWebsite, clientType, contacts, invoices, invoiceAmount, payouts, payoutAmount, paidPayouts, paidPayoutAmount, pendingPayouts, pendingPayoutAmount, invoicePendingCount, invoicePaidCount, invoiceCancelledCount, payoutPendingCount, payoutPaidCount, payoutCancelledCount, pendingAmount, paidAmount, cancelledAmount, invoicePendingAmount, invoicePaidAmount, invoiceCancelledAmount, payoutPendingAmount, payoutPaidAmount, payoutCancelledAmount, pendingRecords, paidRecords, cancelledRecords, expenses, expenseAmount, contactItems, invoiceItems, payoutItems, invoicePendingItems, invoicePaidItems, invoiceCancelledItems, payoutPendingItems, payoutPaidItems, payoutCancelledItems, paidPayoutItems, pendingPayoutItems, expenseItems.

Sortable: id, clientId, name, description, website, createdAt, updatedAt.

Errors: invalid_input, query_invalid, unauthenticated, not_found, forbidden, plan_limit, conflict, rate_limited, request_quota, unavailable, internal_error.

Headers

authorization string required

Bearer workspace API key.

ExampleBearer $NQD_API_KEY
workspace-id string required

Workspace scope for the request. Required for workspace operations and must belong to the authenticated identity.

Minimum length: 1 character. · Maximum length: 128 characters.

Example01JQ2T5Y5Q3R8W9N6M4K2H7P1A

Response

200Success

Response headers

x-request-id string

Correlation identifier returned with every response for support and request tracing.

Example550e8400-e29b-41d4-a716-446655440000
data object[]

Returned records. Collections and batches use an array; single records use an object.

ShowHide 52 properties
data[].id string

Opaque identifier for this resource or reference.

Example01JQ2T5Y5Q3R8W9N6M4K2H7P1D
data[].clientId string

Optional client reference. Null means the current workspace owns the record; do not create a placeholder client.

Examplenull
data[].name string

Display name of the record.

ExampleNQD record
data[].description string

Optional human-readable description of the record.

ExampleConsulting services for January 2026
data[].website string

website for this project.

Examplehttps://example.com/hooks/nqd
data[].tags string[]

Tags assigned to the record.

Example1 item
data[].clientName string nullable

client name for this project.

ExampleConsulting services
data[].clientWebsite string[] nullable

client website for this project.

Example1 item
data[].clientType string nullable

client type for this project.

Allowed values: "company", "individual", "government"

Examplecompany
data[].contacts number | string nullable

contacts for this project.

One of: number alternative 1, string alternative 2

Example100
data[].invoices number | string nullable

invoices for this project.

One of: number alternative 1, string alternative 2

Example100
data[].invoiceAmount number | string | string nullable

Exact decimal string used for financial calculations. Do not round or convert it to a display number.

Example100
data[].payouts number | string nullable

payouts for this project.

One of: number alternative 1, string alternative 2

Example100
data[].payoutAmount number | string | string nullable

Exact decimal string used for financial calculations. Do not round or convert it to a display number.

Example100
data[].paidPayouts number | string nullable

paid payouts for this project.

One of: number alternative 1, string alternative 2

Example100
data[].paidPayoutAmount number | string | string nullable

Exact decimal string used for financial calculations. Do not round or convert it to a display number.

Example100
data[].pendingPayouts number | string nullable

pending payouts for this project.

One of: number alternative 1, string alternative 2

Example100
data[].pendingPayoutAmount number | string | string nullable

Exact decimal string used for financial calculations. Do not round or convert it to a display number.

Example100
data[].invoicePendingCount number | string nullable

invoice pending count for this project.

One of: number alternative 1, string alternative 2

Example100
data[].invoicePaidCount number | string nullable

invoice paid count for this project.

One of: number alternative 1, string alternative 2

Example100
data[].invoiceCancelledCount number | string nullable

invoice cancelled count for this project.

One of: number alternative 1, string alternative 2

Example100
data[].payoutPendingCount number | string nullable

payout pending count for this project.

One of: number alternative 1, string alternative 2

Example100
data[].payoutPaidCount number | string nullable

payout paid count for this project.

One of: number alternative 1, string alternative 2

Example100
data[].payoutCancelledCount number | string nullable

payout cancelled count for this project.

One of: number alternative 1, string alternative 2

Example100
data[].pendingAmount number | string | string nullable

Exact decimal string used for financial calculations. Do not round or convert it to a display number.

Example100
data[].paidAmount number | string | string nullable

Exact decimal string used for financial calculations. Do not round or convert it to a display number.

Example100
data[].cancelledAmount number | string | string nullable

Exact decimal string used for financial calculations. Do not round or convert it to a display number.

Example100
data[].invoicePendingAmount number | string | string nullable

Exact decimal string used for financial calculations. Do not round or convert it to a display number.

Example100
data[].invoicePaidAmount number | string | string nullable

Exact decimal string used for financial calculations. Do not round or convert it to a display number.

Example100
data[].invoiceCancelledAmount number | string | string nullable

Exact decimal string used for financial calculations. Do not round or convert it to a display number.

Example100
data[].payoutPendingAmount number | string | string nullable

Exact decimal string used for financial calculations. Do not round or convert it to a display number.

Example100
data[].payoutPaidAmount number | string | string nullable

Exact decimal string used for financial calculations. Do not round or convert it to a display number.

Example100
data[].payoutCancelledAmount number | string | string nullable

Exact decimal string used for financial calculations. Do not round or convert it to a display number.

Example100
data[].pendingRecords number | string nullable

pending records for this project.

One of: number alternative 1, string alternative 2

Example100
data[].paidRecords number | string nullable

paid records for this project.

One of: number alternative 1, string alternative 2

Example100
data[].cancelledRecords number | string nullable

cancelled records for this project.

One of: number alternative 1, string alternative 2

Example100
data[].expenses number | string nullable

expenses for this project.

One of: number alternative 1, string alternative 2

Example100
data[].expenseAmount number | string | string nullable

Exact decimal string used for financial calculations. Do not round or convert it to a display number.

Example100
data[].contactItems object[] nullable

contact items for this project.

ShowHide 2 properties
data[].contactItems[].id string

Opaque identifier for this resource or reference.

Example01JQ2T5Y5Q3R8W9N6M4K2H7P1D
data[].contactItems[].label string

Human-readable label for the value.

ExampleOperating account
data[].invoiceItems object[] nullable

invoice items for this project.

ShowHide 2 properties
data[].invoiceItems[].id string

Opaque identifier for this resource or reference.

Example01JQ2T5Y5Q3R8W9N6M4K2H7P1D
data[].invoiceItems[].label string

Human-readable label for the value.

ExampleOperating account
data[].payoutItems object[] nullable

payout items for this project.

ShowHide 2 properties
data[].payoutItems[].id string

Opaque identifier for this resource or reference.

Example01JQ2T5Y5Q3R8W9N6M4K2H7P1D
data[].payoutItems[].label string

Human-readable label for the value.

ExampleOperating account
data[].invoicePendingItems object[] nullable

invoice pending items for this project.

ShowHide 2 properties
data[].invoicePendingItems[].id string

Opaque identifier for this resource or reference.

Example01JQ2T5Y5Q3R8W9N6M4K2H7P1D
data[].invoicePendingItems[].label string

Human-readable label for the value.

ExampleOperating account
data[].invoicePaidItems object[] nullable

invoice paid items for this project.

ShowHide 2 properties
data[].invoicePaidItems[].id string

Opaque identifier for this resource or reference.

Example01JQ2T5Y5Q3R8W9N6M4K2H7P1D
data[].invoicePaidItems[].label string

Human-readable label for the value.

ExampleOperating account
data[].invoiceCancelledItems object[] nullable

invoice cancelled items for this project.

ShowHide 2 properties
data[].invoiceCancelledItems[].id string

Opaque identifier for this resource or reference.

Example01JQ2T5Y5Q3R8W9N6M4K2H7P1D
data[].invoiceCancelledItems[].label string

Human-readable label for the value.

ExampleOperating account
data[].payoutPendingItems object[] nullable

payout pending items for this project.

ShowHide 2 properties
data[].payoutPendingItems[].id string

Opaque identifier for this resource or reference.

Example01JQ2T5Y5Q3R8W9N6M4K2H7P1D
data[].payoutPendingItems[].label string

Human-readable label for the value.

ExampleOperating account
data[].payoutPaidItems object[] nullable

payout paid items for this project.

ShowHide 2 properties
data[].payoutPaidItems[].id string

Opaque identifier for this resource or reference.

Example01JQ2T5Y5Q3R8W9N6M4K2H7P1D
data[].payoutPaidItems[].label string

Human-readable label for the value.

ExampleOperating account
data[].payoutCancelledItems object[] nullable

payout cancelled items for this project.

ShowHide 2 properties
data[].payoutCancelledItems[].id string

Opaque identifier for this resource or reference.

Example01JQ2T5Y5Q3R8W9N6M4K2H7P1D
data[].payoutCancelledItems[].label string

Human-readable label for the value.

ExampleOperating account
data[].paidPayoutItems object[] nullable

paid payout items for this project.

ShowHide 2 properties
data[].paidPayoutItems[].id string

Opaque identifier for this resource or reference.

Example01JQ2T5Y5Q3R8W9N6M4K2H7P1D
data[].paidPayoutItems[].label string

Human-readable label for the value.

ExampleOperating account
data[].pendingPayoutItems object[] nullable

pending payout items for this project.

ShowHide 2 properties
data[].pendingPayoutItems[].id string

Opaque identifier for this resource or reference.

Example01JQ2T5Y5Q3R8W9N6M4K2H7P1D
data[].pendingPayoutItems[].label string

Human-readable label for the value.

ExampleOperating account
data[].expenseItems object[] nullable

expense items for this project.

ShowHide 2 properties
data[].expenseItems[].id string

Opaque identifier for this resource or reference.

Example01JQ2T5Y5Q3R8W9N6M4K2H7P1D
data[].expenseItems[].label string

Human-readable label for the value.

ExampleOperating account
data[].createdAt string

ISO 8601 timestamp for the authored or payment event. Recurring records preserve their scheduled occurrence.

Example2026-01-15T12:00:00.000Z
data[].updatedAt string

Timestamp used for stale-edit protection. Preserve the server value when updating.

Example2026-01-15T12:00:00.000Z
page object

Pagination metadata for the returned records, or the current page number when this endpoint uses numbered pages.

ShowHide 4 properties
page.limit number

Maximum number of records to return for this page.

Example1
page.hasMore boolean

Whether another page is available.

Examplefalse
page.nextCursor string

Opaque cursor for the next page, or null when there is no next page.

Examplenull
page.total number nullable

Total number of records that match the request.

Example1

Possible errors

400 Invalid request

Response headers

x-request-id string

Correlation identifier returned with every response for support and request tracing.

Example550e8400-e29b-41d4-a716-446655440000
error object

Error details returned for a failed request.

ShowHide 4 properties
error.code string

Stable machine-readable error or resource code.

Exampleinvalid_input
error.message string

Human-readable explanation of the result or error.

ExampleThe request could not be validated.
error.requestId string

Correlation identifier for support and request tracing.

Example550e8400-e29b-41d4-a716-446655440000
error.details object nullable

Additional structured details about the result or error.

ShowHide 1 property
error.details.issues object[]

Structured field issues returned when request validation fails.

ShowHide 3 properties
error.details.issues[].path string | number[]

Field path where the validation issue occurred.

One of: string alternative 1, number alternative 2

Example0 items
error.details.issues[].reason string

Machine-readable reason for the validation issue.

Allowed values: "expected_type", "required", "unexpected_property", "invalid_value", "invalid_json", "invalid_query", "unsupported_media_type", "body_too_large", "body_timeout", "conflicting_scope", "missing_header", "concurrency_required", "invalid_resource_id", "invalid_request"

Exampleinvalid_request
error.details.issues[].code string nullable

Stable machine-readable error or resource code.

Exampleinvalid_input
Example 400 response
{
  "error": {
    "code": "invalid_input",
    "message": "The request could not be validated.",
    "requestId": "550e8400-e29b-41d4-a716-446655440000",
    "details": {
      "issues": [
        {
          "path": [],
          "reason": "invalid_request"
        }
      ]
    }
  }
}
View raw OpenAPI operation

Use the machine-readable contract for client generation and payload validation.

Open OpenAPI contract ↗