---
title: "Get the integration opt-out status"
method: GET
path: "/opt-out-status/{linkedType}/{linkedId}"
tags: ["Partners"]
---

# Get the integration opt-out status

`GET /opt-out-status/{linkedType}/{linkedId}`

## Request

- Base URL: `https://api.alto.zoopladev.co.uk`
- URL: `https://api.alto.zoopladev.co.uk/opt-out-status/{linkedType}/{linkedId}`
- Auth: `appAuth` (a scheme the document does not define)

Returns the opt-out status for a linked entity. The linked entity is identified by its type and id. Currently only Property entities are supported.

## Path parameters

- `linkedType` string, required
- `linkedId` integer, required

## Headers

- `AgencyRef` string, required

## Response `200`

Returns the opt-out status for the linked entity

- OptOutResponse
  - `linkedType` 'Unknown' | 'Group' | 'User' | 'Role' | 'Product' | 'Transaction' | 'SecurityRelationship' | 'OtherSecurityResource' | 'UserCode' | 'ProductRole' | 'Code' | 'CodeText' | 'Company' | 'Brand' | 'Branch' | 'BranchUser' | 'BranchBankAccount' | 'BranchBrand' | 'MatchArea' | 'BranchMatchArea' | 'CustomLocation' | 'RecurringEvent' | 'BatchList' | 'BatchListItem' | 'BatchTask' | 'BatchTaskSchedule' | 'BatchRun' | 'BatchCounter' | 'BatchError' | 'BatchRunTask' | 'GroupLock' | 'GroupLockHistory' | 'GroupReport' | 'ServiceRequestHistory' | 'SecuritySessionHistory' | 'ValueDomain' | 'Parameter' | 'ParameterList' | 'ParameterTable' | 'ValueDomainItem' | 'CodeList' | 'ParameterValue' | 'GroupCodeList' | 'ParameterListValue' | 'ParameterTableKey' | 'ParameterTableKeyValue' | 'ParameterTableValue' | 'ReportStructure' | 'ReportSection' | 'ReportColumn' | 'ReportFilter' | 'Applicant' | 'Property' | 'Contact' | 'PropertySale' | 'PropertyRental' | 'Room' | 'Media' | 'PostalAddress' | 'Phone' | 'EmailAddress' | 'GroupBankAccount' | 'GroupBankBranch' | 'Vendor' | 'Landlord' | 'Tenant' | 'Guarantor' | 'Supplier' | 'Tenancy' | 'ThirdParty' | 'ClientBankAccount' | 'DefaultFee' | 'FeeInstruction' | 'DiaryEvent' | 'DiaryEventParty' | 'Viewing' | 'PropertyValuation' | 'PropertyMatchArea' | 'PropertyFeature' | 'RoomMedia' | 'PropertyContact' | 'ContactRelationship' | 'Offer' | 'AgreedOffer' | 'Communication' | 'DiaryEventRecurringSchedule' | 'DiaryEventRecurringException' | 'HistoryEvent' | 'HistoryEventParty' | 'ComparableProperty' | 'PropertyBullet' | 'PropertyLease' | 'Requirement' | 'RequirementItem' | 'DiaryEventReminder' | 'AuditedChange' | 'CommunicationError' | 'DocumentTemplate' | 'FollowUp' | 'MediaFile' | 'PropertyInsurance' | 'PropertyUploadIndex' | 'SavedSearch' | 'UploadRequest' | 'KeySet' | 'ReportConfiguration' | 'ReportSchedule' | 'Report' | 'LetterRackItem' | 'Timeline' | 'FinancialTransaction' | 'CashBookItem' | 'Charge' | 'PurchaseInvoice' | 'PurchaseInvoiceItem' | 'SalesInvoice' | 'SalesInvoiceItem' | 'PropertyRelationship' | 'ReportConfigurationItem' | 'PendingDocument' | 'PendingDocumentParty' | 'MarketingEvent' | 'MarketingEventProperty' | 'Help' | 'ChainLink' | 'ChainLinkParty' | 'UnknownProperty' | 'UnknownContact' | 'Progression' | 'ManyToMany' | 'ManyToManyItem' | 'SMSRequest' | 'PropertyTemplate' | 'AdvertRun' | 'AdvertRunProperty' | 'BoardManagement' | 'StandardParagraph' | 'LocalCacheItemContainer' | 'ChainLinkSolicitor' | 'DefaultExpense' | 'MatchAreaGroup' | 'GroupData' | 'Lead' | 'PropertyWebStatistic' | 'ProductDocumentation' | 'WebStatisticsProvider' | 'PropertyMatchOn' | 'ExternalEmailAttachment' | 'Email' | 'SavedMatchList' | 'SavedMatchListRow' | 'ImportExternalKeyMapping' | 'EmailTemplate' | 'SelfBillingInvoice' | 'PropertyUtility' | 'PaymentGroup' | 'PaymentGroupProperty' | 'TaxExemptionPeriod' | 'LinkedAccount' | 'TenancyUtilityReading' | 'TenancyEvent' | 'TenancyDepositProtection' | 'TenancyMarketing' | 'WorkOrder' | 'WorkOrderEvent' | 'PaymentMethod' | 'ManagementDateAttribute' | 'DepositScheme' | 'BranchSequenceNumber' | 'FrequencyAttribute' | 'Accounts' | 'SupplierService' | 'ChargeToPost' | 'AccountTransaction' | 'BacsFileExtension' | 'BacsFileContent' | 'DestinationBankAccount' | 'TransactionHistory' | 'DefaultPMFee' | 'OpeningBalance' | 'HeldMoney' | 'Retention' | 'AuditItem' | 'OpeningBalanceHistory' | 'AccountingDocumentRequest' | 'EffectivePermission' | 'AccountingDocumentGenerationRun' | 'ChargeTemplate' | 'PropertyOwnership' | 'FollowUpEvent' | 'ReviewNotes' | 'PendingReportRequest' | 'SendGridEvent' | 'BookingRequest' | 'TdsCommunicationState' | 'SigningRequest' | 'ContactOwnedPropertiesCollection' | 'MaintenanceRequest' | 'AccountsExportProfile' | 'AccountsDataExport' | 'SecurityAttribute'
  - `linkedId` integer
  - `optOutStatus` 'OptedIn' | 'OptedOut'
  - `optedOutAt` string, date-time, nullable
  - `optedOutBy` integer, nullable

## Other responses

- `400`: When the request does not contain the expected information
- `401`: When access has not been granted
- `404`: The linked entity is not found

---

[API](https://skmtc.dev/alto/apis/alto-api.md) - [All operations](https://skmtc.dev/alto/apis/alto-api/llms.txt) - [OpenAPI document](https://skmtc.dev/alto/apis/alto-api/revisions/1b729d9b15a8?raw)