---
title: "Get the integration activation state"
method: GET
path: "/partners/integration"
tags: ["Partners"]
---

# Get the integration activation state

`GET /partners/integration`

## Request

- Base URL: `https://api.alto.zoopladev.co.uk`
- URL: `https://api.alto.zoopladev.co.uk/partners/integration`
- Auth: `appAuth` (a scheme the document does not define)

Get the current integration activation state for the authenticated partner and agency.

## Headers

- `AgencyRef` string, required

## Response `200`

Returns the integration activation state

- IntegrationStateResponse
  - `integrationId` string, uuid
  - `integrationName` string, nullable
  - `agencyName` string, nullable
  - `requestedBy` string, nullable
  - `agencyIntegrationData` unknown
  - `branches` IntegrationBranchResponse[], nullable
    - `branchRef` string, nullable
    - `branchId` integer
    - `branchName` string, nullable
    - `branchAddress` BranchAddressResponse
      - `subDwelling` string, nullable
      - `nameNumber` string, nullable
      - `street` string, nullable
      - `locality` string, nullable
      - `town` string, nullable
      - `county` string, nullable
      - `postCode` string, nullable
    - `overridesAgencyIntegrationData` boolean
    - `integrationData` unknown

## Other responses

- `401`: When access has not been granted
- `404`: When the integration is not enabled for the agency

---

[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)