{"info":{"_postman_id":"cf79b3a5-fd81-468d-9a36-38b70c9e367a","name":"Findigs Client API","description":"

Note: this API is not available to new clients. Customers already using the Findigs Client API can continue as normal. Reach out to integrations@findigs.com with any questions regarding this service.

\n

Programmatic resource for interacting with Findigs, and integrating Findigs data into existing systems and workflows.

\n

Dive into the endpoints using the menu on the left.

\n

Authentication

\n

All endpoints documented here are accessed using a scoped API key, passed in a request header X-API-KEY.

\n

Please reach out to the Findigs team directly for sandbox and production keys.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Authentication","slug":"authentication"}],"owner":"23330391","collectionId":"cf79b3a5-fd81-468d-9a36-38b70c9e367a","publishedId":"2s9YsT5oLp","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-06-09T15:00:15.000Z"},"item":[{"name":"listings","item":[{"name":"{listing_id}","item":[{"name":"Get Listing","id":"ee22d030-9847-4721-bda6-0936c91006f2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://dev.api.client.findigs.com/listings/:listing_id","description":"

Retrieve a specific listing by id (or external_id in the future?)

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"•••••••"}]},"isInherited":true,"source":{"_postman_id":"cf79b3a5-fd81-468d-9a36-38b70c9e367a","id":"cf79b3a5-fd81-468d-9a36-38b70c9e367a","name":"Findigs Client API","type":"collection"}},"urlObject":{"path":["listings",":listing_id"],"host":["https://dev.api.client.findigs.com"],"query":[],"variable":[{"id":"25ceb032-c066-48c2-bffd-5e03389fcde8","type":"any","value":"","key":"listing_id"}]}},"response":[{"id":"71358e5d-5e58-4572-8881-7f531c91805f","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-KEY","value":""}],"url":{"raw":"https://dev.api.client.findigs.com/listings/:listing_id","host":["https://dev.api.client.findigs.com"],"path":["listings",":listing_id"],"variable":[{"key":"listing_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"CLOSED\",\n \"address\": {\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\"\n },\n \"url\": \"\",\n \"id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"rent_amount\": \"\",\n \"date_available\": \"\"\n}"},{"id":"0d1b00c6-260e-410b-a18f-372233a3225b","name":"Validation Error","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-KEY","value":""}],"url":{"raw":"https://dev.api.client.findigs.com/listings/:listing_id","host":["https://dev.api.client.findigs.com"],"path":["listings",":listing_id"],"variable":[{"key":"listing_id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n }\n ]\n}"}],"_postman_id":"ee22d030-9847-4721-bda6-0936c91006f2"},{"name":"Patch Listing","id":"1efe5328-c0ea-42cc-aabd-ccfcf6329058","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"rent_amount\": \"\",\n \"date_available\": \"\",\n \"status\": \"CLOSED\",\n \"address\": {\n \"address_line_1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"64425\",\n \"address_line_2\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://dev.api.client.findigs.com/listings/:listing_id","description":"

PATCH update the listing specified.\nAll fields in the body are optional, and only those provided will be set.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"•••••••"}]},"isInherited":true,"source":{"_postman_id":"cf79b3a5-fd81-468d-9a36-38b70c9e367a","id":"cf79b3a5-fd81-468d-9a36-38b70c9e367a","name":"Findigs Client API","type":"collection"}},"urlObject":{"path":["listings",":listing_id"],"host":["https://dev.api.client.findigs.com"],"query":[],"variable":[{"id":"545fa44b-75a9-4fea-b3fa-ce0061fcdc3c","type":"any","value":"","key":"listing_id"}]}},"response":[{"id":"ed9ae1ca-bab1-4ed5-af30-e937f28d571d","name":"Successful Response","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-KEY","value":""}],"body":{"mode":"raw","raw":"{\n \"rent_amount\": \"\",\n \"date_available\": \"\",\n \"status\": \"CLOSED\",\n \"address\": {\n \"address_line_1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"64425\",\n \"address_line_2\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://dev.api.client.findigs.com/listings/:listing_id","host":["https://dev.api.client.findigs.com"],"path":["listings",":listing_id"],"variable":[{"key":"listing_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"CLOSED\",\n \"address\": {\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\"\n },\n \"url\": \"\",\n \"id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"rent_amount\": \"\",\n \"date_available\": \"\"\n}"},{"id":"479adfd9-3ee3-4685-b8f5-819e8479dad6","name":"Validation Error","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-KEY","value":""}],"body":{"mode":"raw","raw":"{\n \"rent_amount\": \"\",\n \"date_available\": \"\",\n \"status\": \"CLOSED\",\n \"address\": {\n \"address_line_1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"64425\",\n \"address_line_2\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://dev.api.client.findigs.com/listings/:listing_id","host":["https://dev.api.client.findigs.com"],"path":["listings",":listing_id"],"variable":[{"key":"listing_id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n }\n ]\n}"}],"_postman_id":"1efe5328-c0ea-42cc-aabd-ccfcf6329058"}],"id":"1036a2bc-de7f-4dc4-9ea1-57960dd87032","_postman_id":"1036a2bc-de7f-4dc4-9ea1-57960dd87032","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"•••••••"}]},"isInherited":true,"source":{"_postman_id":"cf79b3a5-fd81-468d-9a36-38b70c9e367a","id":"cf79b3a5-fd81-468d-9a36-38b70c9e367a","name":"Findigs Client API","type":"collection"}}},{"name":"Get Listings","id":"e6c96106-8d3b-41bd-9094-31df0cdd5759","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://dev.api.client.findigs.com/listings/","description":"

Fetch all listings

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"•••••••"}]},"isInherited":true,"source":{"_postman_id":"cf79b3a5-fd81-468d-9a36-38b70c9e367a","id":"cf79b3a5-fd81-468d-9a36-38b70c9e367a","name":"Findigs Client API","type":"collection"}},"urlObject":{"path":["listings",""],"host":["https://dev.api.client.findigs.com"],"query":[{"disabled":true,"key":"created_at__gte","value":""},{"disabled":true,"key":"created_at__lte","value":""},{"disabled":true,"key":"updated_at__gte","value":""},{"disabled":true,"key":"updated_at__lte","value":""},{"disabled":true,"key":"page","value":"1"},{"disabled":true,"key":"size","value":"50"}],"variable":[]}},"response":[{"id":"c507510b-6edc-48d2-80ec-34bff2a24dfe","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-KEY","value":""}],"url":{"raw":"https://dev.api.client.findigs.com/listings/?created_at__gte=&created_at__lte=&updated_at__gte=&updated_at__lte=&page=1&size=50","host":["https://dev.api.client.findigs.com"],"path":["listings",""],"query":[{"key":"created_at__gte","value":""},{"key":"created_at__lte","value":""},{"key":"updated_at__gte","value":""},{"key":"updated_at__lte","value":""},{"key":"page","value":"1"},{"key":"size","value":"50"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"status\": \"CLOSED\",\n \"address\": {\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\"\n },\n \"url\": \"\",\n \"id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"rent_amount\": \"\",\n \"date_available\": \"\"\n },\n {\n \"status\": \"LOCKED\",\n \"address\": {\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\"\n },\n \"url\": \"\",\n \"id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"rent_amount\": \"\",\n \"date_available\": \"\"\n }\n ],\n \"total\": \"\",\n \"page\": \"\",\n \"size\": \"\",\n \"pages\": \"\"\n}"},{"id":"7a760084-2482-4634-b952-f02a995a91b1","name":"Validation Error","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-KEY","value":""}],"url":{"raw":"https://dev.api.client.findigs.com/listings/?created_at__gte=&created_at__lte=&updated_at__gte=&updated_at__lte=&page=1&size=50","host":["https://dev.api.client.findigs.com"],"path":["listings",""],"query":[{"key":"created_at__gte","value":""},{"key":"created_at__lte","value":""},{"key":"updated_at__gte","value":""},{"key":"updated_at__lte","value":""},{"key":"page","value":"1"},{"key":"size","value":"50"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n }\n ]\n}"}],"_postman_id":"e6c96106-8d3b-41bd-9094-31df0cdd5759"},{"name":"Post Listing","id":"2cdb3a1c-cd37-4fb1-bb70-f82a432ac91d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"rent_amount\": \"\",\n \"date_available\": \"\",\n \"status\": \"LOCKED\",\n \"address\": {\n \"address_line_1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"80959-7885\",\n \"address_line_2\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://dev.api.client.findigs.com/listings/","description":"

Create a listing with all the information:

\n
    \n
  • rent_amount: The rent in dollars as a decimal
    • \n
  • date_available: Date the listing is first available for move in.
    • \n
  • status: A required status
    • \n
  • address: The physical address of the listing
    • \n
\n

Sandbox

\n

When a listing is POSTed to the sandbox, applications and groups will
automatically be generated for it.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"•••••••"}]},"isInherited":true,"source":{"_postman_id":"cf79b3a5-fd81-468d-9a36-38b70c9e367a","id":"cf79b3a5-fd81-468d-9a36-38b70c9e367a","name":"Findigs Client API","type":"collection"}},"urlObject":{"path":["listings",""],"host":["https://dev.api.client.findigs.com"],"query":[],"variable":[]}},"response":[{"id":"2fd4cd8e-eecb-4b88-818a-8247b2347c49","name":"Successful Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-KEY","value":""}],"body":{"mode":"raw","raw":"{\n \"rent_amount\": \"\",\n \"date_available\": \"\",\n \"status\": \"LOCKED\",\n \"address\": {\n \"address_line_1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"80959-7885\",\n \"address_line_2\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://dev.api.client.findigs.com/listings/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"CLOSED\",\n \"address\": {\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\"\n },\n \"url\": \"\",\n \"id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"rent_amount\": \"\",\n \"date_available\": \"\"\n}"},{"id":"b67c3afe-b4f5-4e8d-8f09-90ca7b6be2ed","name":"Validation Error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-KEY","value":""}],"body":{"mode":"raw","raw":"{\n \"rent_amount\": \"\",\n \"date_available\": \"\",\n \"status\": \"LOCKED\",\n \"address\": {\n \"address_line_1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"80959-7885\",\n \"address_line_2\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://dev.api.client.findigs.com/listings/"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n }\n ]\n}"}],"_postman_id":"2cdb3a1c-cd37-4fb1-bb70-f82a432ac91d"}],"id":"f5e64b6f-4bf8-4d98-81ea-6825c50a5f7b","description":"

A Findigs listing object dictates the window of time during which a unit (a physical location) will accept rental applications.

\n

This resource manages related objects such as unit and property behind the scenes. If you have a need to maintain these objects in the Findigs system, please reach out to the Findigs team directly to discuss potential options and approaches.

\n

Applications will not be accepted if the listing is designated as CLOSED (either by action in the Findigs UI, or a PATCH call to the listing that could render its status CLOSED.)

\n","_postman_id":"f5e64b6f-4bf8-4d98-81ea-6825c50a5f7b","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"•••••••"}]},"isInherited":true,"source":{"_postman_id":"cf79b3a5-fd81-468d-9a36-38b70c9e367a","id":"cf79b3a5-fd81-468d-9a36-38b70c9e367a","name":"Findigs Client API","type":"collection"}}},{"name":"applications","item":[{"name":"{application_id}","item":[{"name":"Get Application","id":"6efa42e9-5ec0-4a59-b570-16326ca760b5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://dev.api.client.findigs.com/applications/:application_id?embed_bi_data=false","description":"

Endpoint to retrieve an individual application by its id

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"•••••••"}]},"isInherited":true,"source":{"_postman_id":"cf79b3a5-fd81-468d-9a36-38b70c9e367a","id":"cf79b3a5-fd81-468d-9a36-38b70c9e367a","name":"Findigs Client API","type":"collection"}},"urlObject":{"path":["applications",":application_id"],"host":["https://dev.api.client.findigs.com"],"query":[{"description":{"content":"

Retrieves BI data related to the application.

\n","type":"text/plain"},"key":"embed_bi_data","value":"false"}],"variable":[{"id":"3d1b8207-e72e-4aa2-a61d-20bff80856ec","type":"any","value":"","key":"application_id"}]}},"response":[{"id":"996142d3-1889-4069-94ba-45f44e962071","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"X-API-KEY","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"https://dev.api.client.findigs.com/applications/:application_id?embed_bi_data=false","host":["https://dev.api.client.findigs.com"],"path":["applications",":application_id"],"query":[{"key":"embed_bi_data","value":"false","description":"Retrieves BI data related to the application."}],"variable":[{"key":"application_id","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"listing_id\": \"\",\n \"group_id\": \"\",\n \"type\": \"applicant\",\n \"status\": \"completed\",\n \"group_status\": \"incomplete\",\n \"pet_data\": [\n {\n \"type\": \"\",\n \"breed\": \"\",\n \"weight\": \"\",\n \"age\": \"\",\n \"is_service_animal\": false\n },\n {\n \"type\": \"\",\n \"breed\": \"\",\n \"weight\": \"\",\n \"age\": \"\",\n \"is_service_animal\": false\n }\n ],\n \"id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"self_reported_data\": {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"phone\": \"136685532629948\"\n },\n \"current_employment_data\": {\n \"type\": \"own\",\n \"income\": \"\",\n \"company\": \"\",\n \"position\": \"\",\n \"start_date\": \"\"\n },\n \"credit_report_data\": {\n \"credit\": \"429\",\n \"criminal\": \"\",\n \"eviction\": \"\",\n \"cautions\": [\n \"\",\n \"\"\n ]\n },\n \"mandatory_disclosures\": {\n \"qBankruptcy\": \"\",\n \"qBreakLease\": \"\",\n \"qDamage\": \"\",\n \"qEvict\": \"\",\n \"qFelony\": \"\",\n \"qForeclosure\": \"\",\n \"qNonPayment\": \"\",\n \"qOutstandingJudgements\": \"\",\n \"qRentersInsurance\": \"\",\n \"qSection8\": \"\",\n \"qSmoke\": \"\"\n },\n \"ancillary_questions\": [\n {\n \"response\": \"Yes\",\n \"questionText\": \"Custom question with a Yes response.\",\n \"questionType\": \"yes-no\"\n },\n {\n \"response\": \"No\",\n \"questionText\": \"Custom question with a No response.\",\n \"questionType\": \"yes-no\"\n },\n {\n \"response\": \"Free text response\",\n \"questionText\": \"Custom question with a text response.\",\n \"questionType\": \"text\"\n }\n ],\n \"bi_data\": {}\n}"},{"id":"eec2d10f-b500-4e3e-9cc2-58425cc404df","name":"Validation Error","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-KEY","value":""}],"url":{"raw":"https://dev.api.client.findigs.com/applications/:application_id?embed_bi_data=false","host":["https://dev.api.client.findigs.com"],"path":["applications",":application_id"],"query":[{"description":"Retrieves BI data related to the application.","key":"embed_bi_data","value":"false"}],"variable":[{"key":"application_id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n }\n ]\n}"}],"_postman_id":"6efa42e9-5ec0-4a59-b570-16326ca760b5"}],"id":"a6dd992d-e480-45ca-a89a-c0247d516508","_postman_id":"a6dd992d-e480-45ca-a89a-c0247d516508","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"•••••••"}]},"isInherited":true,"source":{"_postman_id":"cf79b3a5-fd81-468d-9a36-38b70c9e367a","id":"cf79b3a5-fd81-468d-9a36-38b70c9e367a","name":"Findigs Client API","type":"collection"}}},{"name":"Get Applications","id":"d4234fc7-26c1-4d48-b74b-894ce8deaee8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://dev.api.client.findigs.com/applications/","description":"

Get all applications matching the given query.\nParts of the query are two optional CSV id sets, which are mutually exclusive\nYou cannot query by both a group_id and a listing_id at once, to do so is a 400.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"•••••••"}]},"isInherited":true,"source":{"_postman_id":"cf79b3a5-fd81-468d-9a36-38b70c9e367a","id":"cf79b3a5-fd81-468d-9a36-38b70c9e367a","name":"Findigs Client API","type":"collection"}},"urlObject":{"path":["applications",""],"host":["https://dev.api.client.findigs.com"],"query":[{"disabled":true,"description":{"content":"

Comma separated list of group_ids to select Applications by

\n","type":"text/plain"},"key":"groups","value":""},{"disabled":true,"description":{"content":"

Comma separated list of group_ids to select Applications by

\n","type":"text/plain"},"key":"groups","value":""},{"disabled":true,"description":{"content":"

Comma separated list of listing_ids to select Applications by

\n","type":"text/plain"},"key":"listings","value":""},{"disabled":true,"description":{"content":"

Comma separated list of listing_ids to select Applications by

\n","type":"text/plain"},"key":"listings","value":""},{"disabled":true,"key":"page","value":"1"},{"disabled":true,"key":"size","value":"50"}],"variable":[]}},"response":[{"id":"5bae0f01-7920-443b-964e-7fb309451313","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"X-API-KEY","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"https://dev.api.client.findigs.com/applications/?groups=&listings=&page=1&size=50","host":["https://dev.api.client.findigs.com"],"path":["applications",""],"query":[{"key":"groups","value":"","description":"Comma separated list of group_ids to select Applications by"},{"key":"listings","value":"","description":"Comma separated list of listing_ids to select Applications by"},{"key":"page","value":"1"},{"key":"size","value":"50"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"listing_id\": \"\",\n \"group_id\": \"\",\n \"type\": \"guarantor\",\n \"status\": \"accepted\",\n \"group_status\": \"approved\",\n \"pet_data\": [\n {\n \"type\": \"\",\n \"breed\": \"\",\n \"weight\": \"\",\n \"age\": \"\",\n \"is_service_animal\": false\n },\n {\n \"type\": \"\",\n \"breed\": \"\",\n \"weight\": \"\",\n \"age\": \"\",\n \"is_service_animal\": false\n }\n ],\n \"id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"self_reported_data\": {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"phone\": \"14371\"\n },\n \"current_employment_data\": {\n \"type\": \"not\",\n \"income\": \"\",\n \"company\": \"\",\n \"position\": \"\",\n \"start_date\": \"\"\n },\n \"credit_report_data\": {\n \"credit\": \"787\",\n \"criminal\": \"\",\n \"eviction\": \"\",\n \"cautions\": [\n \"\",\n \"\"\n ]\n },\n \"mandatory_disclosures\": {\n \"qBankruptcy\": \"\",\n \"qBreakLease\": \"\",\n \"qDamage\": \"\",\n \"qEvict\": \"\",\n \"qFelony\": \"\",\n \"qForeclosure\": \"\",\n \"qNonPayment\": \"\",\n \"qOutstandingJudgements\": \"\",\n \"qRentersInsurance\": \"\",\n \"qSection8\": \"\",\n \"qSmoke\": \"\"\n },\n \"ancillary_questions\": [\n {\n \"response\": \"Yes\",\n \"questionText\": \"Custom question with a Yes response.\",\n \"questionType\": \"yes-no\"\n },\n {\n \"response\": \"No\",\n \"questionText\": \"Custom question with a No response.\",\n \"questionType\": \"yes-no\"\n },\n {\n \"response\": \"Free text response\",\n \"questionText\": \"Custom question with a text response.\",\n \"questionType\": \"text\"\n }\n ],\n \"bi_data\": {}\n },\n {\n \"listing_id\": \"\",\n \"group_id\": \"\",\n \"type\": \"guarantor\",\n \"status\": \"completed\",\n \"group_status\": \"onboarded\",\n \"pet_data\": [\n {\n \"type\": \"\",\n \"breed\": \"\",\n \"weight\": \"\",\n \"age\": \"\",\n \"is_service_animal\": false\n },\n {\n \"type\": \"\",\n \"breed\": \"\",\n \"weight\": \"\",\n \"age\": \"\",\n \"is_service_animal\": false\n }\n ],\n \"id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"self_reported_data\": {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"phone\": \"+8425587483\"\n },\n \"current_employment_data\": {\n \"type\": \"not\",\n \"income\": \"\",\n \"company\": \"\",\n \"position\": \"\",\n \"start_date\": \"\"\n },\n \"credit_report_data\": {\n \"credit\": \"790\",\n \"criminal\": \"\",\n \"eviction\": \"\",\n \"cautions\": [\n \"\",\n \"\"\n ]\n },\n \"mandatory_disclosures\": {\n \"qBankruptcy\": \"\",\n \"qBreakLease\": \"\",\n \"qDamage\": \"\",\n \"qEvict\": \"\",\n \"qFelony\": \"\",\n \"qForeclosure\": \"\",\n \"qNonPayment\": \"\",\n \"qOutstandingJudgements\": \"\",\n \"qRentersInsurance\": \"\",\n \"qSection8\": \"\",\n \"qSmoke\": \"\"\n },\n \"ancillary_questions\": [\n {\n \"response\": \"Yes\",\n \"questionText\": \"Custom question with a Yes response.\",\n \"questionType\": \"yes-no\"\n },\n {\n \"response\": \"No\",\n \"questionText\": \"Custom question with a No response.\",\n \"questionType\": \"yes-no\"\n },\n {\n \"response\": \"Free text response\",\n \"questionText\": \"Custom question with a text response.\",\n \"questionType\": \"text\"\n }\n ],\n \"bi_data\": {}\n }\n ],\n \"total\": \"\",\n \"page\": \"\",\n \"size\": \"\",\n \"pages\": \"\"\n}"},{"id":"944ce3d7-d4f9-4cdb-8aaf-b572bff9aed1","name":"Validation Error","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-KEY","value":""}],"url":{"raw":"https://dev.api.client.findigs.com/applications/?groups=&listings=&page=1&size=50","host":["https://dev.api.client.findigs.com"],"path":["applications",""],"query":[{"description":"Comma separated list of group_ids to select Applications by","key":"groups","value":""},{"description":"Comma separated list of listing_ids to select Applications by","key":"listings","value":""},{"key":"page","value":"1"},{"key":"size","value":"50"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n }\n ]\n}"}],"_postman_id":"d4234fc7-26c1-4d48-b74b-894ce8deaee8"}],"id":"5be085f9-7d6d-402a-847b-583f9cc12586","description":"

application objects contain all data relevant to a specific applicant's efforts to secure housing by means of completing a Findigs application.

\n","_postman_id":"5be085f9-7d6d-402a-847b-583f9cc12586","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"•••••••"}]},"isInherited":true,"source":{"_postman_id":"cf79b3a5-fd81-468d-9a36-38b70c9e367a","id":"cf79b3a5-fd81-468d-9a36-38b70c9e367a","name":"Findigs Client API","type":"collection"}}},{"name":"groups","item":[{"name":"{group_id}","item":[{"name":"Get Group","id":"d07decdf-6a3a-4856-855f-200ddfd7b535","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://dev.api.client.findigs.com/groups/:group_id?embed_bi_data=false","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"•••••••"}]},"isInherited":true,"source":{"_postman_id":"cf79b3a5-fd81-468d-9a36-38b70c9e367a","id":"cf79b3a5-fd81-468d-9a36-38b70c9e367a","name":"Findigs Client API","type":"collection"}},"urlObject":{"path":["groups",":group_id"],"host":["https://dev.api.client.findigs.com"],"query":[{"description":{"content":"

Retrieves BI data related to the application.

\n","type":"text/plain"},"key":"embed_bi_data","value":"false"}],"variable":[{"id":"350373fb-baa0-4397-92dc-419b9c153a86","type":"any","value":"","key":"group_id"}]}},"response":[{"id":"7d6901c0-694b-4b63-a8ce-ef83c221e6e8","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"X-API-KEY","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"https://dev.api.client.findigs.com/groups/:group_id?embed_bi_data=false","host":["https://dev.api.client.findigs.com"],"path":["groups",":group_id"],"query":[{"key":"embed_bi_data","value":"false","description":"Retrieves BI data related to the application."}],"variable":[{"key":"group_id","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"listing_id\": \"\",\n \"url\": \"\",\n \"status\": \"approved\",\n \"workflow_status\": \"\",\n \"applications\": [\n {\n \"listing_id\": \"\",\n \"group_id\": \"\",\n \"type\": \"applicant\",\n \"status\": \"in_progress\",\n \"group_status\": \"declined\",\n \"pet_data\": [\n {\n \"type\": \"\",\n \"breed\": \"\",\n \"weight\": \"\",\n \"age\": \"\",\n \"is_service_animal\": false\n },\n {\n \"type\": \"\",\n \"breed\": \"\",\n \"weight\": \"\",\n \"age\": \"\",\n \"is_service_animal\": false\n }\n ],\n \"id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"self_reported_data\": {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"phone\": \"+212\"\n },\n \"current_employment_data\": {\n \"type\": \"offer\",\n \"income\": \"\",\n \"company\": \"\",\n \"position\": \"\",\n \"start_date\": \"\"\n },\n \"credit_report_data\": {\n \"credit\": \"594\",\n \"criminal\": \"\",\n \"eviction\": \"\",\n \"cautions\": [\n \"\",\n \"\"\n ]\n },\n \"mandatory_disclosures\": {\n \"qBankruptcy\": \"\",\n \"qBreakLease\": \"\",\n \"qDamage\": \"\",\n \"qEvict\": \"\",\n \"qFelony\": \"\",\n \"qForeclosure\": \"\",\n \"qNonPayment\": \"\",\n \"qOutstandingJudgements\": \"\",\n \"qRentersInsurance\": \"\",\n \"qSection8\": \"\",\n \"qSmoke\": \"\"\n },\n \"ancillary_questions\": [\n {\n \"response\": \"Yes\",\n \"questionText\": \"Custom question with a Yes response.\",\n \"questionType\": \"yes-no\"\n },\n {\n \"response\": \"No\",\n \"questionText\": \"Custom question with a No response.\",\n \"questionType\": \"yes-no\"\n },\n {\n \"response\": \"Free text response\",\n \"questionText\": \"Custom question with a text response.\",\n \"questionType\": \"text\"\n }\n ],\n \"bi_data\": {}\n },\n {\n \"listing_id\": \"\",\n \"group_id\": \"\",\n \"type\": \"applicant\",\n \"status\": \"in_progress\",\n \"group_status\": \"passed\",\n \"pet_data\": [\n {\n \"type\": \"\",\n \"breed\": \"\",\n \"weight\": \"\",\n \"age\": \"\",\n \"is_service_animal\": false\n },\n {\n \"type\": \"\",\n \"breed\": \"\",\n \"weight\": \"\",\n \"age\": \"\",\n \"is_service_animal\": false\n }\n ],\n \"id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"self_reported_data\": {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"phone\": \"+9403544\"\n },\n \"current_employment_data\": {\n \"type\": \"offer\",\n \"income\": \"\",\n \"company\": \"\",\n \"position\": \"\",\n \"start_date\": \"\"\n },\n \"credit_report_data\": {\n \"credit\": \"039\",\n \"criminal\": \"\",\n \"eviction\": \"\",\n \"cautions\": [\n \"\",\n \"\"\n ]\n },\n \"mandatory_disclosures\": {\n \"qBankruptcy\": \"\",\n \"qBreakLease\": \"\",\n \"qDamage\": \"\",\n \"qEvict\": \"\",\n \"qFelony\": \"\",\n \"qForeclosure\": \"\",\n \"qNonPayment\": \"\",\n \"qOutstandingJudgements\": \"\",\n \"qRentersInsurance\": \"\",\n \"qSection8\": \"\",\n \"qSmoke\": \"\"\n },\n \"bi_data\": {}\n }\n ],\n \"id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"desired_move_in_date\": \"\",\n \"decline_details\": {},\n \"bi_data\": {}\n}"},{"id":"103cd2d8-5bd3-481c-a600-4290edc56e8e","name":"Validation Error","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-KEY","value":""}],"url":{"raw":"https://dev.api.client.findigs.com/groups/:group_id?embed_bi_data=false","host":["https://dev.api.client.findigs.com"],"path":["groups",":group_id"],"query":[{"description":"Retrieves BI data related to the application.","key":"embed_bi_data","value":"false"}],"variable":[{"key":"group_id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n }\n ]\n}"}],"_postman_id":"d07decdf-6a3a-4856-855f-200ddfd7b535"},{"name":"Get Group Detail","id":"98d6fc05-43a9-4739-b401-fe6f69b66296","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.findigs.com/common_application/:group_id/userapp_group_info/","description":"

This resource retrieves data from the same source as our UI, at https://app.findigs.com/group-applications/V2/groupid=:group_id

\n

Note that the Base URL is different, using our Core API to process.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"•••••••"}]},"isInherited":true,"source":{"_postman_id":"cf79b3a5-fd81-468d-9a36-38b70c9e367a","id":"cf79b3a5-fd81-468d-9a36-38b70c9e367a","name":"Findigs Client API","type":"collection"}},"urlObject":{"path":["common_application",":group_id","userapp_group_info",""],"host":["https://api.findigs.com"],"query":[],"variable":[{"type":"any","value":"","key":"group_id"}]}},"response":[],"_postman_id":"98d6fc05-43a9-4739-b401-fe6f69b66296"}],"id":"1ba43f85-3a95-4caf-96f8-1774a6ade9a7","_postman_id":"1ba43f85-3a95-4caf-96f8-1774a6ade9a7","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"•••••••"}]},"isInherited":true,"source":{"_postman_id":"cf79b3a5-fd81-468d-9a36-38b70c9e367a","id":"cf79b3a5-fd81-468d-9a36-38b70c9e367a","name":"Findigs Client API","type":"collection"}}},{"name":"Get Groups","id":"1cf45c6d-64a7-47cd-a202-0c07d2a0f1d6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://dev.api.client.findigs.com/groups/?listing_ids=&listing_ids=&status=cancelled&status=submitted&updated_at__gte=&updated_at__lte=&page=1&size=50","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"•••••••"}]},"isInherited":true,"source":{"_postman_id":"cf79b3a5-fd81-468d-9a36-38b70c9e367a","id":"cf79b3a5-fd81-468d-9a36-38b70c9e367a","name":"Findigs Client API","type":"collection"}},"urlObject":{"path":["groups",""],"host":["https://dev.api.client.findigs.com"],"query":[{"description":{"content":"

Comma separated list of listing_ids to select Groups by

\n","type":"text/plain"},"key":"listing_ids","value":""},{"description":{"content":"

Comma separated list of listing_ids to select Groups by

\n","type":"text/plain"},"key":"listing_ids","value":""},{"description":{"content":"

Status for group of applications

\n","type":"text/plain"},"key":"status","value":"cancelled"},{"description":{"content":"

Status for group of applications

\n","type":"text/plain"},"key":"status","value":"submitted"},{"key":"updated_at__gte","value":""},{"key":"updated_at__lte","value":""},{"key":"page","value":"1"},{"key":"size","value":"50"}],"variable":[]}},"response":[{"id":"9f2cd124-1ed9-4409-a610-8ff0c961810f","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"X-API-KEY","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"https://dev.api.client.findigs.com/groups/?listing_ids=&status=submitted&updated_at__gte=&updated_at__lte=&page=1&size=50","host":["https://dev.api.client.findigs.com"],"path":["groups",""],"query":[{"key":"listing_ids","value":"","description":"Comma separated list of listing_ids to select Groups by"},{"key":"status","value":"submitted","description":"Status for group of applications"},{"key":"updated_at__gte","value":""},{"key":"updated_at__lte","value":""},{"key":"page","value":"1"},{"key":"size","value":"50"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"listing_id\": \"\",\n \"url\": \"\",\n \"status\": \"cancelled\",\n \"workflow_status\": \"\",\n \"applications\": [\n {\n \"listing_id\": \"\",\n \"group_id\": \"\",\n \"type\": \"applicant\",\n \"status\": \"in_progress\",\n \"group_status\": \"approved\",\n \"pet_data\": [\n {\n \"type\": \"\",\n \"breed\": \"\",\n \"weight\": \"\",\n \"age\": \"\",\n \"is_service_animal\": false\n },\n {\n \"type\": \"\",\n \"breed\": \"\",\n \"weight\": \"\",\n \"age\": \"\",\n \"is_service_animal\": false\n }\n ],\n \"id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"self_reported_data\": {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"phone\": \"+11553\"\n },\n \"current_employment_data\": {\n \"type\": \"not\",\n \"income\": \"\",\n \"company\": \"\",\n \"position\": \"\",\n \"start_date\": \"\"\n },\n \"credit_report_data\": {\n \"credit\": \"056\",\n \"criminal\": \"\",\n \"eviction\": \"\",\n \"cautions\": [\n \"\",\n \"\"\n ]\n },\n \"mandatory_disclosures\": {\n \"qBankruptcy\": \"\",\n \"qBreakLease\": \"\",\n \"qDamage\": \"\",\n \"qEvict\": \"\",\n \"qFelony\": \"\",\n \"qForeclosure\": \"\",\n \"qNonPayment\": \"\",\n \"qOutstandingJudgements\": \"\",\n \"qRentersInsurance\": \"\",\n \"qSection8\": \"\",\n \"qSmoke\": \"\"\n },\n \"ancillary_questions\": [\n {\n \"response\": \"Yes\",\n \"questionText\": \"Custom question with a Yes response.\",\n \"questionType\": \"yes-no\"\n },\n {\n \"response\": \"No\",\n \"questionText\": \"Custom question with a No response.\",\n \"questionType\": \"yes-no\"\n },\n {\n \"response\": \"Free text response\",\n \"questionText\": \"Custom question with a text response.\",\n \"questionType\": \"text\"\n }\n ],\n \"bi_data\": {}\n },\n {\n \"listing_id\": \"\",\n \"group_id\": \"\",\n \"type\": \"guarantor\",\n \"status\": \"accepted\",\n \"group_status\": \"onboarded\",\n \"pet_data\": [\n {\n \"type\": \"\",\n \"breed\": \"\",\n \"weight\": \"\",\n \"age\": \"\",\n \"is_service_animal\": false\n },\n {\n \"type\": \"\",\n \"breed\": \"\",\n \"weight\": \"\",\n \"age\": \"\",\n \"is_service_animal\": false\n }\n ],\n \"id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"self_reported_data\": {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"phone\": \"+772\"\n },\n \"current_employment_data\": {\n \"type\": \"offer\",\n \"income\": \"\",\n \"company\": \"\",\n \"position\": \"\",\n \"start_date\": \"\"\n },\n \"credit_report_data\": {\n \"credit\": \"808\",\n \"criminal\": \"\",\n \"eviction\": \"\",\n \"cautions\": [\n \"\",\n \"\"\n ]\n },\n \"mandatory_disclosures\": {\n \"qBankruptcy\": \"\",\n \"qBreakLease\": \"\",\n \"qDamage\": \"\",\n \"qEvict\": \"\",\n \"qFelony\": \"\",\n \"qForeclosure\": \"\",\n \"qNonPayment\": \"\",\n \"qOutstandingJudgements\": \"\",\n \"qRentersInsurance\": \"\",\n \"qSection8\": \"\",\n \"qSmoke\": \"\"\n },\n \"ancillary_questions\": [\n {\n \"response\": \"Yes\",\n \"questionText\": \"Custom question with a Yes response.\",\n \"questionType\": \"yes-no\"\n },\n {\n \"response\": \"No\",\n \"questionText\": \"Custom question with a No response.\",\n \"questionType\": \"yes-no\"\n },\n {\n \"response\": \"Free text response\",\n \"questionText\": \"Custom question with a text response.\",\n \"questionType\": \"text\"\n }\n ],\n \"bi_data\": {}\n }\n ],\n \"id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"desired_move_in_date\": \"\",\n \"decline_details\": {},\n \"bi_data\": {}\n },\n {\n \"listing_id\": \"\",\n \"url\": \"\",\n \"status\": \"submitted\",\n \"workflow_status\": \"\",\n \"applications\": [\n {\n \"listing_id\": \"\",\n \"group_id\": \"\",\n \"type\": \"guarantor\",\n \"status\": \"accepted\",\n \"group_status\": \"cancelled\",\n \"pet_data\": [\n {\n \"type\": \"\",\n \"breed\": \"\",\n \"weight\": \"\",\n \"age\": \"\",\n \"is_service_animal\": false\n },\n {\n \"type\": \"\",\n \"breed\": \"\",\n \"weight\": \"\",\n \"age\": \"\",\n \"is_service_animal\": false\n }\n ],\n \"id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"self_reported_data\": {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"phone\": \"13863\"\n },\n \"current_employment_data\": {\n \"type\": \"offer\",\n \"income\": \"\",\n \"company\": \"\",\n \"position\": \"\",\n \"start_date\": \"\"\n },\n \"credit_report_data\": {\n \"credit\": \"552\",\n \"criminal\": \"\",\n \"eviction\": \"\",\n \"cautions\": [\n \"\",\n \"\"\n ]\n },\n \"mandatory_disclosures\": {\n \"qBankruptcy\": \"\",\n \"qBreakLease\": \"\",\n \"qDamage\": \"\",\n \"qEvict\": \"\",\n \"qFelony\": \"\",\n \"qForeclosure\": \"\",\n \"qNonPayment\": \"\",\n \"qOutstandingJudgements\": \"\",\n \"qRentersInsurance\": \"\",\n \"qSection8\": \"\",\n \"qSmoke\": \"\"\n },\n \"ancillary_questions\": [\n {\n \"response\": \"Yes\",\n \"questionText\": \"Custom question with a Yes response.\",\n \"questionType\": \"yes-no\"\n },\n {\n \"response\": \"No\",\n \"questionText\": \"Custom question with a No response.\",\n \"questionType\": \"yes-no\"\n },\n {\n \"response\": \"Free text response\",\n \"questionText\": \"Custom question with a text response.\",\n \"questionType\": \"text\"\n }\n ],\n \"bi_data\": {}\n },\n {\n \"listing_id\": \"\",\n \"group_id\": \"\",\n \"type\": \"applicant\",\n \"status\": \"accepted\",\n \"group_status\": \"pending_review\",\n \"pet_data\": [\n {\n \"type\": \"\",\n \"breed\": \"\",\n \"weight\": \"\",\n \"age\": \"\",\n \"is_service_animal\": false\n },\n {\n \"type\": \"\",\n \"breed\": \"\",\n \"weight\": \"\",\n \"age\": \"\",\n \"is_service_animal\": false\n }\n ],\n \"id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"self_reported_data\": {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"phone\": \"148629\"\n },\n \"current_employment_data\": {\n \"type\": \"offer\",\n \"income\": \"\",\n \"company\": \"\",\n \"position\": \"\",\n \"start_date\": \"\"\n },\n \"credit_report_data\": {\n \"credit\": \"651\",\n \"criminal\": \"\",\n \"eviction\": \"\",\n \"cautions\": [\n \"\",\n \"\"\n ]\n },\n \"mandatory_disclosures\": {\n \"qBankruptcy\": \"\",\n \"qBreakLease\": \"\",\n \"qDamage\": \"\",\n \"qEvict\": \"\",\n \"qFelony\": \"\",\n \"qForeclosure\": \"\",\n \"qNonPayment\": \"\",\n \"qOutstandingJudgements\": \"\",\n \"qRentersInsurance\": \"\",\n \"qSection8\": \"\",\n \"qSmoke\": \"\"\n },\n \"ancillary_questions\": [\n {\n \"response\": \"Yes\",\n \"questionText\": \"Custom question with a Yes response.\",\n \"questionType\": \"yes-no\"\n },\n {\n \"response\": \"No\",\n \"questionText\": \"Custom question with a No response.\",\n \"questionType\": \"yes-no\"\n },\n {\n \"response\": \"Free text response\",\n \"questionText\": \"Custom question with a text response.\",\n \"questionType\": \"text\"\n }\n ],\n \"bi_data\": {}\n }\n ],\n \"id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"desired_move_in_date\": \"\",\n \"decline_details\": {},\n \"bi_data\": {}\n }\n ],\n \"total\": \"\",\n \"page\": \"\",\n \"size\": \"\",\n \"pages\": \"\"\n}"},{"id":"34989afe-c62a-42d4-873f-7a376d3e4229","name":"Validation Error","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-KEY","value":""}],"url":{"raw":"https://dev.api.client.findigs.com/groups/?listing_ids=&status=submitted&updated_at__gte=&updated_at__lte=&page=1&size=50","host":["https://dev.api.client.findigs.com"],"path":["groups",""],"query":[{"description":"Comma separated list of listing_ids to select Groups by","key":"listing_ids","value":""},{"description":"Status for group of applications","key":"status","value":"submitted"},{"key":"updated_at__gte","value":""},{"key":"updated_at__lte","value":""},{"key":"page","value":"1"},{"key":"size","value":"50"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n }\n ]\n}"}],"_postman_id":"1cf45c6d-64a7-47cd-a202-0c07d2a0f1d6"}],"id":"9f1ef879-8043-4007-b62e-3a76a0318d84","description":"

a group is a collection of applications (and attributes that describe such a collection)

\n","_postman_id":"9f1ef879-8043-4007-b62e-3a76a0318d84","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"•••••••"}]},"isInherited":true,"source":{"_postman_id":"cf79b3a5-fd81-468d-9a36-38b70c9e367a","id":"cf79b3a5-fd81-468d-9a36-38b70c9e367a","name":"Findigs Client API","type":"collection"}}},{"name":"webhooks","item":[],"id":"810eef12-2028-4bee-88a8-deb25a24a60f","description":"

Webhooks provide an alternative to synchronous integration patterns for client applications.

\n

Findigs webhooks are fairly terse; given the object ID and type, you may choose to call a transactional GET operation to retrieve the details of the updated object.

\n

Webhook Setup

\n

Please provide Findigs with a URL that is configured to receive an HTTP POST request.

\n

Webhook payloads will adhere to the following format:

\n
{\n  \"object_id\": \"45b7476b-262c-4b6c-91da-7d9b5ba83e5a\",\n  \"event_name\": \"object_type.event_name\",\n  \"event_detail\": {\n    \"event_at\": \"2022-11-17T17:51:57.628894\"\n  }\n}\n\n
\n

When a successful POST request is received, a 200 response will indicate to Findigs that the webhook was received successfully.

\n

Valid Webhook event_name Values

\n

The following are valid webhook event_name values:

\n
    \n

  • applications.started

    \n
    • \n

  • applications.submitted

    \n
    • \n

  • groups.ready_for_review

    \n
    • \n

  • groups.approved

    \n
    • \n

  • groups.declined

    \n
    • \n

  • groups.cancelled

    \n
    • \n

  • groups.decision_reversed

    \n
    • \n

  • groups.custom_status_changed

    \n
    • \n

  • groups.assigned_user_changed

    \n
    • \n
\n

Webhook Retry Behavior

\n

A webhook is considered \"delivered\" if the response code from the client resource is 200.

\n

If a 200 response is not received, Findigs will retry the attempt up to 9 times over the 24 hours following the first failed attempt.

\n","_postman_id":"810eef12-2028-4bee-88a8-deb25a24a60f","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"•••••••"}]},"isInherited":true,"source":{"_postman_id":"cf79b3a5-fd81-468d-9a36-38b70c9e367a","id":"cf79b3a5-fd81-468d-9a36-38b70c9e367a","name":"Findigs Client API","type":"collection"}}}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-KEY"},{"key":"value","value":"•••••••"}]}},"event":[{"listen":"prerequest","script":{"id":"d3faaed5-cfad-4ef1-bdb5-be1f1237e08f","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"ede3bd88-1c69-4fc0-8096-ee74971955c5","type":"text/javascript","packages":{},"exec":[""]}}],"variable":[{"key":"baseUrl","value":"https://api.sandbox.findigs.com"},{"key":"cav1BaseUrl","value":"https://api.findigs.com"},{"key":"apiKey","value":"REPLACE","type":"string"}]}