Branches

Get Branch By Id

get/branches/{branchId}

Request

  • Base URL: https://api.alto.zoopladev.co.uk
  • URL: https://api.alto.zoopladev.co.uk/branches/{branchId}
  • Auth: appAuth (a scheme the document does not define)

Path parameters

branchIdstring required

The unique identifier for the branch.

Headers

AgencyRefstring required

A GUID required in the header of all API requests that grants access to an agent's data

Response

Returns the branch.

branchIdstring nullable

The ID of the branch.

createdAtstring date-time nullable

The date and time the branch was created.

modifiedAtstring date-time nullable

The date and time the branch was last modified.

namestring nullable

The name of the branch.

status'Unknown' | 'Active' | 'Inactive'
defaultMarket'Unspecified' | 'Sale' | 'Rent'

Changes

No recorded changes to this operation across all 1 revision of this API.