cURL
Contract Container Templates
List Contract Container Templates
Retrieve active ContractContainer templates for your organization
GET
cURL
Returns active ContractContainer templates available to your organization. Each item describes one template, including its underlying producer-agreement PDF and any additional folder documents.
The invite call uses the top-level
Which ID do I send on invite?
Each template carries three different IDs. Use the top-level_id as contractContainerTemplateId when calling Invite Downstream Entity.
| Field in response | What it identifies | When to use it |
|---|---|---|
_id (top-level) | The ContractContainer template itself | contractContainerTemplateId on the invite endpoint |
producerAgreement.fileDocumentId | The PDF behind the producer-agreement document | Downloading the PDF via List File Documents |
additionalDocuments[].fileDocumentId | A PDF inside the template’s folder set | Downloading that document via List File Documents |
_id is the only value the invite endpoint accepts as contractContainerTemplateId. Sending one of the fileDocumentId values instead will return 400 No active contract template found for that contractContainerTemplateId.Example
Given a response item like:_id:
Response
Active ContractContainer templates for your organization. Use the returned _id as contractContainerTemplateId on POST /v1/downstream-entity-associations/invite.