GET/api/v1/contracts

Product availabilityAlgaPSA

List contracts

Lists contracts via ApiContractLineController.listContracts() (v2 controller mounted under v1 route).

RBAC · contract_line

Query parameters

pagestringOptional

limitstringOptional

sortstringOptional

orderstringOptional

searchstringOptional

statusstringOptional

include_itemsstringOptional

include_clientstringOptional

Response body

Success response 200 · schema ContractsApiPaginatedV1

dataarray of ContractListItemV1Required

itemsobject

Contract header as returned by the list endpoint; see contractResponseSchema for the full field set.

contract_idstring <uuid>Required

contract_namestringRequired

start_datestring <date-time>Nullable

Earliest start_date across the contract's client assignments (client_contracts); MIN ignores assignments with a null start_date. Falls back to the contract's own stored start_date only when the contract has no assignments.

end_datestring <date-time>Nullable

Latest end_date across the contract's client assignments (client_contracts); MAX ignores assignments with a null (open-ended) end_date. Falls back to the contract's own stored end_date only when the contract has no assignments.

total_plansinteger

Count of contract lines on the contract.

clients_using_contractinteger

Count of distinct clients assigned the contract.

paginationobject

pageintegerRequired

limitintegerRequired

totalintegerRequired

totalPagesintegerRequired

metaobject

_linksobject

Response codes

200

Paginated contracts returned.

400

Validation or request parsing failure.

401

API key missing/invalid or associated user missing.

403

RBAC denied for contract resource action.

500

Unexpected controller/service failure.

GET /api/v1/contracts

cURL

curl -X GET "https://algapsa.com/api/v1/contracts?page=string&limit=string&sort=string&order=asc&search=string&status=string" \
  -H "X-API-Key: $ALGA_API_KEY"

TypeScript

const response = await fetch("https://algapsa.com/api/v1/contracts?page=string&limit=string&sort=string&order=asc&search=string&status=string", {
  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/contracts?page=string&limit=string&sort=string&order=asc&search=string&status=string");
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": [
    {
      "contract_id": "01HN2K7VRB9PQ3Y0000000000",
      "contract_name": "string",
      "start_date": "2026-04-18T15:22:14Z",
      "end_date": "2026-04-18T15:22:14Z",
      "total_plans": 1,
      "clients_using_contract": 1
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 1,
    "total": 1,
    "totalPages": 1
  },
  "meta": {},
  "_links": {}
}