Skip to main content

Get integration by id

GEThttps://api.propexo.com/v1/admin/integrations/:integration_id/

Authentication​

  • AuthorizationBearer
    Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters​

integration_id stringrequired

The integration id

Query parameters​

order-by string

Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc

Default value: created_at:desc
updated_at_gte string | null

Filter to records updated at or after this datetime. Format: ISO 8601 (e.g. 2026-01-01T00:00:00Z)

updated_at_lte string | null

Filter to records updated at or before this datetime. Format: ISO 8601 (e.g. 2026-12-31T23:59:59Z)

last_seen_gte string | null

Filter to records whose last_seen date is on or after this datetime. Format: ISO 8601 (e.g. 2026-01-01T00:00:00Z)

last_seen_lte string | null

Filter to records whose last_seen date is on or before this datetime. Format: ISO 8601 (e.g. 2026-12-31T23:59:59Z)

offset integer | null

Possible values: >= 0

Can be used for paginating results

Default value: 0
limit integer | null

Possible values: >= 0 and <= 250

A number between 1 and 250 to determine the number of results to return in a single query

Default value: 100

Response​

Successful response

    meta objectrequired
    offsetinteger

    The offset of the first result

    Possible values: >= 0

    Example: 0
    limitinteger

    The number of results to return

    Possible values: >= 0 and <= 250

    Example: 100
    orderBy object[]required
  • Array [
  • object
  • ]
  • hasMoreboolean | nullnullable

    Whether there are more results

    totalinteger

    The total number of results

    Possible values: >= 0

    Example: 1000
    results object | nullrequired
    idstringrequired

    The unique identifier for the integration

    created_atstringrequired

    The date the integration was created

    updated_atstringrequired

    The date the integration was last updated

    namestringrequired

    The name of the integration

    vendorstringrequired

    The property management system of record

    Show 17 enum values
    APPFOLIOBUILDIUMELISEAIENTRATAFUNNELKNOCKMRIPROPERTYWAREPROPERTYWARE_RESTREALPAGEREALPAGE_RPXRENTCAFERENTMANAGERRENTVINERESMANYARDIYARDI_REST
    activebooleanrequired

    The active state of the integration

    systemstringrequired

    The system the integration is associated with

    Show 2 enum values
    PRODUCTIONSANDBOX
    sync_frequencyinteger | nullnullabledeprecated

    Deprecated: See the job schedules endpoint for this information. The interval of the scheduled sync frequency. (e.g. "12" in the following: Sync every 12 HOURs)

    sync_cadencestring | nullnullabledeprecated

    Deprecated: See the job schedules endpoint for this information. The cadence of the scheduled sync frequency. (e.g. "HOUR" in the following: Sync every 12 HOURs)

    Show 6 enum values
    MINUTEHOURDAYWEEKMONTHSECOND
    max_job_concurrencyintegerrequired

    Maximum number of jobs that can be run at once for the integration

    max_request_frequencyintegerrequired

    Maximum number of jobs that can be run in the max request cadence

    max_request_cadencestringrequired

    Cadence at which to limit the max request frequency

    Show 6 enum values
    MINUTEHOURDAYWEEKMONTHSECOND
    base_urlstring | nullnullablerequireddeprecated

    DEPRECATED: see specific PMS credentials. Base URL for the integration vendor API

    is_archivedbooleanrequired

    Whether or not the integration is archived

    last_completed_syncstring | nullnullablerequired

    The timestamp of the last time a sync was completed.

    last_completed_back_syncstring | nullnullablerequired

    The timestamp of the last time a back sync was completed.

    new_properties_are_enabledbooleanrequired

    Whether or not properties need to be approved before ingesting data for them.

    integration_interfaces object[]required
  • Array [
  • interface_namestringrequired
    Show 295 enum values
    REALPAGE_CREATE_LEADREALPAGE_CREATE_LEAD_EVENTREALPAGE_CREATE_RESIDENT_ACTIVITY_LOGREALPAGE_CREATE_SERVICE_REQUESTREALPAGE_UPDATE_APPLICANTREALPAGE_UPDATE_LEADREALPAGE_UPDATE_RESIDENTREALPAGE_UPDATE_SERVICE_REQUESTREALPAGE_PROSPECT_MANAGEMENT_ALL_LEADSREALPAGE_RESIDENTS_APPLICANT_GENERAL_INFOREALPAGE_PRICING_AND_AVAILABILITY_FLOOR_PLANSREALPAGE_PRICING_AND_AVAILABILITY_FLOOR_PLANS_PANDAREALPAGE_PRICING_AND_AVAILABILITY_UNITS_PANDAREALPAGE_PRICING_AND_AVAILABILITY_PICK_LISTS_PANDAREALPAGE_PROSPECT_MANAGEMENT_LEADREALPAGE_PROSPECT_MANAGEMENT_LEAD_SOURCESREALPAGE_PROSPECT_MANAGEMENT_PROPERTIESREALPAGE_RESIDENTS_RESIDENT_ACTIVITY_LOGSREALPAGE_RESIDENTS_RESIDENT_ACTIVITY_TYPESREALPAGE_RESIDENTS_RESIDENT_GENERAL_INFOREALPAGE_RESIDENTS_RESIDENT_LEASEREALPAGE_RESIDENTS_RESIDENT_LEDGERREALPAGE_RESIDENTS_RESIDENT_LISTREALPAGE_FACILITIES_SERVICE_REQUESTSREALPAGE_PROSPECT_MANAGEMENT_UNITSREALPAGE_UNIT_UNIT_DETAILSREALPAGE_PRICING_AND_AVAILABILITY_RENT_MATRIXREALPAGE_SDE_CONVERGENT_BILLINGREALPAGE_FACILITIESREALPAGE_PRICING_AND_AVAILABILITYREALPAGE_PROSPECT_MANAGEMENTREALPAGE_RESIDENTSREALPAGE_UNITREALPAGE_RPX_AMENITIESREALPAGE_RPX_APPOINTMENTSREALPAGE_RPX_APPOINTMENT_AVAILABILITYREALPAGE_RPX_CONCESSIONSREALPAGE_RPX_CONVERGENT_BILLING_LEASESREALPAGE_RPX_CONVERGENT_BILLING_RESIDENTSREALPAGE_RPX_CONVERGENT_BILLING_UNITSREALPAGE_RPX_CREATE_APPOINTMENTREALPAGE_RPX_CREATE_LEADREALPAGE_RPX_CREATE_LEAD_EVENTREALPAGE_RPX_CREATE_RESIDENT_ACTIVITY_LOGREALPAGE_RPX_CREATE_RESIDENT_CHARGEREALPAGE_RPX_CREATE_SERVICE_REQUESTREALPAGE_RPX_UPDATE_APPOINTMENTREALPAGE_RPX_UPDATE_APPOINTMENT_CANCELREALPAGE_RPX_UPDATE_LEADREALPAGE_RPX_UPDATE_SERVICE_REQUESTREALPAGE_RPX_FLOOR_PLANSREALPAGE_RPX_LEADSREALPAGE_RPX_LEAD_ACTIVITY_TYPESREALPAGE_RPX_LEAD_RELATIONSHIPSREALPAGE_RPX_LEAD_SOURCESREALPAGE_RPX_LISTINGSREALPAGE_RPX_LEASING_AGENTSREALPAGE_RPX_PET_TYPESREALPAGE_RPX_PROSPECTS_SURVEYREALPAGE_RPX_RESIDENT_SURVEYREALPAGE_RPX_READ_PROPERTIESREALPAGE_RPX_READ_PROPERTY_DATAREALPAGE_RPX_RESIDENTSREALPAGE_RPX_RESIDENT_ACTIVITY_LOGSREALPAGE_RPX_RESIDENT_ACTIVITY_TYPESREALPAGE_RPX_RESIDENT_LEDGERREALPAGE_RPX_RESIDENT_TRANSACTION_CODESREALPAGE_RPX_SERVICE_REQUESTSREALPAGE_RPX_SERVICE_REQUEST_ISSUESREALPAGE_RPX_SERVICE_REQUEST_LOCATIONSREALPAGE_RPX_SERVICE_REQUEST_PRIORITIESREALPAGE_RPX_SERVICE_REQUESTS_SURVEYREALPAGE_RPX_UNITSREALPAGE_RPX_UNITS_BY_PROPERTYREALPAGE_RPX_UPDATE_SITE_SUBSCRIPTIONREALPAGE_RPX_ACTIVITY_RESULT_CODESREALPAGE_RPX_CONVERGENT_BILLINGREALPAGE_RPX_FACILITIESREALPAGE_RPX_PRICING_AND_AVAILABILITYREALPAGE_RPX_PROSPECT_MANAGEMENTREALPAGE_RPX_RESIDENT_MANAGEMENTREALPAGE_RPX_RESIDENT_TRANSACTIONSREALPAGE_RPX_CONVERGENT_BILLING_RESIDENT_LEDGERREALPAGE_RPX_CONVERGENT_BILLING_TRANSACTION_CODESREALPAGE_RPX_RESIDENT_MANAGEMENT_EVENTSENTRATA_AMENITIESENTRATA_AR_CODESENTRATA_CALL_LOGSENTRATA_CONCESSIONSENTRATA_CREATE_AMENITYENTRATA_CREATE_APPLICANTENTRATA_CREATE_APPLICANT_PETSENTRATA_CREATE_APPLICANT_VEHICLESENTRATA_CREATE_APPLICANT_EMPLOYERSENTRATA_CREATE_APPLICANT_ADDONSENTRATA_CREATE_EVENTENTRATA_CREATE_INVOICEENTRATA_CREATE_LEADENTRATA_CREATE_LEASEENTRATA_CREATE_LEASE_DOCUMENTSENTRATA_CREATE_LEASE_TRANSACTIONENTRATA_CREATE_LISTINGENTRATA_CREATE_PURCHASE_ORDERENTRATA_CREATE_RECURRING_CHARGEENTRATA_CREATE_RESIDENT_CHARGEENTRATA_CREATE_SERVICE_REQUESTENTRATA_CREATE_SERVICE_REQUEST_FILEENTRATA_CREATE_SERVICE_REQUEST_NOTEENTRATA_CREATE_UNITENTRATA_CREATE_VENDORENTRATA_FEESENTRATA_FLOOR_PLANSENTRATA_GL_ACCOUNTSENTRATA_INVOICESENTRATA_LEAD_EVENTSENTRATA_LEAD_PICK_LISTENTRATA_LEASE_DETAILSENTRATA_LEASE_PICK_LISTENTRATA_LEASE_TRANSACTIONSENTRATA_LEASESENTRATA_LISTINGSENTRATA_PROPERTIESENTRATA_PET_TYPESENTRATA_PRICING_PICK_LISTENTRATA_PROPERTY_PICK_LISTENTRATA_PROSPECTSENTRATA_PURCHASE_ORDERSENTRATA_RENTABLE_ITEMSENTRATA_RESIDENT_INSURANCEENTRATA_RESIDENT_TRANSACTION_ALLOCATIONSENTRATA_RESIDENTSENTRATA_UNIT_TYPESENTRATA_UNITSENTRATA_UPDATE_AMENITYENTRATA_UPDATE_APPLICANTENTRATA_UPDATE_LEADENTRATA_UPDATE_LEASEENTRATA_UPDATE_RESIDENTENTRATA_UPDATE_SERVICE_REQUESTENTRATA_VENDOR_LOCATIONSENTRATA_VENDOR_PICK_LISTENTRATA_VENDORSENTRATA_WORK_ORDER_PICK_LISTENTRATA_WORK_ORDERSENTRATA_BASEPROPERTYWARE_REST_CREATE_RESIDENTPROPERTYWARE_REST_CREATE_DOCUMENTPROPERTYWARE_REST_CREATE_RECURRING_CHARGESPROPERTYWARE_REST_CREATE_RESIDENT_CHARGEPROPERTYWARE_REST_CREATE_RESIDENT_CREDITPROPERTYWARE_REST_CREATE_RESIDENT_PAYMENTPROPERTYWARE_REST_CREATE_UNITPROPERTYWARE_REST_READ_FINANCIAL_ACCOUNTSPROPERTYWARE_REST_READ_GENERAL_LEDGERPROPERTYWARE_REST_READ_LEASE_ADJUSTMENTSPROPERTYWARE_REST_READ_LEASE_CHARGESPROPERTYWARE_REST_READ_LEASE_CREDIT_MEMOSPROPERTYWARE_REST_READ_LEASE_DISCOUNTSPROPERTYWARE_REST_READ_LEASE_JOURNAL_ENTRIESPROPERTYWARE_REST_READ_LEASE_PAYMENTSPROPERTYWARE_REST_READ_LEASE_REFUNDSPROPERTYWARE_REST_READ_LEASESPROPERTYWARE_REST_READ_PORTFOLIOSPROPERTYWARE_REST_READ_PROPERTIESPROPERTYWARE_REST_READ_PROSPECTSPROPERTYWARE_REST_READ_RECURRING_CHARGESPROPERTYWARE_REST_READ_RESIDENTSPROPERTYWARE_REST_READ_UNITSPROPERTYWARE_REST_READ_INVOICESPROPERTYWARE_REST_UPDATE_CONTACTSPROPERTYWARE_REST_UPDATE_DOCUMENTPROPERTYWARE_REST_UPDATE_LEASEPROPERTYWARE_REST_UPDATE_LEASE_CUSTOM_FIELDSPROPERTYWARE_REST_UPDATE_PROPERTY_CUSTOM_FIELDSPROPERTYWARE_REST_UPDATE_UNIT_CUSTOM_FIELDSRESMAN_BASERESMAN_CREATE_APPLICANTRESMAN_CREATE_FILE_UPLOADRESMAN_CREATE_INVOICERESMAN_CREATE_LEADRESMAN_CREATE_RESIDENT_CHARGERESMAN_CREATE_RESIDENT_PETRESMAN_CREATE_RESIDENT_PAYMENTRESMAN_CREATE_SERVICE_REQUESTRESMAN_READ_ACCOUNTSRESMAN_READ_EMPLOYEESRESMAN_READ_INVOICESRESMAN_READ_LEADSRESMAN_READ_LEAD_SOURCESRESMAN_READ_LEASESRESMAN_READ_LEASES_PARTNER_APIRESMAN_READ_LISTINGSRESMAN_READ_MOVE_OUTSRESMAN_READ_PROPERTIESRESMAN_READ_RESIDENTSRESMAN_READ_RESIDENTS_AND_APPLICANTSRESMAN_READ_RESIDENTS_DOBRESMAN_READ_RESIDENT_CHARGE_CODESRESMAN_READ_RESIDENT_TRANSACTIONSRESMAN_READ_RENTABLE_ITEMSRESMAN_READ_SERVICE_REQUESTSRESMAN_READ_SERVICE_REQUEST_CATEGORIESRESMAN_READ_UNITSRESMAN_READ_VENDORSRESMAN_UPDATE_APPLICANTRESMAN_UPDATE_LEADRESMAN_UPDATE_RESIDENT_PETRESMAN_UPDATE_SERVICE_REQUESTRESMAN_READ_DEPOSIT_SUMMARY_PARTNER_APIAPPFOLIO_CREATE_APPOINTMENTAPPFOLIO_CREATE_CHARGEAPPFOLIO_CREATE_LEADAPPFOLIO_READ_APPLICATIONSAPPFOLIO_READ_APPOINTMENTSAPPFOLIO_READ_EMPLOYEESAPPFOLIO_READ_FINANCIAL_ACCOUNTSAPPFOLIO_READ_INVOICESAPPFOLIO_READ_LEADSAPPFOLIO_READ_LISTINGSAPPFOLIO_READ_PROPERTIESAPPFOLIO_READ_RESIDENTSAPPFOLIO_READ_RECURRING_CHARGESAPPFOLIO_READ_SERVICE_REQUESTSAPPFOLIO_READ_TENANT_LEDGERSAPPFOLIO_READ_UNITSAPPFOLIO_READ_VENDORSAPPFOLIO_UPDATE_LEADAPPFOLIO_UPDATE_APPOINTMENTAPPFOLIO_BASEYARDI_GUESTCARDYARDI_RESIDENT_TRANSACTIONSYARDI_RESIDENT_DATAYARDI_SERVICESYARDI_JOB_COSTYARDI_VENDOR_INVOICINGYARDI_LEASE_RENEWALSYARDI_DEPOSIT_SUMMARIESYARDI_REST_COMMON_DATAYARDI_REST_SERVICE_REQUESTSYARDI_REST_RESIDENT_TRANSACTIONSYARDI_REST_VENDOR_INVOICINGYARDI_REST_JOB_COSTYARDI_REST_GUESTCARDBUILDIUM_BASEPROPERTYWARE_BASERENTMANAGER_BASERENTVINE_BASEMRI_BASEMRI_CREATE_EVENTMRI_CREATE_EVENT_TYPEMRI_CREATE_INVOICEMRI_CREATE_PROSPECTMRI_CREATE_RESIDENT_NOTEMRI_CREATE_SERVICE_REQUESTMRI_READ_ACCOUNTING_ENTITIESMRI_READ_ALL_RESIDENTSMRI_READ_AMENITIESMRI_READ_APPLICANT_EVENTSMRI_READ_APPLICANTSMRI_READ_CHARGE_CODESMRI_READ_EMPLOYEESMRI_READ_EVENT_TYPESMRI_READ_FINANCIAL_ACCOUNTSMRI_READ_INVOICESMRI_READ_LEAD_EVENTSMRI_READ_LEAD_SOURCESMRI_READ_LEADSMRI_READ_LEASESMRI_READ_LEASING_AGENTSMRI_READ_NOTE_CATEGORIESMRI_READ_OWNERSMRI_READ_PICK_LISTSMRI_READ_PROPERTIESMRI_READ_RECURRING_CHARGESMRI_READ_RESIDENT_EVENTSMRI_READ_RESIDENT_LEDGERMRI_READ_RESIDENT_PETSMRI_READ_RESIDENTSMRI_READ_SECURITY_DEPOSIT_LEDGERMRI_READ_SERVICE_REQUESTSMRI_READ_SODASMRI_READ_UNITSMRI_READ_VENDORSMRI_UPDATE_EVENTMRI_UPDATE_INVOICEMRI_UPDATE_INVOICE_AS_PAIDMRI_UPDATE_INVOICE_PAYMENTMRI_UPDATE_INVOICE_STATUSMRI_UPDATE_PROSPECTMRI_UPDATE_RESIDENTMRI_UPDATE_SERVICE_REQUESTELISEAI_BASEKNOCK_BASERENTCAFE_BASEFUNNEL_BASE
    enabledbooleanrequired
    versionstring | nullnullablerequired
  • ]
  • models objectrequired
    property name* object
    enabledbooleanrequired
    from_interfacesstring[]required
    Show 295 enum values
    REALPAGE_CREATE_LEADREALPAGE_CREATE_LEAD_EVENTREALPAGE_CREATE_RESIDENT_ACTIVITY_LOGREALPAGE_CREATE_SERVICE_REQUESTREALPAGE_UPDATE_APPLICANTREALPAGE_UPDATE_LEADREALPAGE_UPDATE_RESIDENTREALPAGE_UPDATE_SERVICE_REQUESTREALPAGE_PROSPECT_MANAGEMENT_ALL_LEADSREALPAGE_RESIDENTS_APPLICANT_GENERAL_INFOREALPAGE_PRICING_AND_AVAILABILITY_FLOOR_PLANSREALPAGE_PRICING_AND_AVAILABILITY_FLOOR_PLANS_PANDAREALPAGE_PRICING_AND_AVAILABILITY_UNITS_PANDAREALPAGE_PRICING_AND_AVAILABILITY_PICK_LISTS_PANDAREALPAGE_PROSPECT_MANAGEMENT_LEADREALPAGE_PROSPECT_MANAGEMENT_LEAD_SOURCESREALPAGE_PROSPECT_MANAGEMENT_PROPERTIESREALPAGE_RESIDENTS_RESIDENT_ACTIVITY_LOGSREALPAGE_RESIDENTS_RESIDENT_ACTIVITY_TYPESREALPAGE_RESIDENTS_RESIDENT_GENERAL_INFOREALPAGE_RESIDENTS_RESIDENT_LEASEREALPAGE_RESIDENTS_RESIDENT_LEDGERREALPAGE_RESIDENTS_RESIDENT_LISTREALPAGE_FACILITIES_SERVICE_REQUESTSREALPAGE_PROSPECT_MANAGEMENT_UNITSREALPAGE_UNIT_UNIT_DETAILSREALPAGE_PRICING_AND_AVAILABILITY_RENT_MATRIXREALPAGE_SDE_CONVERGENT_BILLINGREALPAGE_FACILITIESREALPAGE_PRICING_AND_AVAILABILITYREALPAGE_PROSPECT_MANAGEMENTREALPAGE_RESIDENTSREALPAGE_UNITREALPAGE_RPX_AMENITIESREALPAGE_RPX_APPOINTMENTSREALPAGE_RPX_APPOINTMENT_AVAILABILITYREALPAGE_RPX_CONCESSIONSREALPAGE_RPX_CONVERGENT_BILLING_LEASESREALPAGE_RPX_CONVERGENT_BILLING_RESIDENTSREALPAGE_RPX_CONVERGENT_BILLING_UNITSREALPAGE_RPX_CREATE_APPOINTMENTREALPAGE_RPX_CREATE_LEADREALPAGE_RPX_CREATE_LEAD_EVENTREALPAGE_RPX_CREATE_RESIDENT_ACTIVITY_LOGREALPAGE_RPX_CREATE_RESIDENT_CHARGEREALPAGE_RPX_CREATE_SERVICE_REQUESTREALPAGE_RPX_UPDATE_APPOINTMENTREALPAGE_RPX_UPDATE_APPOINTMENT_CANCELREALPAGE_RPX_UPDATE_LEADREALPAGE_RPX_UPDATE_SERVICE_REQUESTREALPAGE_RPX_FLOOR_PLANSREALPAGE_RPX_LEADSREALPAGE_RPX_LEAD_ACTIVITY_TYPESREALPAGE_RPX_LEAD_RELATIONSHIPSREALPAGE_RPX_LEAD_SOURCESREALPAGE_RPX_LISTINGSREALPAGE_RPX_LEASING_AGENTSREALPAGE_RPX_PET_TYPESREALPAGE_RPX_PROSPECTS_SURVEYREALPAGE_RPX_RESIDENT_SURVEYREALPAGE_RPX_READ_PROPERTIESREALPAGE_RPX_READ_PROPERTY_DATAREALPAGE_RPX_RESIDENTSREALPAGE_RPX_RESIDENT_ACTIVITY_LOGSREALPAGE_RPX_RESIDENT_ACTIVITY_TYPESREALPAGE_RPX_RESIDENT_LEDGERREALPAGE_RPX_RESIDENT_TRANSACTION_CODESREALPAGE_RPX_SERVICE_REQUESTSREALPAGE_RPX_SERVICE_REQUEST_ISSUESREALPAGE_RPX_SERVICE_REQUEST_LOCATIONSREALPAGE_RPX_SERVICE_REQUEST_PRIORITIESREALPAGE_RPX_SERVICE_REQUESTS_SURVEYREALPAGE_RPX_UNITSREALPAGE_RPX_UNITS_BY_PROPERTYREALPAGE_RPX_UPDATE_SITE_SUBSCRIPTIONREALPAGE_RPX_ACTIVITY_RESULT_CODESREALPAGE_RPX_CONVERGENT_BILLINGREALPAGE_RPX_FACILITIESREALPAGE_RPX_PRICING_AND_AVAILABILITYREALPAGE_RPX_PROSPECT_MANAGEMENTREALPAGE_RPX_RESIDENT_MANAGEMENTREALPAGE_RPX_RESIDENT_TRANSACTIONSREALPAGE_RPX_CONVERGENT_BILLING_RESIDENT_LEDGERREALPAGE_RPX_CONVERGENT_BILLING_TRANSACTION_CODESREALPAGE_RPX_RESIDENT_MANAGEMENT_EVENTSENTRATA_AMENITIESENTRATA_AR_CODESENTRATA_CALL_LOGSENTRATA_CONCESSIONSENTRATA_CREATE_AMENITYENTRATA_CREATE_APPLICANTENTRATA_CREATE_APPLICANT_PETSENTRATA_CREATE_APPLICANT_VEHICLESENTRATA_CREATE_APPLICANT_EMPLOYERSENTRATA_CREATE_APPLICANT_ADDONSENTRATA_CREATE_EVENTENTRATA_CREATE_INVOICEENTRATA_CREATE_LEADENTRATA_CREATE_LEASEENTRATA_CREATE_LEASE_DOCUMENTSENTRATA_CREATE_LEASE_TRANSACTIONENTRATA_CREATE_LISTINGENTRATA_CREATE_PURCHASE_ORDERENTRATA_CREATE_RECURRING_CHARGEENTRATA_CREATE_RESIDENT_CHARGEENTRATA_CREATE_SERVICE_REQUESTENTRATA_CREATE_SERVICE_REQUEST_FILEENTRATA_CREATE_SERVICE_REQUEST_NOTEENTRATA_CREATE_UNITENTRATA_CREATE_VENDORENTRATA_FEESENTRATA_FLOOR_PLANSENTRATA_GL_ACCOUNTSENTRATA_INVOICESENTRATA_LEAD_EVENTSENTRATA_LEAD_PICK_LISTENTRATA_LEASE_DETAILSENTRATA_LEASE_PICK_LISTENTRATA_LEASE_TRANSACTIONSENTRATA_LEASESENTRATA_LISTINGSENTRATA_PROPERTIESENTRATA_PET_TYPESENTRATA_PRICING_PICK_LISTENTRATA_PROPERTY_PICK_LISTENTRATA_PROSPECTSENTRATA_PURCHASE_ORDERSENTRATA_RENTABLE_ITEMSENTRATA_RESIDENT_INSURANCEENTRATA_RESIDENT_TRANSACTION_ALLOCATIONSENTRATA_RESIDENTSENTRATA_UNIT_TYPESENTRATA_UNITSENTRATA_UPDATE_AMENITYENTRATA_UPDATE_APPLICANTENTRATA_UPDATE_LEADENTRATA_UPDATE_LEASEENTRATA_UPDATE_RESIDENTENTRATA_UPDATE_SERVICE_REQUESTENTRATA_VENDOR_LOCATIONSENTRATA_VENDOR_PICK_LISTENTRATA_VENDORSENTRATA_WORK_ORDER_PICK_LISTENTRATA_WORK_ORDERSENTRATA_BASEPROPERTYWARE_REST_CREATE_RESIDENTPROPERTYWARE_REST_CREATE_DOCUMENTPROPERTYWARE_REST_CREATE_RECURRING_CHARGESPROPERTYWARE_REST_CREATE_RESIDENT_CHARGEPROPERTYWARE_REST_CREATE_RESIDENT_CREDITPROPERTYWARE_REST_CREATE_RESIDENT_PAYMENTPROPERTYWARE_REST_CREATE_UNITPROPERTYWARE_REST_READ_FINANCIAL_ACCOUNTSPROPERTYWARE_REST_READ_GENERAL_LEDGERPROPERTYWARE_REST_READ_LEASE_ADJUSTMENTSPROPERTYWARE_REST_READ_LEASE_CHARGESPROPERTYWARE_REST_READ_LEASE_CREDIT_MEMOSPROPERTYWARE_REST_READ_LEASE_DISCOUNTSPROPERTYWARE_REST_READ_LEASE_JOURNAL_ENTRIESPROPERTYWARE_REST_READ_LEASE_PAYMENTSPROPERTYWARE_REST_READ_LEASE_REFUNDSPROPERTYWARE_REST_READ_LEASESPROPERTYWARE_REST_READ_PORTFOLIOSPROPERTYWARE_REST_READ_PROPERTIESPROPERTYWARE_REST_READ_PROSPECTSPROPERTYWARE_REST_READ_RECURRING_CHARGESPROPERTYWARE_REST_READ_RESIDENTSPROPERTYWARE_REST_READ_UNITSPROPERTYWARE_REST_READ_INVOICESPROPERTYWARE_REST_UPDATE_CONTACTSPROPERTYWARE_REST_UPDATE_DOCUMENTPROPERTYWARE_REST_UPDATE_LEASEPROPERTYWARE_REST_UPDATE_LEASE_CUSTOM_FIELDSPROPERTYWARE_REST_UPDATE_PROPERTY_CUSTOM_FIELDSPROPERTYWARE_REST_UPDATE_UNIT_CUSTOM_FIELDSRESMAN_BASERESMAN_CREATE_APPLICANTRESMAN_CREATE_FILE_UPLOADRESMAN_CREATE_INVOICERESMAN_CREATE_LEADRESMAN_CREATE_RESIDENT_CHARGERESMAN_CREATE_RESIDENT_PETRESMAN_CREATE_RESIDENT_PAYMENTRESMAN_CREATE_SERVICE_REQUESTRESMAN_READ_ACCOUNTSRESMAN_READ_EMPLOYEESRESMAN_READ_INVOICESRESMAN_READ_LEADSRESMAN_READ_LEAD_SOURCESRESMAN_READ_LEASESRESMAN_READ_LEASES_PARTNER_APIRESMAN_READ_LISTINGSRESMAN_READ_MOVE_OUTSRESMAN_READ_PROPERTIESRESMAN_READ_RESIDENTSRESMAN_READ_RESIDENTS_AND_APPLICANTSRESMAN_READ_RESIDENTS_DOBRESMAN_READ_RESIDENT_CHARGE_CODESRESMAN_READ_RESIDENT_TRANSACTIONSRESMAN_READ_RENTABLE_ITEMSRESMAN_READ_SERVICE_REQUESTSRESMAN_READ_SERVICE_REQUEST_CATEGORIESRESMAN_READ_UNITSRESMAN_READ_VENDORSRESMAN_UPDATE_APPLICANTRESMAN_UPDATE_LEADRESMAN_UPDATE_RESIDENT_PETRESMAN_UPDATE_SERVICE_REQUESTRESMAN_READ_DEPOSIT_SUMMARY_PARTNER_APIAPPFOLIO_CREATE_APPOINTMENTAPPFOLIO_CREATE_CHARGEAPPFOLIO_CREATE_LEADAPPFOLIO_READ_APPLICATIONSAPPFOLIO_READ_APPOINTMENTSAPPFOLIO_READ_EMPLOYEESAPPFOLIO_READ_FINANCIAL_ACCOUNTSAPPFOLIO_READ_INVOICESAPPFOLIO_READ_LEADSAPPFOLIO_READ_LISTINGSAPPFOLIO_READ_PROPERTIESAPPFOLIO_READ_RESIDENTSAPPFOLIO_READ_RECURRING_CHARGESAPPFOLIO_READ_SERVICE_REQUESTSAPPFOLIO_READ_TENANT_LEDGERSAPPFOLIO_READ_UNITSAPPFOLIO_READ_VENDORSAPPFOLIO_UPDATE_LEADAPPFOLIO_UPDATE_APPOINTMENTAPPFOLIO_BASEYARDI_GUESTCARDYARDI_RESIDENT_TRANSACTIONSYARDI_RESIDENT_DATAYARDI_SERVICESYARDI_JOB_COSTYARDI_VENDOR_INVOICINGYARDI_LEASE_RENEWALSYARDI_DEPOSIT_SUMMARIESYARDI_REST_COMMON_DATAYARDI_REST_SERVICE_REQUESTSYARDI_REST_RESIDENT_TRANSACTIONSYARDI_REST_VENDOR_INVOICINGYARDI_REST_JOB_COSTYARDI_REST_GUESTCARDBUILDIUM_BASEPROPERTYWARE_BASERENTMANAGER_BASERENTVINE_BASEMRI_BASEMRI_CREATE_EVENTMRI_CREATE_EVENT_TYPEMRI_CREATE_INVOICEMRI_CREATE_PROSPECTMRI_CREATE_RESIDENT_NOTEMRI_CREATE_SERVICE_REQUESTMRI_READ_ACCOUNTING_ENTITIESMRI_READ_ALL_RESIDENTSMRI_READ_AMENITIESMRI_READ_APPLICANT_EVENTSMRI_READ_APPLICANTSMRI_READ_CHARGE_CODESMRI_READ_EMPLOYEESMRI_READ_EVENT_TYPESMRI_READ_FINANCIAL_ACCOUNTSMRI_READ_INVOICESMRI_READ_LEAD_EVENTSMRI_READ_LEAD_SOURCESMRI_READ_LEADSMRI_READ_LEASESMRI_READ_LEASING_AGENTSMRI_READ_NOTE_CATEGORIESMRI_READ_OWNERSMRI_READ_PICK_LISTSMRI_READ_PROPERTIESMRI_READ_RECURRING_CHARGESMRI_READ_RESIDENT_EVENTSMRI_READ_RESIDENT_LEDGERMRI_READ_RESIDENT_PETSMRI_READ_RESIDENTSMRI_READ_SECURITY_DEPOSIT_LEDGERMRI_READ_SERVICE_REQUESTSMRI_READ_SODASMRI_READ_UNITSMRI_READ_VENDORSMRI_UPDATE_EVENTMRI_UPDATE_INVOICEMRI_UPDATE_INVOICE_AS_PAIDMRI_UPDATE_INVOICE_PAYMENTMRI_UPDATE_INVOICE_STATUSMRI_UPDATE_PROSPECTMRI_UPDATE_RESIDENTMRI_UPDATE_SERVICE_REQUESTELISEAI_BASEKNOCK_BASERENTCAFE_BASEFUNNEL_BASE
    last_sync_started_atstring | nullnullablerequired

    The UTC timestamp of when the last sync for this model started.

    last_sync_ended_atstring | nullnullablerequired

    The UTC timestamp of when the last sync for this model ended.

    can_authenticatebooleanrequired

    True if the credentials and configuration for the integration allowed us to successfully authenticate with at least one PMS API endpoint, false otherwise

    last_data_access_checkstring | nullnullablerequired

    The UTC timestamp of the last time an authentication check was performed for an integration.

    allow_manual_syncsbooleandeprecated

    Deprecated: This is no longer configurable and will always be true

    Default value: true
    configuration_meta_data object[]required
  • Array [
  • last_seenstringrequired
    interface_namestring | nullnullablerequired
    configuration_data objectrequired
    object
    custom_data object | nullrequired
    object
  • ]
  • is_running_syncbooleanrequired

    Whether or not a data sync is currently in progress for the integration

    is_running_data_access_checkbooleanrequired

    Whether or not a data access check is currently in progress for the integration

Errors​

  • 400Bad Request
      error objectrequired
      codestringrequired
      Example: invalid_request
      messagestringrequired
      Example: invalid request
      details object
      property name*any
      Example: {"details":{"issues":[{"code":"unrecognized_keys","keys":["foo"],"path":[],"message":"Unrecognized key(s) in object: 'foo'"}],"name":"ZodError"}}
GET /v1/admin/integrations/:integration_id/
curl https://api.propexo.com/v1/admin/integrations/:integration_id/ \
-H "Authorization: Bearer <token>"
200 Successful response
{
"meta": {
"offset": 0,
"limit": 100,
"orderBy": [
{}
],
"hasMore": true,
"total": 1000
},
"results": "Unknown Type: object,null"
}