GET/api/v1/contract-lines

Product availabilityAlgaPSA

List contract lines

Lists contract lines with pagination/filtering and optional include flags. Route requires x-api-key at middleware and a request context in-controller (requireRequestContext). Query parsing/validation uses contractLineListQuerySchema, then listWithOptions reads from contract_lines for the tenant context.

Query parameters

pagestringOptional

limitstringOptional

sortstringOptional

orderstringOptional

searchstringOptional

created_fromstring <date-time>Optional

created_tostring <date-time>Optional

updated_fromstring <date-time>Optional

updated_tostring <date-time>Optional

contract_line_namestringOptional

contract_line_typestringOptional

billing_frequencystringOptional

is_customstringOptional

is_activestringOptional

service_categorystringOptional

has_servicesstringOptional

clients_count_minstringOptional

clients_count_maxstringOptional

revenue_minstringOptional

revenue_maxstringOptional

include_servicesstringOptional

Controller-level include flag parsed directly from query string.

include_usagestringOptional

Controller-level include flag parsed directly from query string.

include_clientsstringOptional

Controller-level include flag parsed directly from query string.

Response body

Success response 200 · schema ContractLineApiSuccess

successbooleanRequired

Enum: true

dataanyOfRequired

anyOf (option 1)object

anyOf (option 2)array of object

itemsobject

metaobject

timestampstring <date-time>Required

versionstringRequired

Response codes

200

Contract lines returned.

400

Invalid query parameters.

401

x-api-key missing at middleware.

500

Request context missing or unhandled service failure.

GET /api/v1/contract-lines

cURL

curl -X GET "https://algapsa.com/api/v1/contract-lines?page=string&limit=string&sort=string&order=asc&search=string&created_from=2026-04-18T15%3A22%3A14Z" \
  -H "X-API-Key: $ALGA_API_KEY"

TypeScript

const response = await fetch("https://algapsa.com/api/v1/contract-lines?page=string&limit=string&sort=string&order=asc&search=string&created_from=2026-04-18T15%3A22%3A14Z", {
  method: "GET",
  headers: {
    "X-API-Key": "$ALGA_API_KEY",
  }
});
const data = await response.json();

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://algapsa.com/api/v1/contract-lines?page=string&limit=string&sort=string&order=asc&search=string&created_from=2026-04-18T15%3A22%3A14Z");
request.Headers.TryAddWithoutValidation("X-API-Key", "$ALGA_API_KEY");
var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();

200 OK·application/json

{
  "success": true,
  "data": {},
  "meta": {
    "timestamp": "2026-04-18T15:22:14Z",
    "version": "string"
  }
}