This API contains examples for sending and receiving data from your Client Dynamics portal.
\nPlease make sure to replace the values in the variables to point to your correct Client Dynamics URL, as well as authenticate with your agencyId and apiKey.
\nThis collection includes examples for Contacts, Policies, Quotes, Files, and Downloads endpoints.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"1536198","collectionId":"62ef2da8-77e1-4567-8393-b390461b498b","publishedId":"2sBXwnusED","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-06-01T18:55:37.000Z"},"item":[{"name":"Contacts","item":[{"name":"help","item":[{"name":"Get help information for Contacts","id":"d98c3796-8cb6-4851-9938-fda2c0b72a9e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Agency-Id","value":"agencyId","description":"(Required)
\n"},{"key":"X-API-Key","value":"apiKey","description":"(Required)
\n"}],"url":"https://defaultClient.clientdynamics.com/api/Contacts/help","urlObject":{"path":["Contacts","help"],"host":["https://defaultClient.clientdynamics.com/api"],"query":[],"variable":[]}},"response":[{"id":"7140ee6b-481b-4b0e-8624-db8c77e3a819","name":"Help information for contacts","originalRequest":{"method":"GET","header":[{"key":"X-Agency-Id","value":"agencyId","description":"(Required) "},{"key":"X-API-Key","value":"apiKey","description":"(Required) "}],"url":"https://defaultClient.clientdynamics.com/api/Contacts/help"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"d98c3796-8cb6-4851-9938-fda2c0b72a9e"}],"id":"7cf482c6-93b1-487d-adeb-ee4f8219c9c3","_postman_id":"7cf482c6-93b1-487d-adeb-ee4f8219c9c3","description":""},{"name":"list","item":[{"name":"Retrieve a list of Contacts","id":"04b055cc-7cdc-4e6f-aaa8-803074f0dbee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Agency-Id","value":"agencyId","description":"(Required)
\n"},{"key":"X-API-Key","value":"apiKey","description":"(Required)
\n"}],"url":"https://defaultClient.clientdynamics.com/api/Contacts/list?search_criteria=(Required) Name of field you are searching IN (See help method for field names)
\n","type":"text/plain"},"key":"search_criteria","value":"(Required) Value your are searching FOR
\n","type":"text/plain"},"key":"search_value","value":"Additional Name of field you are searching IN (See help method for field names)
\n","type":"text/plain"},"key":"addtnl_search_criteria","value":"Additional Value your are searching FOR (AND not OR)
\n","type":"text/plain"},"key":"addtnl_search_value","value":"(Required)
\n"},{"key":"X-API-Key","value":"apiKey","description":"(Required)
\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"contact_status\": \"New Lead\",\n \"fname\": \"(Required)
\n"},{"key":"X-API-Key","value":"apiKey","description":"(Required)
\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"ContactId\": \"(Required)
\n"},{"key":"X-API-Key","value":"apiKey","description":"(Required)
\n"}],"url":"https://defaultClient.clientdynamics.com/api/Policies/help","urlObject":{"path":["Policies","help"],"host":["https://defaultClient.clientdynamics.com/api"],"query":[],"variable":[]}},"response":[{"id":"b4acf51d-9083-4914-88cc-e2eb24a35bdc","name":"Help information for Policies","originalRequest":{"method":"GET","header":[{"key":"X-Agency-Id","value":"agencyId","description":"(Required) "},{"key":"X-API-Key","value":"apiKey","description":"(Required) "}],"url":"https://defaultClient.clientdynamics.com/api/Policies/help"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"8ef33f69-d38b-4bf2-8686-9f567c76bd09"}],"id":"32d1172b-5ff6-4bc9-a2dd-289ebb955e61","_postman_id":"32d1172b-5ff6-4bc9-a2dd-289ebb955e61","description":""},{"name":"list","item":[{"name":"Retrieve a list of Policies","id":"6212dc99-477c-45fc-bca0-c5dac8163630","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Agency-Id","value":"agencyId","description":"(Required)
\n"},{"key":"X-API-Key","value":"apiKey","description":"(Required)
\n"}],"url":"https://defaultClient.clientdynamics.com/api/Policies/list?search_criteria=(Required) Name of field you are searching IN (See help method for field names)
\n","type":"text/plain"},"key":"search_criteria","value":"(Required) Value your are searching FOR
\n","type":"text/plain"},"key":"search_value","value":"Additional Name of field you are searching IN (See help method for field names)
\n","type":"text/plain"},"key":"addtnl_search_criteria","value":"Additional Value your are searching FOR (AND not OR)
\n","type":"text/plain"},"key":"addtnl_search_value","value":"(Required)
\n"},{"key":"X-API-Key","value":"apiKey","description":"(Required)
\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"ContactId\": \"(Required)
\n"},{"key":"X-API-Key","value":"apiKey","description":"(Required)
\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PolicyId\": \"(Required) Your Client Dynamics agency ID
\n"},{"key":"X-API-Key","value":"apiKey","description":"(Required) Your Client Dynamics API key
\n"}],"url":"https://defaultClient.clientdynamics.com/api/Notes/help","description":"Returns supported note types, routing rules, editable fields, and optional external-source idempotency fields for the Notes API.
\n","urlObject":{"path":["Notes","help"],"host":["https://defaultClient.clientdynamics.com/api"],"query":[],"variable":[]}},"response":[{"id":"1119b976-1a08-4304-a154-6eb52878e6da","name":"Help information for Notes","originalRequest":{"method":"GET","header":[{"key":"X-Agency-Id","value":"agencyId","description":"(Required) Your Client Dynamics agency ID"},{"key":"X-API-Key","value":"apiKey","description":"(Required) Your Client Dynamics API key"}],"url":"https://defaultClient.clientdynamics.com/api/Notes/help","description":"Returns supported note types, routing rules, editable fields, and optional external-source idempotency fields for the Notes API."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"resource\": \"Notes\",\n \"supported_note_types\": [\n \"Contact\",\n \"Policy\"\n ],\n \"routing\": {\n \"ContactId only\": \"contact_notes\",\n \"PolicyId supplied\": \"policy_notes; ContactId is validated or derived from policies\"\n },\n \"fields\": {\n \"NoteId\": {\n \"type\": \"varchar(36)\",\n \"readonly\": true\n },\n \"NoteType\": {\n \"type\": \"string\",\n \"readonly\": true,\n \"values\": [\n \"Contact\",\n \"Policy\"\n ]\n },\n \"ContactId\": {\n \"type\": \"varchar(36)\",\n \"required_when\": \"PolicyId is not supplied\"\n },\n \"PolicyId\": {\n \"type\": \"varchar(36)\",\n \"required_when\": \"Creating a policy note\"\n },\n \"subject\": {\n \"type\": \"string\",\n \"maxLength\": 255\n },\n \"note_content\": {\n \"type\": \"string\",\n \"required\": true\n },\n \"note_by\": {\n \"type\": \"string\",\n \"maxLength\": 64,\n \"default\": \"API Import\"\n },\n \"entry_ts\": {\n \"type\": \"datetime\"\n },\n \"migration_source\": {\n \"type\": \"string\",\n \"maxLength\": 64,\n \"required\": false\n },\n \"migration_source_object\": {\n \"type\": \"string\",\n \"maxLength\": 64,\n \"required\": false\n },\n \"migration_source_id\": {\n \"type\": \"string\",\n \"maxLength\": 100,\n \"required\": false\n }\n }\n}"}],"_postman_id":"bb0a641d-7a1e-45db-aa9b-82f8caca52b5"}],"id":"b28181fb-d843-4242-aed6-cc4f8c4b0765","_postman_id":"b28181fb-d843-4242-aed6-cc4f8c4b0765","description":""},{"name":"list","item":[{"name":"Retrieve Notes for a Contact","id":"b03ad467-4106-4052-bd08-ca974ef587b7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Agency-Id","value":"agencyId","description":"(Required) Your Client Dynamics agency ID
\n"},{"key":"X-API-Key","value":"apiKey","description":"(Required) Your Client Dynamics API key
\n"}],"url":"https://defaultClient.clientdynamics.com/api/Notes/list?search_criteria=ContactId&search_value=22222222-3333-4444-5555-666666666666¬e_type=All&include_deleted=false&limit=1000","description":"Lists Contact and Policy notes associated with a ContactId. Use note_type to limit the response.
\n","urlObject":{"path":["Notes","list"],"host":["https://defaultClient.clientdynamics.com/api"],"query":[{"description":{"content":"(Required) Supported values: NoteId, ContactNoteId, PolicyNoteId, ContactId, PolicyId, migration_source, migration_source_object, migration_source_id.
\n","type":"text/plain"},"key":"search_criteria","value":"ContactId"},{"description":{"content":"(Required) Value to search for.
\n","type":"text/plain"},"key":"search_value","value":"22222222-3333-4444-5555-666666666666"},{"description":{"content":"Optional. All, Contact, or Policy.
\n","type":"text/plain"},"key":"note_type","value":"All"},{"description":{"content":"Optional. Include deleted notes when true.
\n","type":"text/plain"},"key":"include_deleted","value":"false"},{"description":{"content":"Optional. Maximum 5000.
\n","type":"text/plain"},"key":"limit","value":"1000"}],"variable":[]}},"response":[{"id":"0ef9ea60-df4a-4a25-9342-2e233864d321","name":"Notes for a Contact","originalRequest":{"method":"GET","header":[{"key":"X-Agency-Id","value":"agencyId","description":"(Required) Your Client Dynamics agency ID"},{"key":"X-API-Key","value":"apiKey","description":"(Required) Your Client Dynamics API key"}],"url":{"raw":"https://defaultClient.clientdynamics.com/api/Notes/list?search_criteria=ContactId&search_value=22222222-3333-4444-5555-666666666666¬e_type=All&include_deleted=false&limit=1000","host":["https://defaultClient.clientdynamics.com/api"],"path":["Notes","list"],"query":[{"key":"search_criteria","value":"ContactId","description":"(Required) Supported values: NoteId, ContactNoteId, PolicyNoteId, ContactId, PolicyId, migration_source, migration_source_object, migration_source_id."},{"key":"search_value","value":"22222222-3333-4444-5555-666666666666","description":"(Required) Value to search for."},{"key":"note_type","value":"All","description":"Optional. All, Contact, or Policy."},{"key":"include_deleted","value":"false","description":"Optional. Include deleted notes when true."},{"key":"limit","value":"1000","description":"Optional. Maximum 5000."}]},"description":"Lists Contact and Policy notes associated with a ContactId. Use note_type to limit the response."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Success\",\n \"num_records\": 2,\n \"results\": [\n {\n \"NoteId\": \"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\",\n \"ContactId\": \"22222222-3333-4444-5555-666666666666\",\n \"PolicyId\": null,\n \"note_content\": \"Subject: Outbound call\\n\\nCalled the insured.\",\n \"note_by\": \"API User\",\n \"entry_ts\": \"2026-01-15 14:30:00\",\n \"Deleted\": 0,\n \"DeletedOn\": \"0000-00-00 00:00:00\",\n \"DeletedBy\": null,\n \"migration_source\": null,\n \"migration_source_object\": null,\n \"migration_source_id\": null,\n \"migration_content_hash\": \"(Required) Your Client Dynamics agency ID
\n"},{"key":"X-API-Key","value":"apiKey","description":"(Required) Your Client Dynamics API key
\n"}],"url":"https://defaultClient.clientdynamics.com/api/Notes/list?search_criteria=PolicyId&search_value=33333333-4444-5555-6666-777777777777¬e_type=Policy&include_deleted=false&limit=1000","description":"Lists notes attached to a PolicyId.
\n","urlObject":{"path":["Notes","list"],"host":["https://defaultClient.clientdynamics.com/api"],"query":[{"description":{"content":"(Required) Search by PolicyId.
\n","type":"text/plain"},"key":"search_criteria","value":"PolicyId"},{"description":{"content":"(Required) Client Dynamics PolicyId.
\n","type":"text/plain"},"key":"search_value","value":"33333333-4444-5555-6666-777777777777"},{"description":{"content":"Optional. Restricts results to Policy notes.
\n","type":"text/plain"},"key":"note_type","value":"Policy"},{"description":{"content":"Optional. Include deleted notes when true.
\n","type":"text/plain"},"key":"include_deleted","value":"false"},{"description":{"content":"Optional. Maximum 5000.
\n","type":"text/plain"},"key":"limit","value":"1000"}],"variable":[]}},"response":[{"id":"a30343ad-c451-4eb4-9f45-9da2488e8f8d","name":"Notes for a Policy","originalRequest":{"method":"GET","header":[{"key":"X-Agency-Id","value":"agencyId","description":"(Required) Your Client Dynamics agency ID"},{"key":"X-API-Key","value":"apiKey","description":"(Required) Your Client Dynamics API key"}],"url":{"raw":"https://defaultClient.clientdynamics.com/api/Notes/list?search_criteria=PolicyId&search_value=33333333-4444-5555-6666-777777777777¬e_type=Policy&include_deleted=false&limit=1000","host":["https://defaultClient.clientdynamics.com/api"],"path":["Notes","list"],"query":[{"key":"search_criteria","value":"PolicyId","description":"(Required) Search by PolicyId."},{"key":"search_value","value":"33333333-4444-5555-6666-777777777777","description":"(Required) Client Dynamics PolicyId."},{"key":"note_type","value":"Policy","description":"Optional. Restricts results to Policy notes."},{"key":"include_deleted","value":"false","description":"Optional. Include deleted notes when true."},{"key":"limit","value":"1000","description":"Optional. Maximum 5000."}]},"description":"Lists notes attached to a PolicyId."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Success\",\n \"num_records\": 1,\n \"results\": [\n {\n \"NoteId\": \"ffffffff-1111-2222-3333-444444444444\",\n \"ContactId\": \"22222222-3333-4444-5555-666666666666\",\n \"PolicyId\": \"33333333-4444-5555-6666-777777777777\",\n \"note_content\": \"Subject: Renewal review\\n\\nRenewal reviewed with insured.\",\n \"note_by\": \"API User\",\n \"entry_ts\": \"2026-01-16 09:00:00\",\n \"Deleted\": 0,\n \"DeletedOn\": \"0000-00-00 00:00:00\",\n \"DeletedBy\": null,\n \"migration_source\": null,\n \"migration_source_object\": null,\n \"migration_source_id\": null,\n \"migration_content_hash\": \"(Required) Your Client Dynamics agency ID
\n"},{"key":"X-API-Key","value":"apiKey","description":"(Required) Your Client Dynamics API key
\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"ContactId\": \"22222222-3333-4444-5555-666666666666\",\n \"subject\": \"Outbound call\",\n \"note_content\": \"Called the insured and reviewed renewal options.\",\n \"note_by\": \"API User\",\n \"entry_ts\": \"2026-01-15T14:30:00Z\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://defaultClient.clientdynamics.com/api/Notes/add","description":"Creates a Contact note. PolicyId is omitted, so the note is stored in contact_notes.
\n","urlObject":{"path":["Notes","add"],"host":["https://defaultClient.clientdynamics.com/api"],"query":[],"variable":[]}},"response":[{"id":"9504f18a-eaba-43f3-853e-79a6e7dae6c3","name":"Contact Note added","originalRequest":{"method":"POST","header":[{"key":"X-Agency-Id","value":"agencyId","description":"(Required) Your Client Dynamics agency ID"},{"key":"X-API-Key","value":"apiKey","description":"(Required) Your Client Dynamics API key"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"ContactId\": \"22222222-3333-4444-5555-666666666666\",\n \"subject\": \"Outbound call\",\n \"note_content\": \"Called the insured and reviewed renewal options.\",\n \"note_by\": \"API User\",\n \"entry_ts\": \"2026-01-15T14:30:00Z\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://defaultClient.clientdynamics.com/api/Notes/add","description":"Creates a Contact note. PolicyId is omitted, so the note is stored in contact_notes."},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Success\",\n \"action\": \"Inserted\",\n \"NoteId\": \"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\",\n \"NoteType\": \"Contact\",\n \"ContactId\": \"22222222-3333-4444-5555-666666666666\",\n \"PolicyId\": null,\n \"ContactNoteId\": \"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\"\n}"}],"_postman_id":"663131fb-a2be-41e1-b8b8-5a513b2e5620"},{"name":"Add a Policy Note","id":"36561d94-5777-4969-ad15-884f96c9a273","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Agency-Id","value":"agencyId","description":"(Required) Your Client Dynamics agency ID
\n"},{"key":"X-API-Key","value":"apiKey","description":"(Required) Your Client Dynamics API key
\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PolicyId\": \"33333333-4444-5555-6666-777777777777\",\n \"subject\": \"Renewal review\",\n \"note_content\": \"The renewal was reviewed with the named insured.\",\n \"note_by\": \"API User\",\n \"entry_ts\": \"2026-01-16T09:00:00Z\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://defaultClient.clientdynamics.com/api/Notes/add","description":"Creates a Policy note. ContactId is derived from the policy when omitted.
\n","urlObject":{"path":["Notes","add"],"host":["https://defaultClient.clientdynamics.com/api"],"query":[],"variable":[]}},"response":[{"id":"87f76799-cecd-4a3a-bfbc-66a4a0c99b41","name":"Policy Note added","originalRequest":{"method":"POST","header":[{"key":"X-Agency-Id","value":"agencyId","description":"(Required) Your Client Dynamics agency ID"},{"key":"X-API-Key","value":"apiKey","description":"(Required) Your Client Dynamics API key"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PolicyId\": \"33333333-4444-5555-6666-777777777777\",\n \"subject\": \"Renewal review\",\n \"note_content\": \"The renewal was reviewed with the named insured.\",\n \"note_by\": \"API User\",\n \"entry_ts\": \"2026-01-16T09:00:00Z\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://defaultClient.clientdynamics.com/api/Notes/add","description":"Creates a Policy note. ContactId is derived from the policy when omitted."},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Success\",\n \"action\": \"Inserted\",\n \"NoteId\": \"ffffffff-1111-2222-3333-444444444444\",\n \"NoteType\": \"Policy\",\n \"ContactId\": \"22222222-3333-4444-5555-666666666666\",\n \"PolicyId\": \"33333333-4444-5555-6666-777777777777\",\n \"PolicyNoteId\": \"ffffffff-1111-2222-3333-444444444444\"\n}"}],"_postman_id":"36561d94-5777-4969-ad15-884f96c9a273"}],"id":"0bcd68b2-a263-4799-82b5-1a27890a6fa8","_postman_id":"0bcd68b2-a263-4799-82b5-1a27890a6fa8","description":""},{"name":"update","item":[{"name":"Update a Note","id":"457bbf37-db84-4ca0-bf97-a5cd96b5031d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Agency-Id","value":"agencyId","description":"(Required) Your Client Dynamics agency ID
\n"},{"key":"X-API-Key","value":"apiKey","description":"(Required) Your Client Dynamics API key
\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"NoteId\": \"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\",\n \"note_content\": \"Corrected note content.\",\n \"note_by\": \"API User\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://defaultClient.clientdynamics.com/api/Notes/update","description":"Updates editable fields for either a Contact or Policy note using the normalized NoteId.
\n","urlObject":{"path":["Notes","update"],"host":["https://defaultClient.clientdynamics.com/api"],"query":[],"variable":[]}},"response":[{"id":"e5060cd7-8bdf-4f4d-a752-9abf11fa9ae4","name":"Note updated","originalRequest":{"method":"POST","header":[{"key":"X-Agency-Id","value":"agencyId","description":"(Required) Your Client Dynamics agency ID"},{"key":"X-API-Key","value":"apiKey","description":"(Required) Your Client Dynamics API key"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"NoteId\": \"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\",\n \"note_content\": \"Corrected note content.\",\n \"note_by\": \"API User\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://defaultClient.clientdynamics.com/api/Notes/update","description":"Updates editable fields for either a Contact or Policy note using the normalized NoteId."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Success\",\n \"action\": \"Updated\",\n \"NoteId\": \"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\",\n \"NoteType\": \"Contact\",\n \"ContactId\": \"22222222-3333-4444-5555-666666666666\",\n \"PolicyId\": null,\n \"ContactNoteId\": \"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\",\n \"updatedFields\": {\n \"note_content\": \"Corrected note content.\",\n \"note_by\": \"API User\"\n }\n}"}],"_postman_id":"457bbf37-db84-4ca0-bf97-a5cd96b5031d"},{"name":"Delete a Note","id":"22c3e74d-a906-43e3-8074-64a848889546","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Agency-Id","value":"agencyId","description":"(Required) Your Client Dynamics agency ID
\n"},{"key":"X-API-Key","value":"apiKey","description":"(Required) Your Client Dynamics API key
\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"NoteId\": \"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\",\n \"delete\": true,\n \"DeletedBy\": 1001\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://defaultClient.clientdynamics.com/api/Notes/update","description":"Marks a note as deleted without removing the row.
\n","urlObject":{"path":["Notes","update"],"host":["https://defaultClient.clientdynamics.com/api"],"query":[],"variable":[]}},"response":[{"id":"cc422294-70c7-4acb-abf6-245f96215ae3","name":"Note deleted","originalRequest":{"method":"POST","header":[{"key":"X-Agency-Id","value":"agencyId","description":"(Required) Your Client Dynamics agency ID"},{"key":"X-API-Key","value":"apiKey","description":"(Required) Your Client Dynamics API key"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"NoteId\": \"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\",\n \"delete\": true,\n \"DeletedBy\": 1001\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://defaultClient.clientdynamics.com/api/Notes/update","description":"Marks a note as deleted without removing the row."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Success\",\n \"action\": \"Updated\",\n \"NoteId\": \"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\",\n \"NoteType\": \"Contact\",\n \"ContactId\": \"22222222-3333-4444-5555-666666666666\",\n \"PolicyId\": null,\n \"ContactNoteId\": \"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\",\n \"updatedFields\": {\n \"Deleted\": 1,\n \"DeletedBy\": 1001,\n \"DeletedOn\": \"current UTC timestamp\"\n }\n}"}],"_postman_id":"22c3e74d-a906-43e3-8074-64a848889546"},{"name":"Undelete a Note","id":"0716ae96-3a3d-44d7-b4a5-d197ba29f2cd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Agency-Id","value":"agencyId","description":"(Required) Your Client Dynamics agency ID
\n"},{"key":"X-API-Key","value":"apiKey","description":"(Required) Your Client Dynamics API key
\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"NoteId\": \"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\",\n \"undelete\": true\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://defaultClient.clientdynamics.com/api/Notes/update","description":"Restores a previously deleted note.
\n","urlObject":{"path":["Notes","update"],"host":["https://defaultClient.clientdynamics.com/api"],"query":[],"variable":[]}},"response":[{"id":"e1c1b316-bb3b-46fc-8498-083221a12ed4","name":"Note undeleted","originalRequest":{"method":"POST","header":[{"key":"X-Agency-Id","value":"agencyId","description":"(Required) Your Client Dynamics agency ID"},{"key":"X-API-Key","value":"apiKey","description":"(Required) Your Client Dynamics API key"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"NoteId\": \"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\",\n \"undelete\": true\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://defaultClient.clientdynamics.com/api/Notes/update","description":"Restores a previously deleted note."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Success\",\n \"action\": \"Updated\",\n \"NoteId\": \"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\",\n \"NoteType\": \"Contact\",\n \"ContactId\": \"22222222-3333-4444-5555-666666666666\",\n \"PolicyId\": null,\n \"ContactNoteId\": \"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\",\n \"updatedFields\": {\n \"Deleted\": 0,\n \"DeletedBy\": null,\n \"DeletedOn\": \"0000-00-00 00:00:00\"\n }\n}"}],"_postman_id":"0716ae96-3a3d-44d7-b4a5-d197ba29f2cd"}],"id":"02dd32ba-f4cb-4fd3-be33-6bae4c8d42fe","_postman_id":"02dd32ba-f4cb-4fd3-be33-6bae4c8d42fe","description":""}],"id":"9702b371-d7ae-4558-b83b-ccd1f3db311a","description":"Work with Contact and Policy notes for the authenticated Client Dynamics tenant. The endpoint is shared by all clients and uses the normal tenant database selected by Client Dynamics.
\n","_postman_id":"9702b371-d7ae-4558-b83b-ccd1f3db311a"},{"name":"Quotes","item":[{"name":"help","item":[{"name":"Get help information for Quotes","id":"1e67d7cf-dbdb-4591-9831-47e2d940d0b7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Agency-Id","value":"agencyId","description":"(Required)
\n"},{"key":"X-API-Key","value":"apiKey","description":"(Required)
\n"}],"url":"https://defaultClient.clientdynamics.com/api/Quotes/help","urlObject":{"path":["Quotes","help"],"host":["https://defaultClient.clientdynamics.com/api"],"query":[],"variable":[]}},"response":[{"id":"1ddc1bd9-cfce-42b5-8914-e1fc36faadf6","name":"Help information for Quotes","originalRequest":{"method":"GET","header":[{"key":"X-Agency-Id","value":"agencyId","description":"(Required) "},{"key":"X-API-Key","value":"apiKey","description":"(Required) "}],"url":"https://defaultClient.clientdynamics.com/api/Quotes/help"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"fields\": {\n \"BotSubmission_Id\": {\n \"type\": \"string\",\n \"maxLength\": 36,\n \"null\": \"YES\",\n \"default\": null,\n \"name\": \"BotSubmission_Id\",\n \"readonly\": false\n },\n \"status\": {\n \"type\": \"string\",\n \"maxLength\": 64,\n \"null\": \"YES\",\n \"default\": null,\n \"name\": \"status\",\n \"readonly\": false\n },\n \"submitted_by\": {\n \"type\": \"string\",\n \"maxLength\": 64,\n \"null\": \"NO\",\n \"default\": \"email@address.com\",\n \"name\": \"submitted_by\",\n \"readonly\": false\n },\n \"returned_amt\": {\n \"type\": \"decimal(19,2)\",\n \"null\": \"YES\",\n \"default\": \"0.00\",\n \"name\": \"returned_amt\",\n \"readonly\": false\n },\n \"ackd\": {\n \"type\": \"string\",\n \"maxLength\": 64,\n \"null\": \"YES\",\n \"default\": null,\n \"name\": \"ackd\",\n \"readonly\": false\n },\n \"contact_id\": {\n \"type\": \"string\",\n \"maxLength\": 64,\n \"null\": \"YES\",\n \"default\": null,\n \"name\": \"contact_id\",\n \"readonly\": false\n },\n \"site_name\": {\n \"type\": \"string\",\n \"maxLength\": 128,\n \"null\": \"NO\",\n \"default\": \"email@address.com\",\n \"name\": \"site_name\",\n \"readonly\": false\n },\n \"submitted_date\": {\n \"type\": \"timestamp\",\n \"null\": \"NO\",\n \"default\": \"current_timestamp()\",\n \"name\": \"submitted_date\",\n \"readonly\": false\n },\n \"correlation_lead_id\": {\n \"type\": \"string\",\n \"maxLength\": 255,\n \"null\": \"YES\",\n \"default\": null,\n \"name\": \"correlation_lead_id\",\n \"readonly\": false\n },\n \"series_id\": {\n \"type\": \"string\",\n \"maxLength\": 128,\n \"null\": \"YES\",\n \"default\": null,\n \"name\": \"series_id\",\n \"readonly\": false\n },\n \"ContactId\": {\n \"type\": \"varchar(36)\",\n \"null\": \"YES\",\n \"default\": null,\n \"name\": \"ContactId\",\n \"readonly\": true\n },\n \"callbackURL\": {\n \"type\": \"string\",\n \"maxLength\": 3000,\n \"null\": \"YES\",\n \"default\": null,\n \"name\": \"callbackURL\",\n \"readonly\": false\n },\n \"lob\": {\n \"type\": \"string\",\n \"maxLength\": 65,\n \"null\": \"YES\",\n \"default\": null,\n \"name\": \"lob\",\n \"readonly\": false\n },\n \"wf_status\": {\n \"type\": \"string\",\n \"maxLength\": 10,\n \"null\": \"YES\",\n \"default\": \"0\",\n \"name\": \"wf_status\",\n \"readonly\": false\n },\n \"callbackResponseRaw\": {\n \"type\": \"text\",\n \"null\": \"YES\",\n \"default\": null,\n \"name\": \"callbackResponseRaw\",\n \"readonly\": false\n },\n \"callbackSentRaw\": {\n \"type\": \"text\",\n \"null\": \"YES\",\n \"default\": null,\n \"name\": \"callbackSentRaw\",\n \"readonly\": false\n }\n }\n}"}],"_postman_id":"1e67d7cf-dbdb-4591-9831-47e2d940d0b7"}],"id":"e7554b1a-dae4-4d73-829f-41775ae91546","_postman_id":"e7554b1a-dae4-4d73-829f-41775ae91546","description":""},{"name":"list","item":[{"name":"Retrieve a list of Quotes","id":"1e9da3b5-c137-4acb-a9a8-b5809202c8da","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Agency-Id","value":"agencyId","description":"(Required)
\n"},{"key":"X-API-Key","value":"apiKey","description":"(Required)
\n"}],"url":"https://defaultClient.clientdynamics.com/api/Quotes/list?search_criteria=(Required) Name of field you are searching IN (See help method for field names)
\n","type":"text/plain"},"key":"search_criteria","value":"(Required) Value your are searching FOR
\n","type":"text/plain"},"key":"search_value","value":"Additional Name of field you are searching IN (See help method for field names)
\n","type":"text/plain"},"key":"addtnl_search_criteria","value":"Additional Value your are searching FOR (AND not OR)
\n","type":"text/plain"},"key":"addtnl_search_value","value":"Collection of endpoints to work with Quotes. Requires a QuoteRUSH Integration.
\n","_postman_id":"99d22ad4-a954-4472-8b64-bf4eff72813a"},{"name":"Files","item":[{"name":"help","item":[{"name":"Get help information for Files","id":"36cecd0b-7653-4ca3-a6aa-9fd3f453d5d0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Agency-Id","value":"agencyId","description":"(Required) Your Client Dynamics agency ID
\n"},{"key":"X-API-Key","value":"apiKey","description":"(Required) Your Client Dynamics API key
\n"}],"url":"https://defaultClient.clientdynamics.com/api/Files/help","description":"Returns available file fields and metadata for the Files API.
\n","urlObject":{"path":["Files","help"],"host":["https://defaultClient.clientdynamics.com/api"],"query":[],"variable":[]}},"response":[{"id":"3a548699-7922-465e-a2cd-def121870514","name":"Help information for Files","originalRequest":{"method":"GET","header":[{"key":"X-Agency-Id","value":"agencyId","description":"(Required) Your Client Dynamics agency ID"},{"key":"X-API-Key","value":"apiKey","description":"(Required) Your Client Dynamics API key"}],"url":"https://defaultClient.clientdynamics.com/api/Files/help","description":"Returns available file fields and metadata for the Files API."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"fields\": {\n \"file_name\": {\n \"type\": \"string\",\n \"maxLength\": 128,\n \"null\": \"YES\",\n \"default\": null,\n \"name\": \"file_name\",\n \"readonly\": false\n },\n \"ContactId\": {\n \"type\": \"varchar(36)\",\n \"null\": \"YES\",\n \"default\": null,\n \"name\": \"ContactId\",\n \"readonly\": false\n },\n \"PolicyId\": {\n \"type\": \"varchar(36)\",\n \"null\": \"YES\",\n \"default\": null,\n \"name\": \"PolicyId\",\n \"readonly\": false\n },\n \"FileId\": {\n \"type\": \"varchar(36)\",\n \"null\": \"NO\",\n \"default\": \"uuid()\",\n \"name\": \"FileId\",\n \"readonly\": true\n },\n \"deleted\": {\n \"type\": \"tinyint(4)\",\n \"null\": \"NO\",\n \"default\": \"0\",\n \"name\": \"deleted\",\n \"readonly\": true\n }\n }\n}"}],"_postman_id":"36cecd0b-7653-4ca3-a6aa-9fd3f453d5d0"}],"id":"0c1f44fc-0272-4c32-9063-61dd2d353806","_postman_id":"0c1f44fc-0272-4c32-9063-61dd2d353806","description":""},{"name":"list","item":[{"name":"Retrieve a list of Files for a Contact or Policy","id":"2e46ea9e-c5f6-4250-9fab-48dfbee9bd7e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Agency-Id","value":"agencyId","description":"(Required) Your Client Dynamics agency ID
\n"},{"key":"X-API-Key","value":"apiKey","description":"(Required) Your Client Dynamics API key
\n"}],"url":"https://defaultClient.clientdynamics.com/api/Files/list?search_criteria=ContactId&search_value=22222222-3333-4444-5555-666666666666&addtnl_search_criteria=&addtnl_search_value=","description":"Retrieves file metadata for a contact, policy, or other supported file search field.
\n","urlObject":{"path":["Files","list"],"host":["https://defaultClient.clientdynamics.com/api"],"query":[{"description":{"content":"(Required) Field to search by. Common values include ContactId, PolicyId, FileId, category, file_name.
\n","type":"text/plain"},"key":"search_criteria","value":"ContactId"},{"description":{"content":"(Required) Search value.
\n","type":"text/plain"},"key":"search_value","value":"22222222-3333-4444-5555-666666666666"},{"description":{"content":"Optional additional field to search by.
\n","type":"text/plain"},"key":"addtnl_search_criteria","value":""},{"description":{"content":"Optional additional value. Combined with AND logic.
\n","type":"text/plain"},"key":"addtnl_search_value","value":""}],"variable":[]}},"response":[{"id":"0336a9b1-2c25-4646-8766-f8f7abd7438f","name":"A list of Files for a Contact","originalRequest":{"method":"GET","header":[{"key":"X-Agency-Id","value":"agencyId","description":"(Required) Your Client Dynamics agency ID"},{"key":"X-API-Key","value":"apiKey","description":"(Required) Your Client Dynamics API key"}],"url":{"raw":"https://defaultClient.clientdynamics.com/api/Files/list?search_criteria=ContactId&search_value=22222222-3333-4444-5555-666666666666&addtnl_search_criteria=&addtnl_search_value=","host":["https://defaultClient.clientdynamics.com/api"],"path":["Files","list"],"query":[{"key":"search_criteria","value":"ContactId","description":"(Required) Field to search by. Common values include ContactId, PolicyId, FileId, category, file_name."},{"key":"search_value","value":"22222222-3333-4444-5555-666666666666","description":"(Required) Search value."},{"key":"addtnl_search_criteria","value":"","description":"Optional additional field to search by."},{"key":"addtnl_search_value","value":"","description":"Optional additional value. Combined with AND logic."}]},"description":"Retrieves file metadata for a contact, policy, or other supported file search field."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Success\",\n \"num_records\": 2,\n \"results\": [\n {\n \"file_name\": \"sample-policy-document.pdf\",\n \"agency_id\": \"agencyId\",\n \"file_type\": \"application/pdf\",\n \"file_size\": \"24576\",\n \"uploaded\": \"2026-01-15 10:25:00\",\n \"ContactId\": \"22222222-3333-4444-5555-666666666666\",\n \"category\": \"Policy Documents\",\n \"description\": \"Mock policy document\",\n \"last_modified\": \"2026-01-15 10:25:00\",\n \"FileId\": \"11111111-2222-3333-4444-555555555555\",\n \"PolicyId\": \"33333333-4444-5555-6666-777777777777\",\n \"deleted\": \"0\",\n \"label_id\": \"Policy Documents\"\n },\n {\n \"file_name\": \"sample-id-card.pdf\",\n \"agency_id\": \"agencyId\",\n \"file_type\": \"application/pdf\",\n \"file_size\": \"16384\",\n \"uploaded\": \"2026-01-16 09:12:00\",\n \"ContactId\": \"22222222-3333-4444-5555-666666666666\",\n \"category\": \"ID Cards\",\n \"description\": \"Mock ID card\",\n \"last_modified\": \"2026-01-16 09:12:00\",\n \"FileId\": \"44444444-5555-6666-7777-888888888888\",\n \"PolicyId\": \"33333333-4444-5555-6666-777777777777\",\n \"deleted\": \"0\",\n \"label_id\": \"ID Cards\"\n }\n ]\n}"}],"_postman_id":"2e46ea9e-c5f6-4250-9fab-48dfbee9bd7e"}],"id":"3fc442e2-85a3-4d0a-99d5-cbd5281cb9cd","_postman_id":"3fc442e2-85a3-4d0a-99d5-cbd5281cb9cd","description":""},{"name":"add","item":[{"name":"Upload a File (multipart)","id":"8e883957-b128-40d7-977f-66062bf46c8d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Agency-Id","value":"agencyId","type":"text"},{"key":"X-API-Key","value":"apiKey","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"ContactId","value":"22222222-3333-4444-5555-666666666666","type":"text"},{"key":"PolicyId","value":"33333333-4444-5555-6666-777777777777","type":"text"},{"key":"category","value":"Policy Documents","type":"text"},{"key":"description","value":"Imported from Tech Canary / Salesforce","type":"text"},{"key":"label_id","value":"Policy Documents","type":"text"},{"key":"file","type":"file","value":null}]},"url":"https://defaultClient.clientdynamics.com/api/Files/add","description":"Preferred upload method. At least one of ContactId or PolicyId is required.
\n","urlObject":{"path":["Files","add"],"host":["https://defaultClient.clientdynamics.com/api"],"query":[],"variable":[]}},"response":[{"id":"cbd69715-1876-4d47-9ad2-8b47ef48aa32","name":"File uploaded","originalRequest":{"header":[],"url":""},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Success\",\n \"FileId\": \"11111111-2222-3333-4444-555555555555\",\n \"ContactId\": \"22222222-3333-4444-5555-666666666666\",\n \"PolicyId\": \"33333333-4444-5555-6666-777777777777\",\n \"file_name\": \"sample-policy-document.pdf\",\n \"file_type\": \"application/pdf\",\n \"file_size\": 24576,\n \"sha256\": \"0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef\"\n}"}],"_postman_id":"8e883957-b128-40d7-977f-66062bf46c8d"},{"name":"Upload a File (JSON base64)","id":"bb5b7130-eef4-4b28-8de4-1a2196d66fd6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Agency-Id","value":"agencyId"},{"key":"X-API-Key","value":"apiKey"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"ContactId\": \"22222222-3333-4444-5555-666666666666\",\n \"PolicyId\": \"33333333-4444-5555-6666-777777777777\",\n \"file_name\": \"sample-policy-document.pdf\",\n \"file_type\": \"application/pdf\",\n \"category\": \"Policy Documents\",\n \"description\": \"Imported from Tech Canary / Salesforce\",\n \"file_content_base64\": \"JVBERi0xLjQK...\"\n}","options":{"raw":{"language":"json"}}},"url":"https://defaultClient.clientdynamics.com/api/Files/add","description":"Compatibility mode for small files. Multipart is preferred for migration.
\n","urlObject":{"path":["Files","add"],"host":["https://defaultClient.clientdynamics.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"bb5b7130-eef4-4b28-8de4-1a2196d66fd6"}],"id":"5b708282-b452-4385-a3b1-d310a330d0c5","_postman_id":"5b708282-b452-4385-a3b1-d310a330d0c5","description":""},{"name":"get","item":[{"name":"Retrieve a File by fileId","id":"77c96883-e76a-4a0e-bfa8-2171b446ed9f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Agency-Id","value":"agencyId","description":"(Required) Your Client Dynamics agency ID
\n"},{"key":"X-API-Key","value":"apiKey","description":"(Required) Your Client Dynamics API key
\n"}],"url":"https://defaultClient.clientdynamics.com/api/Files/get?fileId=11111111-2222-3333-4444-555555555555&returnEncoded=false&includeDeleted=false","description":"Retrieves a file. By default, returns a short-lived signed URL instead of inline base64 content.
\n","urlObject":{"path":["Files","get"],"host":["https://defaultClient.clientdynamics.com/api"],"query":[{"description":{"content":"(Required) Client Dynamics FileId.
\n","type":"text/plain"},"key":"fileId","value":"11111111-2222-3333-4444-555555555555"},{"description":{"content":"When false, the response returns a short-lived signed download URL.
\n","type":"text/plain"},"key":"returnEncoded","value":"false"},{"description":{"content":"Optional. Set true to retrieve deleted files when permitted.
\n","type":"text/plain"},"key":"includeDeleted","value":"false"}],"variable":[]}},"response":[{"id":"5f3421c9-9693-4813-9b1c-8764d861ee82","name":"File retrieved as signed download URL","originalRequest":{"method":"GET","header":[{"key":"X-Agency-Id","value":"agencyId","description":"(Required) Your Client Dynamics agency ID"},{"key":"X-API-Key","value":"apiKey","description":"(Required) Your Client Dynamics API key"}],"url":{"raw":"https://defaultClient.clientdynamics.com/api/Files/get?fileId=11111111-2222-3333-4444-555555555555&returnEncoded=false&includeDeleted=false","host":["https://defaultClient.clientdynamics.com/api"],"path":["Files","get"],"query":[{"key":"fileId","value":"11111111-2222-3333-4444-555555555555","description":"(Required) Client Dynamics FileId."},{"key":"returnEncoded","value":"false","description":"When false, the response returns a short-lived signed download URL."},{"key":"includeDeleted","value":"false","description":"Optional. Set true to retrieve deleted files when permitted."}]},"description":"Retrieves a file. By default, returns a short-lived signed URL instead of inline base64 content."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Success\",\n \"FileId\": \"11111111-2222-3333-4444-555555555555\",\n \"fileName\": \"sample-policy-document.pdf\",\n \"fileType\": \"application/pdf\",\n \"fileSize\": \"24576\",\n \"returnEncoded\": false,\n \"downloadUrl\": \"/api/Files/download?t=eyJ2IjoxLCJleHAiOjE5MDAwMDAwMDB9.mock-signature\",\n \"expiresAt\": \"2026-01-15T10:30:00-05:00\"\n}"},{"id":"793b6000-b750-4ff5-969b-3db26f57cf9c","name":"File is deleted","originalRequest":{"method":"GET","header":[{"key":"X-Agency-Id","value":"agencyId","description":"(Required) Your Client Dynamics agency ID"},{"key":"X-API-Key","value":"apiKey","description":"(Required) Your Client Dynamics API key"}],"url":{"raw":"https://defaultClient.clientdynamics.com/api/Files/get?fileId=11111111-2222-3333-4444-555555555555&returnEncoded=false&includeDeleted=false","host":["https://defaultClient.clientdynamics.com/api"],"path":["Files","get"],"query":[{"key":"fileId","value":"11111111-2222-3333-4444-555555555555","description":"(Required) Client Dynamics FileId."},{"key":"returnEncoded","value":"false","description":"When false, the response returns a short-lived signed download URL."},{"key":"includeDeleted","value":"false","description":"Optional. Set true to retrieve deleted files when permitted."}]},"description":"Retrieves a file. By default, returns a short-lived signed URL instead of inline base64 content."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Error\",\n \"statusMessage\": \"File is deleted\"\n}"}],"_postman_id":"77c96883-e76a-4a0e-bfa8-2171b446ed9f"},{"name":"Retrieve a File by fileId as base64","id":"42422052-d233-4e69-9f62-0a85d84b9682","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Agency-Id","value":"agencyId","description":"(Required) Your Client Dynamics agency ID
\n"},{"key":"X-API-Key","value":"apiKey","description":"(Required) Your Client Dynamics API key
\n"}],"url":"https://defaultClient.clientdynamics.com/api/Files/get?fileId=11111111-2222-3333-4444-555555555555&returnEncoded=true&includeDeleted=false","description":"Retrieves a file and returns the file content as a base64 string.
\n","urlObject":{"path":["Files","get"],"host":["https://defaultClient.clientdynamics.com/api"],"query":[{"description":{"content":"(Required) Client Dynamics FileId.
\n","type":"text/plain"},"key":"fileId","value":"11111111-2222-3333-4444-555555555555"},{"description":{"content":"When true, the response includes base64 file content.
\n","type":"text/plain"},"key":"returnEncoded","value":"true"},{"description":{"content":"Optional. Set true to retrieve deleted files when permitted.
\n","type":"text/plain"},"key":"includeDeleted","value":"false"}],"variable":[]}},"response":[{"id":"f467bfa2-7034-480e-b560-33430bc63899","name":"File retrieved as base64","originalRequest":{"method":"GET","header":[{"key":"X-Agency-Id","value":"agencyId","description":"(Required) Your Client Dynamics agency ID"},{"key":"X-API-Key","value":"apiKey","description":"(Required) Your Client Dynamics API key"}],"url":{"raw":"https://defaultClient.clientdynamics.com/api/Files/get?fileId=11111111-2222-3333-4444-555555555555&returnEncoded=true&includeDeleted=false","host":["https://defaultClient.clientdynamics.com/api"],"path":["Files","get"],"query":[{"key":"fileId","value":"11111111-2222-3333-4444-555555555555","description":"(Required) Client Dynamics FileId."},{"key":"returnEncoded","value":"true","description":"When true, the response includes base64 file content."},{"key":"includeDeleted","value":"false","description":"Optional. Set true to retrieve deleted files when permitted."}]},"description":"Retrieves a file and returns the file content as a base64 string."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Success\",\n \"FileId\": \"11111111-2222-3333-4444-555555555555\",\n \"fileName\": \"sample-policy-document.pdf\",\n \"fileType\": \"application/pdf\",\n \"fileSize\": \"24576\",\n \"returnEncoded\": true,\n \"fileContent\": \"JVBERi0xLjQKJUZha2UtbW9jay1wZGYtY29udGVudA==\"\n}"}],"_postman_id":"42422052-d233-4e69-9f62-0a85d84b9682"}],"id":"5db1f476-8565-4a7e-875f-e5de0bd770b2","_postman_id":"5db1f476-8565-4a7e-875f-e5de0bd770b2","description":""},{"name":"download","item":[{"name":"Download a File using a signed URL","id":"49811239-2a7b-4dc8-8e7f-bdc4466a2867","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Agency-Id","value":"agencyId","description":"(Required) Your Client Dynamics agency ID
\n"},{"key":"X-API-Key","value":"apiKey","description":"(Required) Your Client Dynamics API key
\n"}],"url":"https://defaultClient.clientdynamics.com/api/Files/download?t=eyJ2IjoxLCJleHAiOjE5MDAwMDAwMDB9.mock-signature","description":"Downloads the binary file using the short-lived signed token returned by /Files/get.
\n","urlObject":{"path":["Files","download"],"host":["https://defaultClient.clientdynamics.com/api"],"query":[{"description":{"content":"(Required) Signed token returned by /Files/get when returnEncoded=false.
\n","type":"text/plain"},"key":"t","value":"eyJ2IjoxLCJleHAiOjE5MDAwMDAwMDB9.mock-signature"}],"variable":[]}},"response":[{"id":"0cfdcf40-0597-4310-a427-05e17083ddd0","name":"Binary file response","originalRequest":{"method":"GET","header":[{"key":"X-Agency-Id","value":"agencyId","description":"(Required) Your Client Dynamics agency ID"},{"key":"X-API-Key","value":"apiKey","description":"(Required) Your Client Dynamics API key"}],"url":{"raw":"https://defaultClient.clientdynamics.com/api/Files/download?t=eyJ2IjoxLCJleHAiOjE5MDAwMDAwMDB9.mock-signature","host":["https://defaultClient.clientdynamics.com/api"],"path":["Files","download"],"query":[{"key":"t","value":"eyJ2IjoxLCJleHAiOjE5MDAwMDAwMDB9.mock-signature","description":"(Required) Signed token returned by /Files/get when returnEncoded=false."}]},"description":"Downloads the binary file using the short-lived signed token returned by /Files/get."},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/pdf","type":"text"}],"cookie":[],"responseTime":null,"body":"(Required) Your Client Dynamics agency ID
\n"},{"key":"X-API-Key","value":"apiKey","description":"(Required) Your Client Dynamics API key
\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"FileId\": \"11111111-2222-3333-4444-555555555555\",\n \"description\": \"Updated mock file description\",\n \"category\": \"Policy Documents\",\n \"label_id\": \"Policy Documents\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://defaultClient.clientdynamics.com/api/Files/update","description":"Updates editable metadata for a Client Dynamics file.
\n","urlObject":{"path":["Files","update"],"host":["https://defaultClient.clientdynamics.com/api"],"query":[],"variable":[]}},"response":[{"id":"cff55223-29d4-4199-b5c8-29ee59ec10b8","name":"File metadata updated","originalRequest":{"method":"POST","header":[{"key":"X-Agency-Id","value":"agencyId","description":"(Required) Your Client Dynamics agency ID"},{"key":"X-API-Key","value":"apiKey","description":"(Required) Your Client Dynamics API key"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"FileId\": \"11111111-2222-3333-4444-555555555555\",\n \"description\": \"Updated mock file description\",\n \"category\": \"Policy Documents\",\n \"label_id\": \"Policy Documents\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://defaultClient.clientdynamics.com/api/Files/update","description":"Updates editable metadata for a Client Dynamics file."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Success\",\n \"FileId\": \"11111111-2222-3333-4444-555555555555\",\n \"updatedFields\": {\n \"description\": \"Updated mock file description\",\n \"category\": \"Policy Documents\"\n }\n}"}],"_postman_id":"f6cf874f-8949-4916-9e22-57c21dd4d759"},{"name":"Delete a File","id":"880ade8b-9341-43f2-b5dc-16cf4660d494","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Agency-Id","value":"agencyId","description":"(Required) Your Client Dynamics agency ID
\n"},{"key":"X-API-Key","value":"apiKey","description":"(Required) Your Client Dynamics API key
\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"FileId\": \"11111111-2222-3333-4444-555555555555\",\n \"delete\": true,\n \"deleted_by\": 1001\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://defaultClient.clientdynamics.com/api/Files/update","description":"Marks a file as deleted without removing the underlying record.
\n","urlObject":{"path":["Files","update"],"host":["https://defaultClient.clientdynamics.com/api"],"query":[],"variable":[]}},"response":[{"id":"0c3fb5e7-2fd7-44da-a0a8-762ce582f28b","name":"File deleted","originalRequest":{"method":"POST","header":[{"key":"X-Agency-Id","value":"agencyId","description":"(Required) Your Client Dynamics agency ID"},{"key":"X-API-Key","value":"apiKey","description":"(Required) Your Client Dynamics API key"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"FileId\": \"11111111-2222-3333-4444-555555555555\",\n \"delete\": true,\n \"deleted_by\": 1001\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://defaultClient.clientdynamics.com/api/Files/update","description":"Marks a file as deleted without removing the underlying record."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Success\",\n \"FileId\": \"11111111-2222-3333-4444-555555555555\",\n \"updatedFields\": {\n \"deleted\": \"1\",\n \"deleted_by\": \"1001\",\n \"deleted_on\": \"2026-01-15 10:45:00\"\n }\n}"}],"_postman_id":"880ade8b-9341-43f2-b5dc-16cf4660d494"},{"name":"Undelete a File","id":"7799e4a9-67aa-4ee4-a985-4dd79edb0803","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Agency-Id","value":"agencyId","description":"(Required) Your Client Dynamics agency ID
\n"},{"key":"X-API-Key","value":"apiKey","description":"(Required) Your Client Dynamics API key
\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"FileId\": \"11111111-2222-3333-4444-555555555555\",\n \"undelete\": true\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://defaultClient.clientdynamics.com/api/Files/update","description":"Restores a previously deleted file.
\n","urlObject":{"path":["Files","update"],"host":["https://defaultClient.clientdynamics.com/api"],"query":[],"variable":[]}},"response":[{"id":"5ab57474-2ff5-4abf-97c9-6592e0a52fdd","name":"File undeleted","originalRequest":{"method":"POST","header":[{"key":"X-Agency-Id","value":"agencyId","description":"(Required) Your Client Dynamics agency ID"},{"key":"X-API-Key","value":"apiKey","description":"(Required) Your Client Dynamics API key"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"FileId\": \"11111111-2222-3333-4444-555555555555\",\n \"undelete\": true\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://defaultClient.clientdynamics.com/api/Files/update","description":"Restores a previously deleted file."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Success\",\n \"FileId\": \"11111111-2222-3333-4444-555555555555\",\n \"updatedFields\": {\n \"deleted\": \"0\",\n \"deleted_by\": null,\n \"deleted_on\": \"0000-00-00 00:00:00\"\n }\n}"}],"_postman_id":"7799e4a9-67aa-4ee4-a985-4dd79edb0803"}],"id":"8ed36f79-dddd-4d38-84b6-bd9c44011355","_postman_id":"8ed36f79-dddd-4d38-84b6-bd9c44011355","description":""}],"id":"3a1d04b7-7659-47dd-bda8-91e9e1849165","description":"Work with files stored in Client Dynamics for contacts, policies, and other agency records.
\nAll examples use mock data. Replace IDs, filenames, signed tokens, and other values with values returned by your Client Dynamics portal.
\n","_postman_id":"3a1d04b7-7659-47dd-bda8-91e9e1849165"},{"name":"Downloads","item":[{"name":"list","item":[{"name":"Retrieve a list of vendor Downloads","id":"f915abca-a361-43d9-a9cf-a0f402abefe0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Agency-Id","value":"agencyId","description":"(Required) Your Client Dynamics agency ID
\n"},{"key":"X-API-Key","value":"apiKey","description":"(Required) Your Client Dynamics API key
\n"}],"url":"https://defaultClient.clientdynamics.com/api/Downloads/list?limit=25&offset=0&vendor=ivans&fileProcessed=&fileParsed=","description":"Lists vendor download records previously recorded for the authenticated agency. File retrieval is live from the vendor.
\n","urlObject":{"path":["Downloads","list"],"host":["https://defaultClient.clientdynamics.com/api"],"query":[{"description":{"content":"Optional. Maximum number of records to return.
\n","type":"text/plain"},"key":"limit","value":"25"},{"description":{"content":"Optional. Pagination offset.
\n","type":"text/plain"},"key":"offset","value":"0"},{"description":{"content":"Optional. Vendor name. Currently ivans.
\n","type":"text/plain"},"key":"vendor","value":"ivans"},{"description":{"content":"Optional. Filter by processed state: 0 or 1.
\n","type":"text/plain"},"key":"fileProcessed","value":""},{"description":{"content":"Optional. Filter by parsed state: 0 or 1.
\n","type":"text/plain"},"key":"fileParsed","value":""}],"variable":[]}},"response":[{"id":"71579feb-96f8-40f5-9c51-c76deeaff668","name":"A list of vendor Downloads","originalRequest":{"method":"GET","header":[{"key":"X-Agency-Id","value":"agencyId","description":"(Required) Your Client Dynamics agency ID"},{"key":"X-API-Key","value":"apiKey","description":"(Required) Your Client Dynamics API key"}],"url":{"raw":"https://defaultClient.clientdynamics.com/api/Downloads/list?limit=25&offset=0&vendor=ivans&fileProcessed=&fileParsed=","host":["https://defaultClient.clientdynamics.com/api"],"path":["Downloads","list"],"query":[{"key":"limit","value":"25","description":"Optional. Maximum number of records to return."},{"key":"offset","value":"0","description":"Optional. Pagination offset."},{"key":"vendor","value":"ivans","description":"Optional. Vendor name. Currently ivans."},{"key":"fileProcessed","value":"","description":"Optional. Filter by processed state: 0 or 1."},{"key":"fileParsed","value":"","description":"Optional. Filter by parsed state: 0 or 1."}]},"description":"Lists vendor download records previously recorded for the authenticated agency. File retrieval is live from the vendor."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Success\",\n \"vendor\": \"ivans\",\n \"num_records\": 2,\n \"limit\": 25,\n \"offset\": 0,\n \"results\": [\n {\n \"downloadId\": 1001,\n \"vendor\": \"ivans\",\n \"vendorFileId\": \"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\",\n \"downloaded\": \"2026-01-15 11:05:00\",\n \"fileName\": \"mock-policy-download.dat\",\n \"sender\": \"MOCK.SENDER01\",\n \"receiver\": \"MOCK.RECEIVER01\",\n \"fileParsed\": false,\n \"fileProcessed\": false\n },\n {\n \"downloadId\": 1002,\n \"vendor\": \"ivans\",\n \"vendorFileId\": \"bbbbbbbb-cccc-dddd-eeee-ffffffffffff\",\n \"downloaded\": \"2026-01-15 11:15:00\",\n \"fileName\": \"mock-claim-download.dat\",\n \"sender\": \"MOCK.SENDER02\",\n \"receiver\": \"MOCK.RECEIVER01\",\n \"fileParsed\": true,\n \"fileProcessed\": true\n }\n ]\n}"}],"_postman_id":"f915abca-a361-43d9-a9cf-a0f402abefe0"}],"id":"62720213-20e7-4cf9-a43b-c8f2aa1dde23","_postman_id":"62720213-20e7-4cf9-a43b-c8f2aa1dde23","description":""},{"name":"get","item":[{"name":"Retrieve a vendor Download by downloadId","id":"2d054603-185b-496f-94d0-4ccde03f0832","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Agency-Id","value":"agencyId","description":"(Required) Your Client Dynamics agency ID
\n"},{"key":"X-API-Key","value":"apiKey","description":"(Required) Your Client Dynamics API key
\n"}],"url":"https://defaultClient.clientdynamics.com/api/Downloads/get?downloadId=1001&returnEncoded=false&decompressFile=true","description":"Retrieves a vendor download live from the vendor by download history ID. Returns a signed download URL by default.
\n","urlObject":{"path":["Downloads","get"],"host":["https://defaultClient.clientdynamics.com/api"],"query":[{"description":{"content":"(Required when vendorFileId is not supplied) Download history ID.
\n","type":"text/plain"},"key":"downloadId","value":"1001"},{"description":{"content":"When false, returns a short-lived signed download URL.
\n","type":"text/plain"},"key":"returnEncoded","value":"false"},{"description":{"content":"Optional. Requests decompressed file content from the vendor when supported.
\n","type":"text/plain"},"key":"decompressFile","value":"true"}],"variable":[]}},"response":[{"id":"997a1772-8199-45ad-9d7a-45aada9b3a1a","name":"Vendor Download retrieved as signed URL","originalRequest":{"method":"GET","header":[{"key":"X-Agency-Id","value":"agencyId","description":"(Required) Your Client Dynamics agency ID"},{"key":"X-API-Key","value":"apiKey","description":"(Required) Your Client Dynamics API key"}],"url":{"raw":"https://defaultClient.clientdynamics.com/api/Downloads/get?downloadId=1001&returnEncoded=false&decompressFile=true","host":["https://defaultClient.clientdynamics.com/api"],"path":["Downloads","get"],"query":[{"key":"downloadId","value":"1001","description":"(Required when vendorFileId is not supplied) Download history ID."},{"key":"returnEncoded","value":"false","description":"When false, returns a short-lived signed download URL."},{"key":"decompressFile","value":"true","description":"Optional. Requests decompressed file content from the vendor when supported."}]},"description":"Retrieves a vendor download live from the vendor by download history ID. Returns a signed download URL by default."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Success\",\n \"vendor\": \"ivans\",\n \"downloadId\": 1001,\n \"vendorFileId\": \"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\",\n \"fileName\": \"mock-policy-download.dat\",\n \"fileType\": \"application/octet-stream\",\n \"fileSize\": \"32768\",\n \"returnEncoded\": false,\n \"downloadUrl\": \"/api/Downloads/download?t=eyJ2IjoxLCJleHAiOjE5MDAwMDAwMDB9.mock-signature\",\n \"expiresAt\": \"2026-01-15T11:10:00-05:00\"\n}"},{"id":"ef821d13-951c-4693-b032-e0706c1a7e5c","name":"Vendor file no longer available","originalRequest":{"method":"GET","header":[{"key":"X-Agency-Id","value":"agencyId","description":"(Required) Your Client Dynamics agency ID"},{"key":"X-API-Key","value":"apiKey","description":"(Required) Your Client Dynamics API key"}],"url":{"raw":"https://defaultClient.clientdynamics.com/api/Downloads/get?downloadId=1001&returnEncoded=false&decompressFile=true","host":["https://defaultClient.clientdynamics.com/api"],"path":["Downloads","get"],"query":[{"key":"downloadId","value":"1001","description":"(Required when vendorFileId is not supplied) Download history ID."},{"key":"returnEncoded","value":"false","description":"When false, returns a short-lived signed download URL."},{"key":"decompressFile","value":"true","description":"Optional. Requests decompressed file content from the vendor when supported."}]},"description":"Retrieves a vendor download live from the vendor by download history ID. Returns a signed download URL by default."},"status":"Gone","code":410,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Error\",\n \"statusMessage\": \"Vendor file is no longer available\"\n}"}],"_postman_id":"2d054603-185b-496f-94d0-4ccde03f0832"},{"name":"Retrieve a vendor Download as base64","id":"277b49eb-d724-45c1-8ea7-150583a947c8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Agency-Id","value":"agencyId","description":"(Required) Your Client Dynamics agency ID
\n"},{"key":"X-API-Key","value":"apiKey","description":"(Required) Your Client Dynamics API key
\n"}],"url":"https://defaultClient.clientdynamics.com/api/Downloads/get?downloadId=1001&returnEncoded=true&decompressFile=true","description":"Retrieves a vendor download live from the vendor and returns base64 file content.
\n","urlObject":{"path":["Downloads","get"],"host":["https://defaultClient.clientdynamics.com/api"],"query":[{"description":{"content":"(Required when vendorFileId is not supplied) Download history ID.
\n","type":"text/plain"},"key":"downloadId","value":"1001"},{"description":{"content":"When true, returns base64 file content.
\n","type":"text/plain"},"key":"returnEncoded","value":"true"},{"description":{"content":"Optional. Requests decompressed file content from the vendor when supported.
\n","type":"text/plain"},"key":"decompressFile","value":"true"}],"variable":[]}},"response":[{"id":"644d016e-a94d-4923-87a4-1a81c9462683","name":"Vendor Download retrieved as base64","originalRequest":{"method":"GET","header":[{"key":"X-Agency-Id","value":"agencyId","description":"(Required) Your Client Dynamics agency ID"},{"key":"X-API-Key","value":"apiKey","description":"(Required) Your Client Dynamics API key"}],"url":{"raw":"https://defaultClient.clientdynamics.com/api/Downloads/get?downloadId=1001&returnEncoded=true&decompressFile=true","host":["https://defaultClient.clientdynamics.com/api"],"path":["Downloads","get"],"query":[{"key":"downloadId","value":"1001","description":"(Required when vendorFileId is not supplied) Download history ID."},{"key":"returnEncoded","value":"true","description":"When true, returns base64 file content."},{"key":"decompressFile","value":"true","description":"Optional. Requests decompressed file content from the vendor when supported."}]},"description":"Retrieves a vendor download live from the vendor and returns base64 file content."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Success\",\n \"vendor\": \"ivans\",\n \"downloadId\": 1001,\n \"vendorFileId\": \"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\",\n \"fileName\": \"mock-policy-download.dat\",\n \"fileType\": \"application/octet-stream\",\n \"fileSize\": \"32768\",\n \"returnEncoded\": true,\n \"fileContent\": \"TU9DSyBJVkFOUyBET1dOTE9BRCBDT05URU5UCg==\"\n}"}],"_postman_id":"277b49eb-d724-45c1-8ea7-150583a947c8"},{"name":"Retrieve a vendor Download by vendorFileId","id":"1a867957-3a91-45c8-80fe-16e5bfb4b1ec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Agency-Id","value":"agencyId","description":"(Required) Your Client Dynamics agency ID
\n"},{"key":"X-API-Key","value":"apiKey","description":"(Required) Your Client Dynamics API key
\n"}],"url":"https://defaultClient.clientdynamics.com/api/Downloads/get?vendorFileId=aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee&returnEncoded=false&decompressFile=true","description":"Retrieves a vendor download live from the vendor by vendor file ID.
\n","urlObject":{"path":["Downloads","get"],"host":["https://defaultClient.clientdynamics.com/api"],"query":[{"description":{"content":"(Required when downloadId is not supplied) Vendor file ID.
\n","type":"text/plain"},"key":"vendorFileId","value":"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"},{"description":{"content":"When false, returns a short-lived signed download URL.
\n","type":"text/plain"},"key":"returnEncoded","value":"false"},{"description":{"content":"Optional. Requests decompressed file content from the vendor when supported.
\n","type":"text/plain"},"key":"decompressFile","value":"true"}],"variable":[]}},"response":[{"id":"ea5eb92d-261f-4ec6-859f-220ba7b94af1","name":"Vendor Download retrieved by vendorFileId","originalRequest":{"method":"GET","header":[{"key":"X-Agency-Id","value":"agencyId","description":"(Required) Your Client Dynamics agency ID"},{"key":"X-API-Key","value":"apiKey","description":"(Required) Your Client Dynamics API key"}],"url":{"raw":"https://defaultClient.clientdynamics.com/api/Downloads/get?vendorFileId=aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee&returnEncoded=false&decompressFile=true","host":["https://defaultClient.clientdynamics.com/api"],"path":["Downloads","get"],"query":[{"key":"vendorFileId","value":"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee","description":"(Required when downloadId is not supplied) Vendor file ID."},{"key":"returnEncoded","value":"false","description":"When false, returns a short-lived signed download URL."},{"key":"decompressFile","value":"true","description":"Optional. Requests decompressed file content from the vendor when supported."}]},"description":"Retrieves a vendor download live from the vendor by vendor file ID."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Success\",\n \"vendor\": \"ivans\",\n \"downloadId\": 1001,\n \"vendorFileId\": \"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\",\n \"fileName\": \"mock-policy-download.dat\",\n \"fileType\": \"application/octet-stream\",\n \"fileSize\": \"32768\",\n \"returnEncoded\": false,\n \"downloadUrl\": \"/api/Downloads/download?t=eyJ2IjoxLCJleHAiOjE5MDAwMDAwMDB9.mock-signature\",\n \"expiresAt\": \"2026-01-15T11:10:00-05:00\"\n}"}],"_postman_id":"1a867957-3a91-45c8-80fe-16e5bfb4b1ec"}],"id":"c81ec6ba-c3f6-4c97-973c-1724bba3d35e","_postman_id":"c81ec6ba-c3f6-4c97-973c-1724bba3d35e","description":""},{"name":"download","item":[{"name":"Download a vendor file using a signed URL","id":"2ca51888-9663-4cdc-8534-bcf508c75407","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Agency-Id","value":"agencyId","description":"(Required) Your Client Dynamics agency ID
\n"},{"key":"X-API-Key","value":"apiKey","description":"(Required) Your Client Dynamics API key
\n"}],"url":"https://defaultClient.clientdynamics.com/api/Downloads/download?t=eyJ2IjoxLCJleHAiOjE5MDAwMDAwMDB9.mock-signature","description":"Downloads the binary vendor file using the short-lived signed token returned by /Downloads/get.
\n","urlObject":{"path":["Downloads","download"],"host":["https://defaultClient.clientdynamics.com/api"],"query":[{"description":{"content":"(Required) Signed token returned by /Downloads/get when returnEncoded=false.
\n","type":"text/plain"},"key":"t","value":"eyJ2IjoxLCJleHAiOjE5MDAwMDAwMDB9.mock-signature"}],"variable":[]}},"response":[{"id":"e4973f2a-890a-4d49-81b3-5047cdcda642","name":"Binary vendor file response","originalRequest":{"method":"GET","header":[{"key":"X-Agency-Id","value":"agencyId","description":"(Required) Your Client Dynamics agency ID"},{"key":"X-API-Key","value":"apiKey","description":"(Required) Your Client Dynamics API key"}],"url":{"raw":"https://defaultClient.clientdynamics.com/api/Downloads/download?t=eyJ2IjoxLCJleHAiOjE5MDAwMDAwMDB9.mock-signature","host":["https://defaultClient.clientdynamics.com/api"],"path":["Downloads","download"],"query":[{"key":"t","value":"eyJ2IjoxLCJleHAiOjE5MDAwMDAwMDB9.mock-signature","description":"(Required) Signed token returned by /Downloads/get when returnEncoded=false."}]},"description":"Downloads the binary vendor file using the short-lived signed token returned by /Downloads/get."},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/octet-stream","type":"text"}],"cookie":[],"responseTime":null,"body":"Live third-party vendor download access.
\n/Downloads lists vendor files that Client Dynamics has previously recorded in vendor download history, then retrieves the raw file live from the third-party vendor when requested. Raw vendor files are not guaranteed to be retained by Client Dynamics. Availability depends on the vendor.
All examples use mock data. Replace IDs, filenames, signed tokens, and other values with values returned by your Client Dynamics portal.
\n","_postman_id":"d10d52fd-cee4-46db-b8c3-a2ed545ad5b3"}],"variable":[{"key":"clientDomain","value":"defaultClient"},{"key":"agencyId","value":"agencyId"},{"key":"apiKey","value":"apiKey"},{"key":"baseUrl","value":"https://defaultClient.clientdynamics.com/api"}]}