Street.co.uk
Street Open API

The main Street.co.uk platform API — a JSON:API-conformant REST interface over the estate agency system of record, covering properties, sales and lettings instructions, offers, applicants, viewings, valuations, tenancies, tenants, landlords, vendors, maintenance jobs and requests, inspections, invoices, documents, e-sign documents, notes, tasks, users, branches and brands, plus read access to portal listings. 74 paths and 80 operations documented in a published OpenAPI 3.1 contract.
Documentation GitHub OpenAPI
OpenAPI Specification

openapi: 3.1.0
info:
  title: Street Open 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.
paths:
  /activity:
    post:
      summary: Create a activity log
      operationId: post-activity
      responses:
        '201':
          description: Created.
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '406':
          $ref: '#/components/responses/406'
        '409':
          $ref: '#/components/responses/409'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
      description: This endpoint allows you to create a `Activity Log` record by providing core information
        such as the entity the `Activity Log` relates to and optionally the content/body of the `Activity
        Log`.
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              type: object
              required:
              - data
              properties:
                data:
                  type: object
                  required:
                  - type
                  - attributes
                  - relationships
                  properties:
                    type:
                      type: string
                      enum:
                      - activity
                    attributes:
                      type: object
                      required:
                      - activity_type
                      - title
                      - source
                      properties:
                        activity_type:
                          type: string
                          enum:
                          - campaign_sent
                        title:
                          type: string
                        description:
                          type: string
                        url:
                          type: string
                          format: uri
                        meta:
                          type:
                          - object
                          - 'null'
                        source:
                          type: string
                          enum:
                          - property_reports
                          - print
                          - social
                          - email_marketing
                        created_at:
                          type:
                          - string
                          - 'null'
                          format: date-time
                    relationships:
                      oneOf:
                      - $ref: '#/components/schemas/PropertyRelated'
                      - $ref: '#/components/schemas/PersonRelated'
      tags:
      - Activity
  /network-settings:
    parameters: []
  /lettings-applicants:
    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
    parameters: []
  /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:
    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
    parameters: []
  /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
  /areas:
    get:
      summary: Get all Areas
      tags:
      - Areas
      responses:
        '200':
          description: OK.
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Area'
                  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-areas
      description: This endpoint retrieves multiple paginated areas along with `meta` and `pagination`
        information.
      parameters:
      - $ref: '#/components/parameters/filter_trashed'
      - $ref: '#/components/parameters/page_size'
      - $ref: '#/components/parameters/page_number'
  /branches:
    get:
      summary: Get all Branches
      tags:
      - Branches
      responses:
        '200':
          description: OK.
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Branch'
                  included:
                    type: array
                    items:
                      anyOf:
                      - $ref: '#/components/schemas/IncludedUser'
                      - $ref: '#/components/schemas/IncludedProperty'
                      - $ref: '#/components/schemas/IncludedApplicant'
                  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-branches
      description: This endpoint retrieves multiple paginated branches along with `meta` and `pagination`
        information.
      parameters:
      - $ref: '#/components/parameters/filter_trashed'
      - schema:
          type: array
          uniqueItems: true
          minItems: 1
          items:
            type: string
            enum:
            - users
            - properties
            - applicants
        in: query
        name: include
        description: Optional related entities to include in the results.
        explode: false
        style: form
      - $ref: '#/components/parameters/page_size'
      - $ref: '#/components/parameters/page_number'
  /branches/{branch_id}:
    get:
      summary: Get a single Branch
      tags:
      - Branches
      responses:
        '200':
          description: OK.
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Branch'
                  included:
                    type: array
                    items:
                      anyOf:
                      - $ref: '#/components/schemas/IncludedUser'
                      - $ref: '#/components/schemas/IncludedProperty'
                      - $ref: '#/components/schemas/IncludedApplicant'
                  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-branch
      description: This endpoint retrieves a single branch by its `UUID`.
      parameters:
      - schema:
          type: array
          uniqueItems: true
          minItems: 1
          items:
            type: string
            enum:
            - users
            - properties
            - applicants
        in: query
        name: include
        description: Optional related entities to include in the results.
        explode: false
        style: form
      - schema:
          type: string
          format: uuid
        name: branch_id
        in: path
        required: true
        description: The UUID of the Branch.
  /brands:
    get:
      summary: Get all Brands
      tags:
      - Brands
      responses:
        '200':
          description: OK.
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Brand'
                  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-brands
      description: This endpoint retrieves multiple paginated brands along with `meta` and `pagination`
        information.
      parameters:
      - $ref: '#/components/parameters/filter_trashed'
      - $ref: '#/components/parameters/page_size'
      - $ref: '#/components/parameters/page_number'
  /brands/{brand_id}:
    get:
      summary: Get a single Brand
      tags:
      - Brands
      responses:
        '200':
          description: OK.
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Brand'
                  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-brand
      description: This endpoint retrieves a single brand by its `UUID`.
      parameters:
      - schema:
          type: string
          format: uuid
        name: brand_id
        in: path
        required: true
        description: The UUID of the Brand.
  /lettings-applications/{application_id}:
    parameters:
    - schema:
        type: string
        format: uuid
      name: application_id
      in: path
      required: true
      description: The UUID of the Application.
    get:
      summary: Get a single Lettings Application
      description: This endpoint retrieves a single lettings application by its `UUID`.
      tags:
      - Lettings Applications
      responses:
        '200':
          description: OK.
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/LettingsApplication'
                  included:
                    type: array
                    items:
                      anyOf:
                      - $ref: '#/components/schemas/IncludedProperty'
                      - $ref: '#/components/schemas/IncludedEpc'
                      - $ref: '#/components/schemas/IncludedSafetyCertificate'
                      - $ref: '#/components/schemas/IncludedDownloadableMedia'
                      - $ref: '#/components/schemas/IncludedTenancy'
                      - $ref: '#/components/schemas/IncludedApplicant'
                      - $ref: '#/components/schemas/IncludedPerson'
                      - $ref: '#/components/schemas/IncludedTenancyAgreement'
                      - $ref: '#/components/schemas/IncludedHoldingDeposit'
                      - $ref: '#/components/schemas/IncludedMeterReading'
                  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-applications-application_id
      parameters:
      - schema:
          type: array
          uniqueItems: true
          minItems: 1
          items:
            type: string
            enum:
            - property
            - tenancy
            - tenancyAgreement
            - holdingDeposit
            - applicant
            - applicant.people
            - epc
            - safetyCertificates
            - tenancyGuide
            - landlordOfferLetter
            - tenantGuarantorReferenceForm
            - tenantGuarantorReferenceReport
            - tenantGuarantorIdDocument
            - generatedDocument
            - meterReadings
        in: query
        name: include
        description: Optional related entities to include in the results supplied as a comma separated
          list.
        style: form
        explode: false
  /companies:
    get:
      summary: Get all Companies
      tags:
      - Companies
      responses:
        '200':
          description: OK.
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Company'
                  included:
                    type: array
                    items:
                      anyOf:
                      - $ref: '#/components/schemas/IncludedProperty'
                      - $ref: '#/components/schemas/IncludedApplicant'
                      - $ref: '#/components/schemas/IncludedNotes'
                      - $ref: '#/components/schemas/IncludedPerson'
                  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-companies
      description: This endpoint retrieves multiple paginated companies along with `meta` and `pagination`
        information.
      parameters:
      - $ref: '#/components/parameters/filter_trashed'
      - schema:
          type: array
          uniqueItems: true
 

# --- truncated at 32 KB (441 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/street-co/refs/heads/main/openapi/street-co-open-api-openapi.yml
Street Open API

Documentation

Specifications

Other Resources

OpenAPI Specification
