Soon the List Agreements and List Templates API endpoints will stop returning nested, agreement-type-specific data by default. If your integration only reads top-level fields from these endpoints, no action is needed. If it reads nested data, you'll need to add a query parameter to keep getting the full response.

Today, GET /v1/agreements and GET /v1/templates return each record's top-level metadata plus all of its nested, agreement-type-specific attributes, including:

Once released these two endpoints will return top-level metadata only. The nested attributes above will no longer be included in list responses.

If your integration reads any of the nested attributes above from the list endpoints, add a full=true query parameter to your requests to keep getting today's full response shape:

That's the entire change on your end - you don't need to restructure calls or fetch records individually.

If your integration only reads top-level fields (such as status, agreement_type, recipient_organization, or effective_date) from these endpoints, no changes are needed.

Today's list responses include the full nested data for every result, which makes payloads large and list calls slower than they need to be. Scoping list endpoints to metadata only keeps them fast, and the per-record endpoint still gives you full data when you need it.

This change takes effect on July 28, 2026 for both endpoints. We recommend updating any code that depends on nested attributes from the list endpoints before that date.

NOTE: If this timeline presents a hardship, contact support - we can work with you on a solution.

For the full endpoint reference, see the Common Paper API docs.