Street.co.uk

Street.co.uk Tenancies API

Tenancies endpoints for this API.

GitHub OpenAPI

Operations 2

GET /tenancies Get all Tenancies #
GET /tenancies/{tenancy_id} Get a single Tenancy #

Documentation

📖
Documentation
https://developers.street.co.uk/docs/street-open-api
📖
APIReference
https://developers.street.co.uk/docs/street-open-api/api-reference
📖
Documentation
https://street.co.uk/developers/api
📖
GettingStarted
https://developers.street.co.uk/docs/street-open-api
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/street-co/refs/heads/main/rate-limits/street-co-rate-limits.yml
📖
Documentation
https://developers.street.co.uk/docs/street-property-feed-api
📖
APIReference
https://developers.street.co.uk/docs/street-property-feed-api/api-reference
📖
GettingStarted
https://developers.street.co.uk/docs/street-property-feed-api
📖
Documentation
https://developers.street.co.uk/docs/spectre-api-docs
📖
APIReference
https://developers.street.co.uk/docs/spectre-api-docs/api-reference
📖
GettingStarted
https://developers.street.co.uk/docs/spectre-api-docs

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/street-co/refs/heads/main/openapi/street-co-tenancies-api-openapi.yml

Other Resources

🔗
Sandbox
https://demo.street.co.uk/open-api/v1
🔗
Support
https://api-support.street.co.uk/
🔗
ChangeLog
https://developers.street.co.uk/docs/street-open-api/updates/open-api-updates
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/street-co/refs/heads/main/asyncapi/street-co-webhooks.yml
🔗
Sandbox
https://demo.street.co.uk/api/property-feed/v1
🔗
ChangeLog
https://developers.street.co.uk/docs/street-property-feed-api/updates
🔗
Contact
mailto:apis@spectre.uk.com

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/street-co-tenancies-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

street-co-tenancies-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Street Open Tenancies API
  description: Build on top of the UKs most advanced Estate Agency software.
  version: '1.0'
  contact:
    name: Street API Development Team
    url: https://street.co.uk
    email: apis@street.co.uk
servers:
- url: https://street.co.uk/open-api/v1
  description: Production.
- url: https://demo.street.co.uk/open-api/v1
  description: Testing.
security:
- your-api-token: []
tags:
- name: Tenancies
  description: Tenancies endpoints for this API.
paths:
  /tenancies:
    get:
      summary: Get all Tenancies
      description: This endpoint retrieves multiple paginated tenancies along with `meta` and `pagination` information.
      tags:
      - Tenancies
      responses:
        '200':
          description: OK.
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Tenancy'
                  included:
                    type: array
                    items:
                      anyOf:
                      - $ref: '#/components/schemas/IncludedProperty'
                      - $ref: '#/components/schemas/IncludedOwner'
                      - $ref: '#/components/schemas/IncludedPerson'
                      - $ref: '#/components/schemas/IncludedCompany'
                      - $ref: '#/components/schemas/IncludedTenants'
                      - $ref: '#/components/schemas/IncludedNotes'
                      - $ref: '#/components/schemas/IncludedBranch'
                      - $ref: '#/components/schemas/IncludedInspections'
                      - $ref: '#/components/schemas/IncludedLettingsApplication'
                      - $ref: '#/components/schemas/IncludedGuarantor'
                      - $ref: '#/components/schemas/IncludedEpc'
                      - $ref: '#/components/schemas/IncludedDownloadableMedia'
                      - $ref: '#/components/schemas/IncludedSafetyCertificate'
                  links:
                    $ref: '#/components/schemas/Links'
                  meta:
                    allOf:
                    - $ref: '#/components/schemas/Pagination'
                  jsonapi:
                    $ref: '#/components/schemas/JsonApi'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '406':
          $ref: '#/components/responses/406'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
      operationId: get-tenancies
      parameters:
      - $ref: '#/components/parameters/filter_trashed'
      - $ref: '#/components/parameters/filter_created_from'
      - $ref: '#/components/parameters/filter_created_to'
      - $ref: '#/components/parameters/filter_updated_from'
      - $ref: '#/components/parameters/filter_updated_to'
      - schema:
          type: array
          uniqueItems: true
          minItems: 1
          items:
            type: string
            enum:
            - property
            - property.owner
            - property.branch
            - owner
            - owner.people
            - tenants
            - notes
            - inspections
            - lettingsApplication
            - guarantors
        in: query
        name: include
        description: Optional related entities to include in the results supplied as a comma separated list.
        style: form
        explode: false
      - $ref: '#/components/parameters/page_size'
      - $ref: '#/components/parameters/page_number'
  /tenancies/{tenancy_id}:
    parameters:
    - schema:
        type: string
        format: uuid
      name: tenancy_id
      in: path
      required: true
      description: The UUID of the Tenancy.
    get:
      summary: Get a single Tenancy
      description: This endpoint retrieves a single tenancy by its `UUID`.
      tags:
      - Tenancies
      responses:
        '200':
          description: OK.
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Tenancy'
                  included:
                    type: array
                    items:
                      anyOf:
                      - $ref: '#/components/schemas/IncludedProperty'
                      - $ref: '#/components/schemas/IncludedPerson'
                      - $ref: '#/components/schemas/IncludedGuarantor'
                      - $ref: '#/components/schemas/IncludedOwner'
                      - $ref: '#/components/schemas/IncludedCompany'
                      - $ref: '#/components/schemas/IncludedTenants'
                      - $ref: '#/components/schemas/IncludedNotes'
                      - $ref: '#/components/schemas/IncludedBranch'
                      - $ref: '#/components/schemas/IncludedInspections'
                      - $ref: '#/components/schemas/IncludedDownloadableMedia'
                      - $ref: '#/components/schemas/IncludedLettingsApplication'
                      - $ref: '#/components/schemas/IncludedEpc'
                      - $ref: '#/components/schemas/IncludedSafetyCertificate'
                  links:
                    $ref: '#/components/schemas/IncludedLinks'
                  meta:
                    type: object
                  jsonapi:
                    $ref: '#/components/schemas/JsonApi'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '406':
          $ref: '#/components/responses/406'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
      operationId: get-tenancies-tenancy_id
      parameters:
      - schema:
          type: array
          uniqueItems: true
          minItems: 1
          items:
            type: string
            enum:
            - property
            - property.owner
            - property.branch
            - owner
            - owner.people
            - tenants
            - guarantors
            - notes
            - inspections
            - epc
            - safetyCertificates
            - tenancyGuide
            - tenancyAgreement
            - landlordOfferLetter
            - tenantGuarantorReferenceForm
            - tenantGuarantorReferenceReport
            - tenantGuarantorIdDocument
            - generatedDocument
            - lettingsApplication
        in: query
        name: include
        description: Optional related entities to include in the results supplied as a comma separated list.
        style: form
        explode: false
components:
  parameters:
    page_size:
      name: page[size]
      description: Set the number of results per page.
      in: query
      required: false
      schema:
        type: number
        minimum: 1
        maximum: 250
        example: 25
    filter_created_from:
      name: filter[created_from]
      in: query
      required: false
      schema:
        type: string
        format: date-time
      description: Filter by results created after the provided date.
    filter_updated_from:
      name: filter[updated_from]
      in: query
      required: false
      schema:
        type: string
        format: date-time
      description: Filter by results updated after the provided date.
    page_number:
      name: page[number]
      description: Set the page number.
      in: query
      required: false
      schema:
        type: number
        minimum: 1
        example: 3
    filter_updated_to:
      name: filter[updated_to]
      in: query
      required: false
      schema:
        type: string
        format: date-time
      description: Filter by results updated before the provided date.
    filter_created_to:
      name: filter[created_to]
      in: query
      required: false
      schema:
        type: string
        format: date-time
      description: Filter by results created before the provided date.
    filter_trashed:
      name: filter[trashed]
      in: query
      required: false
      schema:
        type: string
        enum:
        - with
        - only
      description: Optionally return result WITH deleted results or return ONLY deleted results.
  schemas:
    CompanyAttributes:
      type: object
      title: Company Attributes
      properties:
        name:
          type: string
          example: Adams Builders
        address:
          oneOf:
          - $ref: '#/components/schemas/AddressSimple'
          - type: 'null'
        telephone_number:
          type: string
        email_address:
          type: string
        owner:
          oneOf:
          - $ref: '#/components/schemas/PersonSimple'
          - type: 'null'
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    SafetyCertificateAttributes:
      title: SafetyCertificateAttributes
      type: object
      properties:
        media:
          type: object
          properties:
            document:
              type: string
              format: uri
              example: https://street.co.uk/certificates/safetyCertificate.pdf
        certificate_type:
          type: string
          enum:
          - alarm_service
          - asbestos_check
          - automated_gates
          - boiler_service
          - building_compliance
          - building_insurance
          - carbon_monoxide
          - chimney_sweep
          - damp_proofing
          - eic
          - electric
          - fire_detection
          - fire_door_assesment
          - fire_equipment
          - gas
          - health
          - heat_recovery_system
          - hmo_license
          - homecare_plan
          - landlord_registration
          - lead_water_testing
          - legion
          - lighting_safety
          - oil_safety_check
          - pat
          - remcon_service
          - rent_guarantee_insurance
          - rent_smart_wales_registered
          - risk
          - saniflow_service_and_descaler
          - selective_license
          - smoke_alarm
          - smoke_ventilation_system_service_aov
          - sump_pump_service
          - tree_management
          - tv_license
          - velux_window_service
        type:
          type: string
          deprecated: true
          description: 'Deprecated: use certificate_type instead.'
          enum:
          - alarm_service
          - asbestos_check
          - automated_gates
          - boiler_service
          - building_compliance
          - building_insurance
          - carbon_monoxide
          - chimney_sweep
          - damp_proofing
          - eic
          - electric
          - fire_detection
          - fire_door_assesment
          - fire_equipment
          - gas
          - health
          - heat_recovery_system
          - hmo_license
          - homecare_plan
          - landlord_registration
          - lead_water_testing
          - legion
          - lighting_safety
          - oil_safety_check
          - pat
          - remcon_service
          - rent_guarantee_insurance
          - rent_smart_wales_registered
          - risk
          - saniflow_service_and_descaler
          - selective_license
          - smoke_alarm
          - smoke_ventilation_system_service_aov
          - sump_pump_service
          - tree_management
          - tv_license
          - velux_window_service
        notes:
          type:
          - string
          - 'null'
        valid_from:
          type:
          - string
          - 'null'
          format: date-time
        valid_to:
          type: string
          format: date-time
        reminder_at:
          type:
          - string
          - 'null'
          format: date-time
        renewed_at:
          type:
          - string
          - 'null'
          format: date-time
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    PersonSimple:
      title: Person (simple)
      type: object
      properties:
        full_name:
          type: string
        title:
          type: string
          example: Mrs
        first_name:
          type: string
          example: Jane
        last_name:
          type: string
          example: Doe
        address:
          oneOf:
          - $ref: '#/components/schemas/AddressSimple'
          - type: 'null'
        telephone_numbers:
          type: array
          items:
            $ref: '#/components/schemas/TelephoneNumberSimple'
        email_addresses:
          type: array
          items:
            $ref: '#/components/schemas/EmailAddressSimple'
        marketing_consent:
          type:
          - boolean
          - 'null'
        contact_preferences:
          type: object
          properties:
            email:
              type: boolean
            post:
              type: boolean
            text:
              type: boolean
            phone:
              type: boolean
    IncludedBranch:
      allOf:
      - $ref: '#/components/schemas/IncludedResource'
      - type: object
        properties:
          type:
            type: string
            enum:
            - branch
          attributes:
            $ref: '#/components/schemas/BranchAttributes'
      title: Branch (included)
    IncludedResource:
      title: Included Resource
      type: object
      examples: []
      required:
      - type
      - id
      properties:
        type:
          type: string
        id:
          type: string
          format: uuid
        attributes:
          type: object
        relationships:
          type:
          - object
          - 'null'
        meta:
          $ref: '#/components/schemas/Meta'
    EmailAddressSimple:
      title: Email Address (simple)
      description: An email address, can be related to a person and/or a company.
      type: object
      properties:
        value:
          type: string
          example: john@johndoe.com
          format: email
        notes:
          type:
          - string
          - 'null'
        primary:
          type: boolean
    LettingsApplicationAttributes:
      title: Lettings Application (included)
      type: object
      properties:
        application_status:
          example: pending
          enum:
          - successful
          - unsuccessful
          - in_progress
          - pending
          - cancelled
        desired_tenancy_length:
          type: integer
          example: 12
        desired_move_in_date:
          type: string
          format: date-time
        completed_at:
          type:
          - string
          - 'null'
          format: date-time
        agreed_move_in_date:
          type:
          - string
          - 'null'
          format: date-time
        price:
          type: integer
        price_frequency:
          type: string
          enum:
          - Per Week
          - Per 2 Weeks
          - Per 4 Weeks
          - Per Calendar Month
          - Per Quarter
          - Per 6 Months
          - Per Annum
    jsonApiErrorResponseBody:
      title: JSON:API Error Response Body
      description: Response body for JSON:API errors, containing an array of `errors` in place of the `data` property provided in JSON:API success responses. Used for non-400/500 error codes where only a single error is expected.
      type: object
      properties:
        meta:
          type: object
        source:
          type: object
          description: The primary source of the conflict for 409 responses.
          properties:
            pointer:
              type: string
              description: JSON Pointer to the conflicting request value.
            parameter:
              type: string
              description: URI parameter related to the conflict.
        errors:
          description: An array of error objects providing additional information about problems encountered while processing the request.
          type: array
          maxItems: 1
          items:
            $ref: '#/components/schemas/jsonApiError'
      required:
      - errors
    IncludedProperty:
      title: Property (included)
      allOf:
      - $ref: '#/components/schemas/IncludedResource'
      - type: object
        properties:
          type:
            type: string
            enum:
            - property
          attributes:
            $ref: '#/components/schemas/PropertyAttributes'
          relationships:
            type: object
            properties:
              branch:
                allOf:
                - $ref: '#/components/schemas/RelationshipSingular'
                - type: object
                  properties:
                    data:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - branch
    GuarantorAttributes:
      title: Guarantor (attributes)
      type: object
      properties:
        full_name:
          type: string
        title:
          type: string
          example: Mrs
        first_name:
          type: string
          example: Jane
        last_name:
          type: string
          example: Doe
        address:
          anyOf:
          - $ref: '#/components/schemas/AddressSimple'
          - type: 'null'
        telephone_numbers:
          type: array
          items:
            $ref: '#/components/schemas/TelephoneNumberSimple'
        email_addresses:
          type: array
          items:
            $ref: '#/components/schemas/EmailAddressSimple'
        marketing_consent:
          type:
          - boolean
          - 'null'
        contact_preferences:
          type: object
          properties:
            email:
              type: boolean
            post:
              type: boolean
            text:
              type: boolean
            phone:
              type: boolean
        deleted_at:
          type:
          - string
          - 'null'
          format: date-time
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    RelationshipSingular:
      title: Relationship Singular
      description: Inheritable schema for 1:1 relationships. Data may be null if the relationship is empty.
      type: object
      properties:
        data:
          oneOf:
          - type: object
            properties:
              type:
                type: string
              id:
                type: string
                format: uuid
                example: a827a3ae-4c74-4c32-8b42-42248d4010d3
            required:
            - type
            - id
          - type: 'null'
        links:
          type: object
          properties:
            self:
              $ref: '#/components/schemas/Link'
            related:
              $ref: '#/components/schemas/Link'
    Tenancy:
      title: Tenancy
      allOf:
      - $ref: '#/components/schemas/BaseModel'
      - type: object
        properties:
          type:
            type: string
            enum:
            - tenancy
          attributes:
            $ref: '#/components/schemas/TenancyAttributes'
          relationships:
            type: object
            properties:
              property:
                allOf:
                - $ref: '#/components/schemas/RelationshipSingular'
                - type: object
                  properties:
                    data:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - property
              owner:
                allOf:
                - $ref: '#/components/schemas/RelationshipSingular'
                - type: object
                  properties:
                    data:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - owner
              tenants:
                allOf:
                - $ref: '#/components/schemas/RelationshipPlural'
                - type: object
                  properties:
                    data:
                      type: array
                      items:
                        type: object
                        properties:
                          type:
                            type: string
                            enum:
                            - tenant
              notes:
                allOf:
                - $ref: '#/components/schemas/RelationshipPlural'
                - type: object
                  properties:
                    data:
                      type: array
                      items:
                        type: object
                        properties:
                          type:
                            type: string
                            enum:
                            - note
      examples: []
    IncludedGuarantor:
      allOf:
      - $ref: '#/components/schemas/IncludedResource'
      - type: object
        properties:
          type:
            type: string
            enum:
            - guarantor
          attributes:
            $ref: '#/components/schemas/GuarantorAttributes'
      title: Guarantor (included)
    IncludedSafetyCertificate:
      title: Safety Certificate (included)
      allOf:
      - $ref: '#/components/schemas/IncludedResource'
      - type: object
        properties:
          type:
            type: string
            enum:
            - safetyCertificate
          attributes:
            $ref: '#/components/schemas/SafetyCertificateAttributes'
    InspectionAttributes:
      title: Inspection (attributes)
      type: object
      properties:
        due_date:
          type: string
          format: date-time
        inspection_date:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
        status:
          type: string
          enum:
          - Booked
          - Incomplete
          - Cancelled
          - Completed
          - Overdue
          - Need to Book
          - Unconfirmed
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        deleted_at:
          type:
          - string
          - 'null'
          format: date-time
    IncludedLettingsApplication:
      title: Lettings Application (included)
      allOf:
      - $ref: '#/components/schemas/IncludedResource'
      - type: object
        properties:
          type:
            type: string
            enum:
            - lettings_application
          attributes:
            $ref: '#/components/schemas/LettingsApplicationAttributes'
      x-tags:
      - Lettings Applications
    Pagination:
      title: Pagination
      description: Pagination object - JSON:API Standard.
      type: object
      properties:
        pagination:
          type: object
          properties:
            total:
              type: integer
              example: 226
            count:
              type: integer
              example: 10
            per_page:
              type: integer
              example: 10
            current_page:
              type: integer
              example: 1
            total_pages:
              type: integer
              example: 23
      x-examples:
        example-1:
          pagination:
            total: 226
            count: 10
            per_page: 10
            current_page: 1
            total_pages: 23
      examples:
      - pagination:
          total: 226
          count: 10
          per_page: 10
          current_page: 1
          total_pages: 23
    TelephoneNumberSimple:
      title: Telephone Number (simple)
      description: An telephone number, can be related to a person and/or a company.
      type: object
      properties:
        value:
          type: string
          example: '+441632960911'
        notes:
          type:
          - string
          - 'null'
        primary:
          type: boolean
    IncludedTenants:
      title: Tenants (included)
      allOf:
      - $ref: '#/components/schemas/IncludedResource'
      - type: object
        properties:
          type:
            type: string
            enum:
            - tenant
          attributes:
            oneOf:
            - $ref: '#/components/schemas/TenantAttributes'
            - $ref: '#/components/schemas/CompanyTenantAttributes'
            discriminator:
              propertyName: tenant_type
      x-tags:
      - Tenants
    PersonAttributes:
      title: Person (attributes)
      type: object
      properties:
        full_name:
          type: string
        title:
          type:
          - string
          - 'null'
          example: Mrs
        first_name:
          type: string
          example: Jane
        last_name:
          type: string
          example: Doe
        address:
          oneOf:
          - $ref: '#/components/schemas/AddressSimple'
          - type: 'null'
        telephone_numbers:
          type: array
          items:
            $ref: '#/components/schemas/TelephoneNumberSimple'
        email_addresses:
          type: array
          items:
            $ref: '#/components/schemas/EmailAddressSimple'
        marketing_consent:
          type:
          - boolean
          - 'null'
        contact_preferences:
          type: object
          properties:
            email:
              type: boolean
            post:
              type: boolean
            text:
              type: boolean
            phone:
              type: boolean
        statuses:
          type: object
          minProperties: 3
          maxProperties: 3
          additionalProperties: false
          properties:
            vendor:
              type:
              - string
              - 'null'
              enum:
              - null
              - Current
              - Previous
            landlord:
              type:
              - string
              - 'null'
              enum:
              - null
              - Current
              - Previous
            tenant:
              type:
              - string
              - 'null'
              enum:
              - null
              - Current
              - Previous
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    Link:
      title: Link
      oneOf:
      - description: a string containing the link's URL
        type: string
        format: uri-reference
      - type: object
        required:
        - href
        properties:
          href:
            description: a string containing the link's URL
            type: string
            format: uri-reference
          meta:
            $ref: '#/components/schemas/Meta'
    CompanyTenantAttributes:
      type: object
      title: Company Attributes
      properties:
        tenant_type:
          type: string
          const: company
        name:
          type: string
          example: Adams Builders
        address:
          $ref: '#/components/schemas/AddressSimple'
        telephone_number:
          type: string
        email_address:
          type: string
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    IncludedInspections:
      title: Inspections (included)
      allOf:
      - $ref: '#/components/schemas/IncludedResource'
      - type: object
        properties:
          type:
            type: string
            enum:
            - inspection
          attributes:
            $ref: '#/components/schemas/InspectionAttributes'
      x-tags:
      - Inspections
    TenancyAttributes:
      title: Tenancy (attributes)
      type: object
      properties:
        active:
          type: boolean
        status:
          type: string
          enum:
          - active
          - cancelled
          - ended
          - ending
          - expiring
          - renewed
          - renewing
          - upcoming
        start_date:
          type: string
          format: date-time
        end_date:
          type:
          - string
          - 'null'
          format: date-time
          description: Null for periodic tenancies, which have no fixed end date.
        original_term_start_date:
          type: string
          format: date-time
        tenancy_type:
          anyOf:
          - type: string
            enum:
            - Assured Shorthold
            - Excluded
            - Assured
            - Non-assured
            - Regulated
            - Company Let
            - HMO
            - License
            - Assured Periodic Tenancy
          - type: 'null'
        tenancy_term_type:
          type: string
          enum:
          - Periodic
          - Fixed
        rent_amount:
          type: integer
          example: 495
        rent_frequency:
          type: string
          enum:
          - Per Week
          - Per 2 Weeks
          - Per 4 Weeks
          - Per Calendar Month
          - Per Quarter
          - Per 6 Months
          - Per Annum
        deposit_amount:
          type:
          - integer
          - 'null'
          example: 900
        service_level:
          type:
          - string
          - 'null'
          example: Fully Managed
        service_level_type:
          anyOf:
          - type: string
            enum:
            - Let Only
            - Rent Collection
            - Fully Managed
            - Other
          - type: 'null'
        management_fee:
          type:
          - string
          - 'null'
          example: 10%
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    IncludedDownloadableMedia:
      allOf:
      - $ref: '#/components/schemas/IncludedResource'
      - type: object
        properties:
          type:
            type: string
            enum:
            - downloadable_media
          attributes:
            $ref: '#/components/schemas/DownloadableMediaAttributes'
      examples: []
      title: Downloadable Media (included)
      x-tags:
      - Media
    BranchAttributes:
      type: object
      title: Branch (attributes)
      properties:
        address:
          $ref: '#/components/schemas/AddressSimple'
        name:
          type: string
        public_name:
          type:
          - string
          - 'null'
        email_address:
          type: string
          format: email
        telephone:
          type: string
        website:
          type:
          - string
          - 'null'
          format: uri
        about_branch_copy:
          type:
          - string
          - 'null'
        disclaimer:
          type:
          - string
          - 'null'
        matching_links_to_website:
          type:
          - boolean
          - 'null'
          readOnly: true
          description: If true, custom property matching links are enabled for the branch.
        matching_url_pattern:
          type:
          - string
          - 'null'
          readOnly: true
          description: 'Pattern for property match URLs on the agent website: https://www.yourwebsite.co.uk/property/{UUID}'
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    PropertyAttributes:
      type: object
      title: Property (attributes)
      properties:
        is_sales:
          type: boolean
        is_lettings:
          type: boolean
        company_owned:
          type: boolean
        is_commercial:
          type: boolean
        is_residential:
          type: boolean
        address:
          $ref: '#/components/schemas/AddressSimple'
        inline_address:
          type: string
        publi

# --- truncated at 32 KB (58 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/street-co/refs/heads/main/openapi/street-co-tenancies-api-openapi.yml