Fieldmotion API Getting started

Contracts

Get legacy-linked contract jobs

POST /a/Contracts_getJobs

Return every tenant contract with the job IDs held in its legacy relationship rows.

When to use this endpoint

Use Contracts_getJobs only for compatibility code that needs a complete contract-to-legacy-link map.

For a filtered/paged contract list, use the mapped or DataTables endpoints instead.

Authentication and permissions

The request must authenticate with signed API-key fields or a logged-in CRM session. The handler performs no additional page or role-permission check.

The lookup and any write use the authenticated tenant; an ID from another tenant cannot be addressed through this call.

Parameters

This endpoint has no operation-specific parameters.

Example request

$contracts = FM_api('Contracts_getJobs', []);

Example response

[
  {
    "id": "720",
    "name": "North Region Service Contract",
    "appointments": [2039001, 2039002]
  }
]

The exact legacy response key appointments is a native JSON array of integer job IDs, unlike several other contract routes that return an encoded string.

Errors and unusual responses

ResponseCondition
{"error":"not logged in"}No authenticated tenant context is available. Invalid signed credentials can be rejected by the dispatcher before the handler runs.
[]The tenant has no contract rows.

Legacy application errors may be returned with HTTP 200. Check the decoded response for error, not only the HTTP status.

Behaviour and edge cases

  • There is one additional link query per contract, with no deleted filter, ordering, pagination, or maximum row count.
  • Contract ID/name values remain database strings; each link ID is converted to an integer.

See it in Fieldmotion

CRM1

No direct production CRM1 caller was found.

CRM2

No current production CRM2 client call was found; regression coverage protects this compatibility data shape.

Related endpoints