Retrieve list of agreements

GET

/v1/agreements

Get a paginated list of agreements with optional filters.

Required scope: workorders:read

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Query Params

Responses

🟢200

application/json

Agreements retrieved successfully

Bodyapplication/json

🟠400

🟠401

🟠403

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.fieldedge.com/open-api/v1/agreements?id=&agreementNumber=&customerId=&agreementPlanName=&billFromOffice=&active=&beforeOriginalContractDate=&afterOriginalContractDate=&beforeNextServiceDate=&afterNextServiceDate=&beforeNextInvoiceDate=&sinceNextInvoiceDate=&sort=&offset=&limit=' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example agreement list response

{
    "total": 1,
    "limit": 20,
    "offset": 0,
    "data": [
        {
            "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
            "customerId": "b2c3d4e5-f6a7-48b9-0c1d-e2f3a4b5c6d7",
            "agreementNumber": "AGR-10042",
            "agreementPlanName": "Gold Maintenance Plan",
            "agreementPlanDescription": "Annual HVAC maintenance with priority service.",
            "originalContractDate": "2023-06-15T00:00:00.0000000Z",
            "renewalDate": "2026-06-15T00:00:00.0000000Z",
            "billFromOffice": true,
            "active": true,
            "nextInvoiceDate": "2026-06-15T00:00:00.0000000Z",
            "nextServiceDate": "2026-05-01T00:00:00.0000000Z",
            "agreementPlanDiscountApplied": 10
        }
    ]
}

Modified at 2026-08-27 11:27:00

Retrieve work orders at a given address, most recent first

Retrieve agreement by id.