Skip to content
tlyfePro Partner API

GetArchivedFlows

GET
/v2.0/openflow/flow/archived
curl --request GET \
  --url 'https://wl.api.cluster.openbrix.co.uk/v2.0/openflow/flow/archived?pageNo=0&sortOrder=DESC&sortBy=createdAt'

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters”
search
string
agent_id
number format: double
branch_id
number format: double
pageNo
number format: double
0
sortOrder
string
default: DESC
sortBy
string
default: createdAt

Responses

Section titled “ Responses ”

200

Section titled “200”

Ok

Media typeapplication/json
object
data
required
object
totalFlows
required
number format: double
pageSize
required
number format: double
flows
required
Array<object>
object
property
required
object
property_images
required
postcode
string
display_address
string
address_line4
string
address_line3
string
address_line2
string
address_line1
string
holding_deposit_button_text
required
string
nullable
verification_button_text
required
string
nullable
rental_offer_button_text
required
string
nullable
holding_deposit_message
required
string
nullable
landlord_button_text
required
string
nullable
property_button_text
required
string
nullable
verification_message
required
string
nullable
rental_offer_message
required
string
nullable
tenancy_button_text
required
string
nullable
move_in_button_text
required
string
nullable
landlord_message
required
string
nullable
property_message
required
string
nullable
tenancy_message
required
string
nullable
doc_button_text
required
string
nullable
move_in_message
required
string
nullable
doc_message
required
string
nullable
updatedAt
required
string format: date-time
createdAt
required
string format: date-time
bb_opt_out
required
boolean
besponse_contract_uploaded_at
required
string format: date-time
nullable
reapit_landlord_id
required
string
reapit_applicant_id
required
string
reapit_tenancy_id
required
string
bespoke_contract_url
required
string
nullable
is_bespoke_contract_uploaded
required
boolean
landlord_bank_account_id
required
number format: double
is_send_holding_deposit_details
required
boolean
is_send_deposit_setup_details
required
boolean
is_send_rental_offer_details
required
boolean
is_send_document_details
required
boolean
is_send_tenant_details
required
boolean
is_send_movein_details
required
boolean
is_show_save_continue_popup
required
boolean
move_in_money_from_lead_tenant
required
boolean
holding_deposit_collection_from_lead_tenant
required
boolean
is_flow_used
required
boolean
is_rental_payment_received_by_landlord
required
boolean
is_holding_deposit_received_by_landlord
required
boolean
is_movein_money_received_by_landlord
required
boolean
is_supporting_documents_seen
required
string
is_prescribed_contract_seen
required
boolean
movein_payee_ref
required
string
payee_ref
required
string
is_deleted
required
boolean
is_ast_signed
required
boolean
is_added_to_property
required
boolean
nha_contract_url
required
string
nullable
nha_generate_at
required
string format: date-time
nullable
is_nha_generated
required
boolean
envid
required
string
nullable
break_clause
required
string
common_conditions
required
string
additional_conditions
required
string
supporting_documents_url
required
string
nullable
prescribed_contract_url
required
string
nullable
uploaded_ast_contract_url
required
string
ast_uploaded_at
required
string format: date-time
ast_contract_signed_url
required
string
ast_contract_url
required
string
nullable
ast_generate_at
required
string format: date-time
nullable
is_ast_generated
required
boolean
how_to_rent_pdf_url
required
string
number_of_occupants
required
number format: double
verification_status
required
number format: double
landlord_status
required
number format: double
gurantor_status
required
number format: double
move_in_status
required
number format: double
holding_deposit_status
required
number format: double
rental_offer_status
required
number format: double
doc_status
required
number format: double
property_status
required
number format: double
tenancy_status
required
number format: double
is_completed
required
boolean
is_renewed
required
boolean
is_archived
required
boolean
percentage_completed
required
number format: double
renewed_from
required
number format: double
agent_id
required
number format: double
property_id
required
number format: double
branch_id
required
number format: double
openflow_id
required
number format: double
status
required
boolean
Examplegenerated
{
  "data": {
    "totalFlows": 1,
    "pageSize": 1,
    "flows": [
      {
        "property": {
          "property_images": "example",
          "postcode": "example",
          "display_address": "example",
          "address_line4": "example",
          "address_line3": "example",
          "address_line2": "example",
          "address_line1": "example"
        },
        "holding_deposit_button_text": "example",
        "verification_button_text": "example",
        "rental_offer_button_text": "example",
        "holding_deposit_message": "example",
        "landlord_button_text": "example",
        "property_button_text": "example",
        "verification_message": "example",
        "rental_offer_message": "example",
        "tenancy_button_text": "example",
        "move_in_button_text": "example",
        "landlord_message": "example",
        "property_message": "example",
        "tenancy_message": "example",
        "doc_button_text": "example",
        "move_in_message": "example",
        "doc_message": "example",
        "updatedAt": "2026-04-15T12:00:00Z",
        "createdAt": "2026-04-15T12:00:00Z",
        "bb_opt_out": true,
        "besponse_contract_uploaded_at": "2026-04-15T12:00:00Z",
        "reapit_landlord_id": "example",
        "reapit_applicant_id": "example",
        "reapit_tenancy_id": "example",
        "bespoke_contract_url": "example",
        "is_bespoke_contract_uploaded": true,
        "landlord_bank_account_id": 1,
        "is_send_holding_deposit_details": true,
        "is_send_deposit_setup_details": true,
        "is_send_rental_offer_details": true,
        "is_send_document_details": true,
        "is_send_tenant_details": true,
        "is_send_movein_details": true,
        "is_show_save_continue_popup": true,
        "move_in_money_from_lead_tenant": true,
        "holding_deposit_collection_from_lead_tenant": true,
        "is_flow_used": true,
        "is_rental_payment_received_by_landlord": true,
        "is_holding_deposit_received_by_landlord": true,
        "is_movein_money_received_by_landlord": true,
        "is_supporting_documents_seen": "example",
        "is_prescribed_contract_seen": true,
        "movein_payee_ref": "example",
        "payee_ref": "example",
        "is_deleted": true,
        "is_ast_signed": true,
        "is_added_to_property": true,
        "nha_contract_url": "example",
        "nha_generate_at": "2026-04-15T12:00:00Z",
        "is_nha_generated": true,
        "envid": "example",
        "break_clause": "example",
        "common_conditions": "example",
        "additional_conditions": "example",
        "supporting_documents_url": "example",
        "prescribed_contract_url": "example",
        "uploaded_ast_contract_url": "example",
        "ast_uploaded_at": "2026-04-15T12:00:00Z",
        "ast_contract_signed_url": "example",
        "ast_contract_url": "example",
        "ast_generate_at": "2026-04-15T12:00:00Z",
        "is_ast_generated": true,
        "how_to_rent_pdf_url": "example",
        "number_of_occupants": 1,
        "verification_status": 1,
        "landlord_status": 1,
        "gurantor_status": 1,
        "move_in_status": 1,
        "holding_deposit_status": 1,
        "rental_offer_status": 1,
        "doc_status": 1,
        "property_status": 1,
        "tenancy_status": 1,
        "is_completed": true,
        "is_renewed": true,
        "is_archived": true,
        "percentage_completed": 1,
        "renewed_from": 1,
        "agent_id": 1,
        "property_id": 1,
        "branch_id": 1,
        "openflow_id": 1
      }
    ]
  },
  "status": true
}