v1
latestOpenAPI 3.1.02026-07-24770322.0 KBList Contracts
This API endpoint retrieves contracts.
get/v1/contracts
Query parameters
contractTemplateIdstring
The unique ID of the contract template the contract is associated with.
recipientIdstring
Deprecated: Use clientId
statusstring
The current state of the contract. Options are pending, signed
clientIdstring
The ID of the client that the contract was sent to.
Response
200
Example response
{
"data": [
{
"contractTemplateId": "09ee78d3-49c0-43e1-9f91-b21df8c72ff0",
"createdAt": "2024-01-17T18:47:34.822346931Z",
"fields": [
{
"id": "981c14d0-4fbd-43b6-9b33-6a34b298647c",
"inputType": "client",
"label": "signature_1",
"page": 1,
"type": "signature",
"value": "fddfgds"
}
],
"fileUrl": "https://copilot-user-files.s3.amazonaws.com/protected/us-east-1%3A785e4ea4-8cf8-4cea-a9cd-cdb6a5732c40/files/2024-01-11T18%3A13%3A08.734Z/Sample%20Contract.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIARGA4UFWVHA3RT66K%2F20240127%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240127T002527Z&X-Amz-Expires=900&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEPn%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCXVzLWVhc3QtMSJHMEUCIQDS2B1PS6MpfiQXFvf2CNCj%2BG4VdsT0J5Pnf4asHLN9VAIgb72%2FXqksakXH5%2BrdJ1Ni%2FT1TpoPTuyEtUNtCHkYhgIYqhwMIsv%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FARACGgwwODE2NjQ0MjEyOTAiDA3I%2BO82ftMARzr2yirbApkfm1rjUxfbXbTueuTrdBSH0Ryw4qUeT7%2Bt9OeN9agEKBdBxrOGckyHoLvUGgcUm9yQDcz5qOh6KFbM4A8oLuIKmYmUNbHu1GXEiX6bwlhWvxfohbbSydOVBR5HhbABf9VMYZWXE240u%2B9%2BLhC3A3KQDZ%2F7ccT7RVMqPkcdXPTNZ0nKgPeYivWBcebZzrOX9QdMKBuXzzxR%2F6HsvKtwhdKNMVzCtVSExyyZzjn09V19afP%2Ba55GBIUDyNbz6KnYg0NDL9AcTG%2Fvh7WMaImzCL8p2bO4Hf64oYjvBo306BFk0S8wak1d2FPEdcUPsfWNYMeKS6Xg%2Bt7L9okEmPyZ%2BbF1%2B1aEinM6JGimOJAIWQ1CjcbKQnfyn919zB1Uv1ovokNRd1oQv328lUnEC0CVtxkG%2FMNa2swAMlqdpPWURJBF2x6C5hk1cQGBXe4vkOyyjGku354NBntKjNqXMPWa0a0GOp4BfQ9KLCwakBMdIIkIXoS0OHNF%2FpNeAPvMTuw5gFwoh5aAR2MWjR4RkAtlnsQn0yYnSuBPRkwVJPDdF%2BgglIkrSPXzG1MxnrNfazXbDecw3R%2FzpmnXCJjRGG2cQTkWN4dJeHomceCkRRmutjQnhRAeWE1OjX8L%2BOpPqFn%2FzDpBG492Zj6DBIN8Lu8X2RXqnSoyzk3%2Bgx00FXryq9WdYR4%3D&X-Amz-SignedHeaders=host&X-Amz-Signature=23658b8379840a350e150e629d7a75f00b8f05c552a3274a1a22f9f8457ac102",
"id": "VnFNGo5IR",
"name": "API Testing",
"object": "contract",
"recipientId": "e960feb9-3b49-45b5-8e15-9202acced3ac",
"shareDate": "2024-01-17T18:47:34.813037333Z",
"signedFileUrl": "https://copilot-user-files.s3.amazonaws.com/protected/us-east-1%3A785e4ea4-8cf8-4cea-a9cd-cdb6a5732c40/files/2024-01-11T18%3A13%3A08.734Z/Sample%20Contract.pdf/VnFNGo5IR/Signed%20-%20API%20Testing%20by%20Client%20Two.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIARGA4UFWVHA3RT66K%2F20240127%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240127T002527Z&X-Amz-Expires=900&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEPn%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCXVzLWVhc3QtMSJHMEUCIQDS2B1PS6MpfiQXFvf2CNCj%2BG4VdsT0J5Pnf4asHLN9VAIgb72%2FXqksakXH5%2BrdJ1Ni%2FT1TpoPTuyEtUNtCHkYhgIYqhwMIsv%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FARACGgwwODE2NjQ0MjEyOTAiDA3I%2BO82ftMARzr2yirbApkfm1rjUxfbXbTueuTrdBSH0Ryw4qUeT7%2Bt9OeN9agEKBdBxrOGckyHoLvUGgcUm9yQDcz5qOh6KFbM4A8oLuIKmYmUNbHu1GXEiX6bwlhWvxfohbbSydOVBR5HhbABf9VMYZWXE240u%2B9%2BLhC3A3KQDZ%2F7ccT7RVMqPkcdXPTNZ0nKgPeYivWBcebZzrOX9QdMKBuXzzxR%2F6HsvKtwhdKNMVzCtVSExyyZzjn09V19afP%2Ba55GBIUDyNbz6KnYg0NDL9AcTG%2Fvh7WMaImzCL8p2bO4Hf64oYjvBo306BFk0S8wak1d2FPEdcUPsfWNYMeKS6Xg%2Bt7L9okEmPyZ%2BbF1%2B1aEinM6JGimOJAIWQ1CjcbKQnfyn919zB1Uv1ovokNRd1oQv328lUnEC0CVtxkG%2FMNa2swAMlqdpPWURJBF2x6C5hk1cQGBXe4vkOyyjGku354NBntKjNqXMPWa0a0GOp4BfQ9KLCwakBMdIIkIXoS0OHNF%2FpNeAPvMTuw5gFwoh5aAR2MWjR4RkAtlnsQn0yYnSuBPRkwVJPDdF%2BgglIkrSPXzG1MxnrNfazXbDecw3R%2FzpmnXCJjRGG2cQTkWN4dJeHomceCkRRmutjQnhRAeWE1OjX8L%2BOpPqFn%2FzDpBG492Zj6DBIN8Lu8X2RXqnSoyzk3%2Bgx00FXryq9WdYR4%3D&X-Amz-SignedHeaders=host&X-Amz-Signature=f61e5b8f1cb7231568cfc29e736805b70c213758dfef40b45e869a97ef7be0eb",
"status": "signed",
"submissionDate": "2024-01-17T18:47:46.714156279Z"
}
]
}