Street.co.uk

Street.co.uk Applicants API

Applicants endpoints for this API.

GitHub OpenAPI

Operations 4

GET /lettings-applicants Get all Lettings Applicants #
GET /lettings-applicants/{applicant_id} Get a single Lettings Applicant #
GET /sales-applicants Get all Sales Applicants #
GET /sales-applicants/{applicant_id} Get a single Sales Applicant #

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-applicants-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-applicants-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-applicants-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Street Open Applicants 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: Applicants
  description: Applicants endpoints for this API.
paths:
  /lettings-applicants:
    parameters: []
    get:
      summary: Get all Lettings Applicants
      tags:
      - Applicants
      responses:
        '200':
          description: Get one or more Lettings Applicants in a paginated result.
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Applicant'
                  included:
                    type: array
                    items:
                      anyOf:
                      - $ref: '#/components/schemas/IncludedBranch'
                      - $ref: '#/components/schemas/IncludedLettingsOffer'
                      - $ref: '#/components/schemas/IncludedViewing'
                      - $ref: '#/components/schemas/IncludedPerson'
                      - $ref: '#/components/schemas/IncludedCompany'
                      - $ref: '#/components/schemas/IncludedNegotiator'
                      - $ref: '#/components/schemas/IncludedNotes'
                      - $ref: '#/components/schemas/IncludedLettingsApplication'
                      - $ref: '#/components/schemas/IncludedFollowUp'
                  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'
        '406':
          $ref: '#/components/responses/406'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
      operationId: get-lettings-applicants
      description: This endpoint retrieves multiple paginated applicants along with `meta` and `pagination` information.
      parameters:
      - schema:
          type: string
          format: uuid
          example: a7c052ea-316a-4b55-8d47-9af7f782f887
        in: query
        name: filter[branch]
        description: Filter the Applicants by Branch.
      - schema:
          type: array
          items:
            type: string
          uniqueItems: true
          minItems: 1
        in: query
        name: filter[areas]
        description: Filter the Applicants by a comma-separated list of area names.
        style: form
        explode: false
      - $ref: '#/components/parameters/filter_applicant_price_from'
      - $ref: '#/components/parameters/filter_applicant_price_to'
      - $ref: '#/components/parameters/filter_applicant_min_bedrooms'
      - $ref: '#/components/parameters/filter_applicant_furnished'
      - $ref: '#/components/parameters/filter_created_from'
      - $ref: '#/components/parameters/filter_created_to'
      - $ref: '#/components/parameters/filter_updated_from'
      - $ref: '#/components/parameters/filter_updated_to'
      - $ref: '#/components/parameters/filter_trashed'
      - schema:
          type: array
          items:
            type: string
            enum:
            - branch
            - offers
            - viewings
            - people
            - company
            - notes
            - applications
            - followUps
            - negotiator
          uniqueItems: true
          minItems: 1
        in: query
        name: include
        description: Optional related entities to include in the results, e.g. `branch,offers,viewings,people,notes`
        style: form
        explode: false
      - $ref: '#/components/parameters/page_size'
      - $ref: '#/components/parameters/page_number'
      - schema:
          type: string
          format: date
        in: query
        name: filter[follow_ups_due_from]
        description: Filter results to applicants with a follow up after the provided ISO8601 date.
      - schema:
          type: string
          format: date
        in: query
        description: Filter results to applicants with a follow up before the provided ISO8601 date.
        name: filter[follow_ups_due_to]
      - schema:
          type: array
          items:
            type:
            - string
            - 'null'
            enum:
            - hot
            - warm
            - cold
            - null
          uniqueItems: true
        in: query
        name: filter[lead_rating]
        description: 'Filter applicants by their lead rating. Accepts: hot, warm, cold, or null. Can pass multiple values.'
        style: form
        explode: false
  /lettings-applicants/{applicant_id}:
    parameters:
    - schema:
        type: string
        format: uuid
      name: applicant_id
      in: path
      required: true
      description: The UUID of the Applicant.
    get:
      summary: Get a single Lettings Applicant
      tags:
      - Applicants
      responses:
        '200':
          description: Get Lettings Applicant by `UUID`.
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Applicant'
                  included:
                    type: array
                    items:
                      anyOf:
                      - $ref: '#/components/schemas/IncludedBranch'
                      - $ref: '#/components/schemas/IncludedLettingsOffer'
                      - $ref: '#/components/schemas/IncludedViewing'
                      - $ref: '#/components/schemas/IncludedPerson'
                      - $ref: '#/components/schemas/IncludedCompany'
                      - $ref: '#/components/schemas/IncludedNegotiator'
                      - $ref: '#/components/schemas/IncludedNotes'
                      - $ref: '#/components/schemas/IncludedLettingsApplication'
                      - $ref: '#/components/schemas/IncludedFollowUp'
                  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-lettings-applicants-applicantId
      description: This endpoint retrieves a single applicant by its `UUID`.
      parameters:
      - schema:
          type: array
          items:
            type: string
            enum:
            - branch
            - offers
            - viewings
            - people
            - company
            - notes
            - applications
            - followUp
            - negotiator
          uniqueItems: true
          minItems: 1
        in: query
        name: include
        description: Optional related entities to include in the results, e.g. `branch,offers,viewings,people,notes`
        style: form
        explode: false
  /sales-applicants:
    parameters: []
    get:
      summary: Get all Sales Applicants
      tags:
      - Applicants
      responses:
        '200':
          description: OK.
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Applicant'
                  included:
                    type: array
                    items:
                      anyOf:
                      - $ref: '#/components/schemas/IncludedBranch'
                      - $ref: '#/components/schemas/IncludedSalesOffer'
                      - $ref: '#/components/schemas/IncludedViewing'
                      - $ref: '#/components/schemas/IncludedPerson'
                      - $ref: '#/components/schemas/IncludedCompany'
                      - $ref: '#/components/schemas/IncludedNegotiator'
                      - $ref: '#/components/schemas/IncludedNotes'
                      - $ref: '#/components/schemas/IncludedFollowUp'
                      - $ref: '#/components/schemas/IncludedSale'
                  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'
        '406':
          $ref: '#/components/responses/406'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
      operationId: get-sales-applicants
      description: This endpoint retrieves multiple paginated applicants along with `meta` and `pagination` information.
      parameters:
      - schema:
          type: string
          format: uuid
        in: query
        name: filter[branch]
        description: Filter the Applicants by Branch.
      - schema:
          type: array
          items:
            type: string
          uniqueItems: true
          minItems: 1
        in: query
        name: filter[areas]
        description: Filter the Applicants by a comma-separated list of area names.
        style: form
        explode: false
      - $ref: '#/components/parameters/filter_applicant_price_from'
      - $ref: '#/components/parameters/filter_applicant_price_to'
      - $ref: '#/components/parameters/filter_applicant_min_bedrooms'
      - schema:
          type: array
          items:
            type: string
            enum:
            - FTB
            - INV
            - BTLI
            - NPTS
            - NOM
            - OTM
            - SSTC
            - UO
            - PTS
            - DEV
            - BUY
          uniqueItems: true
          minItems: 1
        in: query
        name: filter[buying_position]
        description: "Filter the Applicants by their buying position.\n\nAvailable values are:\n  - FTB (First-time buyer)\n  - INV (Investor)\n  - BTLI (Buy to let investor)\n  - NPTS (No property to sell)\n  - NOM (In process of selling - Valuation)\n  - OTM (In process of selling - On the market)\n  - SSTC (In process of selling - Sold STC)\n  - UO (In process of selling - Under Offer)\n  - PTS (Property to sell)\n  - DEV (Developer)\n  - BUY (Buying Agent)\n"
        style: form
      - schema:
          type: array
          items:
            type: string
            enum:
            - NIP
            - SOAQ
            - SAMA
            - AIP
            - NFCB
            - CBFS
            - PMTG
          uniqueItems: true
          minItems: 1
        in: query
        name: filter[financial_position]
        description: "Filter the Applicants by their financial position.\n\nAvailable values are:\n  - NIP (Nothing in place)\n  - SOAQ (Seeking own advice / quotes)\n  - SAMA (Currently seeing agent’s mortgage advisor)\n  - AIP (Agreement in Principle in place)\n  - NFCB (Does not need Finance (Cash Buyer))\n  - CBFS (Cash Buyer, proceeds from Sale)\n  - PMTG (Porting Mortgage)\n"
        style: form
      - $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
          items:
            type: string
            enum:
            - branch
            - offers
            - viewings
            - people
            - company
            - notes
            - sales
            - followUps
            - negotiator
          uniqueItems: true
          minItems: 1
        in: query
        name: include
        description: Optional related entities to include in the results, e.g. `branch,offers,viewings,people,notes,sales`
        style: form
        explode: false
      - $ref: '#/components/parameters/page_size'
      - $ref: '#/components/parameters/page_number'
      - schema:
          type: string
          format: date
        in: query
        name: filter[follow_ups_due_from]
        description: Filter results to applicants with a follow up after the provided ISO8601 date.
      - schema:
          type: string
          format: date
        in: query
        description: Filter results to applicants with a follow up before the provided ISO8601 date.
        name: filter[follow_ups_due_to]
      - schema:
          type: array
          items:
            type:
            - string
            - 'null'
            enum:
            - hot
            - warm
            - cold
            - null
          uniqueItems: true
        in: query
        name: filter[lead_rating]
        description: 'Filter applicants by their lead rating. Accepts: hot, warm, cold, or null. Can pass multiple values.'
        style: form
        explode: false
  /sales-applicants/{applicant_id}:
    parameters:
    - schema:
        type: string
        format: uuid
      name: applicant_id
      in: path
      required: true
      description: The UUID of the Applicant.
    get:
      summary: Get a single Sales Applicant
      tags:
      - Applicants
      responses:
        '200':
          description: OK.
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Applicant'
                  included:
                    type: array
                    items:
                      anyOf:
                      - $ref: '#/components/schemas/IncludedBranch'
                      - $ref: '#/components/schemas/IncludedSalesOffer'
                      - $ref: '#/components/schemas/IncludedViewing'
                      - $ref: '#/components/schemas/IncludedPerson'
                      - $ref: '#/components/schemas/IncludedCompany'
                      - $ref: '#/components/schemas/IncludedFollowUp'
                      - $ref: '#/components/schemas/IncludedNegotiator'
                      - $ref: '#/components/schemas/IncludedNotes'
                      - $ref: '#/components/schemas/IncludedSale'
                  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-sales-applicants-applicantId
      description: This endpoint retrieves a single applicant by its `UUID`.
      parameters:
      - schema:
          type: array
          items:
            type: string
            enum:
            - branch
            - offers
            - viewings
            - people
            - company
            - notes
            - sales
            - followUp
            - negotiator
          uniqueItems: true
          minItems: 1
        in: query
        name: include
        description: Optional related entities to include in the results, e.g. `branch,offers,viewings,people,notes,sales`
        style: form
        explode: false
components:
  schemas:
    IncludedSalesOffer:
      title: Sales Offer (included)
      allOf:
      - $ref: '#/components/schemas/IncludedResource'
      - type: object
        properties:
          type:
            type: string
            enum:
            - sales_offer
          attributes:
            $ref: '#/components/schemas/SalesOfferAttributes'
    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
    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
    UserAttributes:
      title: User (attributes)
      type: object
      properties:
        first_name:
          type: string
        last_name:
          type: string
        job_title:
          type:
          - string
          - 'null'
        telephone_number:
          type:
          - string
          - 'null'
        mobile_number:
          type:
          - string
          - 'null'
        email_address:
          type: string
          format: email
        deactivated_at:
          type:
          - string
          - 'null'
          format: date-time
        deleted_at:
          type:
          - string
          - 'null'
          format: date-time
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    IncludedLettingsOffer:
      title: Lettings Offer (included)
      allOf:
      - $ref: '#/components/schemas/IncludedResource'
      - type: object
        properties:
          type:
            type: string
            enum:
            - lettings_offer
          attributes:
            $ref: '#/components/schemas/LettingsOfferAttributes'
      x-tags:
      - Lettings Offers
    Applicant:
      allOf:
      - $ref: '#/components/schemas/BaseModel'
      - type: object
        properties:
          type:
            type: string
            enum:
            - applicant
          attributes:
            $ref: '#/components/schemas/ApplicantAttributes'
          relationships:
            type: object
            properties:
              branch:
                allOf:
                - $ref: '#/components/schemas/RelationshipSingular'
                - type: object
                  properties:
                    data:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - branch
              viewings:
                allOf:
                - $ref: '#/components/schemas/RelationshipPlural'
                - type: object
                  properties:
                    data:
                      type: array
                      items:
                        type: object
                        properties:
                          type:
                            type: string
                            enum:
                            - viewing
              offers:
                allOf:
                - $ref: '#/components/schemas/RelationshipPlural'
                - type: object
                  properties:
                    data:
                      type: array
                      items:
                        type: object
                        properties:
                          type:
                            type: string
                            enum:
                            - sales_offer
                            - lettings_offer
              people:
                allOf:
                - $ref: '#/components/schemas/RelationshipPlural'
                - type: object
                  properties:
                    data:
                      type: array
                      items:
                        type: object
                        properties:
                          type:
                            type: string
                            enum:
                            - person
              notes:
                allOf:
                - $ref: '#/components/schemas/RelationshipPlural'
                - type: object
                  properties:
                    data:
                      type: array
                      items:
                        type: object
                        properties:
                          type:
                            type: string
                            enum:
                            - note
              sales:
                allOf:
                - $ref: '#/components/schemas/RelationshipPlural'
                - type: object
                  properties:
                    data:
                      type: array
                      items:
                        type: object
                        properties:
                          type:
                            type: string
                            enum:
                            - sale
              followUps:
                allOf:
                - $ref: '#/components/schemas/RelationshipPlural'
                - type: object
                  properties:
                    data:
                      type: array
                      items:
                        type: object
                        properties:
                          type:
                            type: string
                            enum:
                            - follow_up
      examples: []
      title: Applicant
    SaleAttributes:
      title: Sale (attributes)
      type: object
      properties:
        address:
          $ref: '#/components/schemas/AddressSimple'
        status:
          type: string
          enum:
          - Completed
          - Fallen Through
          - Offer Accepted
          - Exchanged
          - Under Offer
        sale_price:
          type: number
        dates:
          type: object
          properties:
            expected_exchange_date:
              type:
              - string
              - 'null'
              format: date-time
            exchanged_date:
              type:
              - string
              - 'null'
              format: date-time
            expected_completion_date:
              type:
              - string
              - 'null'
              format: date-time
            completed_date:
              type:
              - string
              - 'null'
              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'
    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
    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
    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
    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
    ViewingAttributes:
      type: object
      title: Viewing (attributes)
      properties:
        viewing_type:
          type: string
          enum:
          - sales
          - lettings
        type:
          type: string
          deprecated: true
          description: 'Deprecated: use viewing_type instead.'
          enum:
          - sales
          - lettings
        address:
          $ref: '#/components/schemas/AddressSimple'
        start:
          type:
          - string
          - 'null'
          format: date-time
        end:
          type:
          - string
  

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