GET/api/v1/client-contract-lines

Product availabilityAlgaPSA

List client contract lines

Lists client contract lines — contract_lines rows that belong to client contracts (joined via contract_id), with the owning client_id and client_contract_id surfaced. Supports client_id, contract_line_id, service_category, is_active, has_custom_rate, and start/end-date-range filters plus page/limit pagination. Authenticated and tenant-scoped via withApiKeyRouteAuth.

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

client_idstring <uuid>Optional

contract_line_idstring <uuid>Optional

service_categorystringOptional

is_activestringOptional

has_custom_ratestringOptional

is_contractdstringOptional

start_date_fromstring <date-time>Optional

start_date_tostring <date-time>Optional

end_date_fromstring <date-time>Optional

end_date_tostring <date-time>Optional

Response body

Success response 200 · schema ClientContractLineListEnvelope

dataobjectRequired

dataarray of ClientContractLineResourceRequired

itemsobject

client_contract_line_idstring <uuid>Required

client_idstring <uuid>Required

contract_line_idstring <uuid>Required

service_categorystringNullable

start_datestring <date-time>Required

end_datestring <date-time>Nullable

is_activebooleanRequired

custom_ratenumberNullable

client_contract_idstring <uuid>Nullable

tenantstring <uuid>

totalintegerRequired

≥ 0

metaobject

Response codes

200

Paginated client contract lines returned.

400

Invalid query parameters.

401

x-api-key missing/invalid.

500

Unhandled failure.

GET /api/v1/client-contract-lines

cURL

curl -X GET "https://algapsa.com/api/v1/client-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/client-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/client-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

{
  "data": {
    "data": [
      {
        "client_contract_line_id": "01HN2K7VRB9PQ3Y0000000000",
        "client_id": "01HN2K7VRB9PQ3Y0000000000",
        "contract_line_id": "01HN2K7VRB9PQ3Y0000000000",
        "service_category": "string",
        "start_date": "2026-04-18T15:22:14Z",
        "end_date": "2026-04-18T15:22:14Z",
        "is_active": false,
        "custom_rate": 0,
        "client_contract_id": "01HN2K7VRB9PQ3Y0000000000",
        "tenant": "01HN2K7VRB9PQ3Y0000000000"
      }
    ],
    "total": 0
  },
  "meta": {}
}