Apex27 CRM API

# generated: 2026-07-26
# method: derived
# source: https://www.npmjs.com/package/n8n-nodes-apex27crm (v1.0.4, dist/nodes/Apex27Crm/Apex27Crm.node.js)
openapi: 3.1.0
info:
  title: Apex27 CRM API
  version: 1.0.4
  summary: REST interface over the Apex27 estate agency CRM (UK sales, lettings and commercial).
  description: 'API Evangelist DERIVED description of the Apex27 CRM API.


    Apex27 publishes no OpenAPI, Swagger, Postman collection or reference documentation. The documentation
    URL declared inside Apex27''s own npm credential (https://docs.apex27.co.uk) returned HTTP 404 on
    2026-07-26. This document was derived mechanically from Apex27''s OWN published n8n community node
    — npm n8n-nodes-apex27crm@1.0.4, publisher "james_apex27" — which contains the complete request map
    (paths, HTTP methods, path parameters, query filters, auth header, both environment base URLs and
    the pagination bounds).


    It is NOT a provider-published contract. Response schemas are intentionally left open (`type: object`)
    because no response shape is published anywhere; only the 401 envelope is recorded verbatim from a
    live probe of https://api.apex27.co.uk. Authentication is an `x-api-key` request header issued to
    paying customers inside the CRM admin panel — there is no self-serve developer signup and no sandbox.'
  contact:
    name: Apex27
    url: https://apex27.co.uk/contact-apex27
  x-apievangelist-provenance:
    method: derived
    generated: '2026-07-26'
    provider_published: false
    source: https://www.npmjs.com/package/n8n-nodes-apex27crm (v1.0.4, dist/nodes/Apex27Crm/Apex27Crm.node.js)
    source_publisher: james_apex27 (Apex27)
    evidence:
    - kind: npm-package
      url: https://registry.npmjs.org/n8n-nodes-apex27crm
      note: v1.0.4 — dist/nodes/Apex27Crm/Apex27Crm.node.js holds every method+URL pair reproduced here.
    - kind: live-probe
      url: https://api.apex27.co.uk/
      status: 401
      note: Body {"success":false,"message":"Unauthorised.","errors":[]} — the 401 envelope recorded in
        components.schemas.Error.
    - kind: live-probe
      url: https://api.apex27.co.uk/branches
      status: 401
    - kind: live-probe
      url: https://api.apex27.co.uk/listings
      status: 401
    - kind: live-probe
      url: https://api.apex27.co.uk/webhooks
      status: 401
    - kind: live-probe
      url: https://api.apex27.co.uk/properties
      status: 404
      note: Confirms the 401s are real routes rather than a blanket auth wall.
    - kind: dead-link
      url: https://docs.apex27.co.uk
      status: 404
      note: documentationUrl declared inside Apex27CrmApi.credentials.js.
servers:
- url: https://api.apex27.co.uk
  description: Production
- url: https://dev-api.apex27.co.uk
  description: Development (key-gated, not an open sandbox)
security:
- ApiKeyAuth: []
tags:
- name: Contacts
  description: Applicants, vendors, landlords, tenants and buyers held in the CRM.
- name: Call Logs
  description: Telephone activity recorded against a contact.
- name: Notes
  description: Free-text notes attached to a contact or a listing.
- name: Contact Referrals
  description: Referrals raised against a contact (conveyancing, mortgage, survey).
- name: Contact Orders
  description: Orders placed against a contact.
- name: Listings
  description: Sales, lettings, land and commercial property records.
- name: Listing Media
  description: Images, EPCs, floorplans, brochures and videos on a listing.
- name: Listing Rooms
  description: Room-by-room detail on a listing.
- name: Listing Links
  description: Virtual tours, videos, EPC reports and brochure links on a listing.
- name: Offers
  description: Offers made against listings.
- name: Valuations
  description: Market appraisals and valuation appointments.
- name: Viewings
  description: Viewing appointments.
- name: Inspections
  description: Property inspections (lettings management).
- name: Listing Issues
  description: Maintenance issues raised against a listing.
- name: Listing Keys
  description: Key sets held for a listing, including check-out and check-in.
- name: Onboarding Checks
  description: Compliance and onboarding checklists on a listing.
- name: Leads
  description: Inbound leads and their pipeline status.
- name: Tasks
  description: Work items assigned to users.
- name: Webhooks
  description: Webhook subscription management.
- name: Branches
  description: Agency branches within the tenant.
- name: Users
  description: CRM users within the tenant.
- name: Tenancies
  description: Tenancy agreements and their lifecycle.
- name: Completions
  description: Sales completions and progression.
- name: Search Regions
  description: Named geographic search regions.
- name: Listing Searches
  description: Saved applicant listing searches used for matching and alerts.
- name: Documents
  description: Documents attached to listings or contacts.
- name: Notifications
  description: In-app notifications to users, branches, listings or contacts.
- name: Client Portal
  description: Client-portal authentication and sign-in links.
- name: Availability
  description: Appointment availability for valuations and viewings.
- name: Global Search
  description: Cross-entity search.
paths:
  /contacts:
    get:
      operationId: listContacts
      summary: Get many contacts
      description: Get many contacts. Derived from the request the Apex27-published n8n node issues for
        this resource and operation.
      tags:
      - Contacts
      parameters:
      - name: uuid
        in: query
        required: false
        schema:
          type: string
      - name: externalId
        in: query
        required: false
        schema:
          type: string
      - name: email
        in: query
        required: false
        schema:
          type: string
      - name: e164
        in: query
        required: false
        schema:
          type: string
      - name: minDtsUpdated
        in: query
        required: false
        schema:
          type: string
        description: Only contacts updated at or after this timestamp.
      - name: includeArchived
        in: query
        required: false
        schema:
          type: boolean
      - name: single
        in: query
        required: false
        schema:
          type: boolean
      - &id002
        name: page
        in: query
        required: false
        description: Page number (minimum 1).
        schema:
          type: integer
          minimum: 1
          default: 1
      - &id003
        name: pageSize
        in: query
        required: false
        description: Records per page (minimum 25, maximum 250).
        schema:
          type: integer
          minimum: 25
          maximum: 250
          default: 25
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
        '401':
          $ref: '#/components/responses/Unauthorised'
        '404':
          $ref: '#/components/responses/NotFound'
    post:
      operationId: createContact
      summary: Create a contact
      description: Create a contact. Derived from the request the Apex27-published n8n node issues for
        this resource and operation.
      tags:
      - Contacts
      requestBody:
        required: true
        description: Request body. The Apex27 CRM API accepts a JSON object; the vendor node passes the
          object through unmodified.
        content:
          application/json:
            schema:
              type: object
              additionalProperties: true
              required:
              - firstName
              - lastName
              properties:
                firstName: {}
                lastName: {}
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
        '401':
          $ref: '#/components/responses/Unauthorised'
        '404':
          $ref: '#/components/responses/NotFound'
  /contacts/{contactId}:
    get:
      operationId: getContact
      summary: Get a contact
      description: Get a contact. Derived from the request the Apex27-published n8n node issues for this
        resource and operation.
      tags:
      - Contacts
      parameters:
      - &id001
        name: contactId
        in: path
        required: true
        schema:
          type: integer
        description: Apex27 contact identifier.
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
        '401':
          $ref: '#/components/responses/Unauthorised'
        '404':
          $ref: '#/components/responses/NotFound'
    put:
      operationId: replaceContact
      summary: Replace a contact in full
      description: Replace a contact in full. Derived from the request the Apex27-published n8n node issues
        for this resource and operation.
      tags:
      - Contacts
      parameters:
      - *id001
      requestBody:
        required: true
        description: Request body. The Apex27 CRM API accepts a JSON object; the vendor node passes the
          object through unmodified.
        content:
          application/json:
            schema:
              type: object
              additionalProperties: true
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
        '401':
          $ref: '#/components/responses/Unauthorised'
        '404':
          $ref: '#/components/responses/NotFound'
    patch:
      operationId: patchContact
      summary: Partially update a contact
      description: Partially update a contact. Derived from the request the Apex27-published n8n node
        issues for this resource and operation.
      tags:
      - Contacts
      parameters:
      - *id001
      requestBody:
        required: true
        description: Request body. The Apex27 CRM API accepts a JSON object; the vendor node passes the
          object through unmodified.
        content:
          application/json:
            schema:
              type: object
              additionalProperties: true
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
        '401':
          $ref: '#/components/responses/Unauthorised'
        '404':
          $ref: '#/components/responses/NotFound'
    delete:
      operationId: deleteContact
      summary: Delete a contact
      description: Delete a contact. Derived from the request the Apex27-published n8n node issues for
        this resource and operation.
      tags:
      - Contacts
      parameters:
      - *id001
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
        '401':
          $ref: '#/components/responses/Unauthorised'
        '404':
          $ref: '#/components/responses/NotFound'
  /contacts/{contactId}/call-logs:
    get:
      operationId: listContactCallLogs
      summary: Get many call logs for a contact
      description: Get many call logs for a contact. Derived from the request the Apex27-published n8n
        node issues for this resource and operation.
      tags:
      - Call Logs
      parameters:
      - *id001
      - *id002
      - *id003
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
        '401':
          $ref: '#/components/responses/Unauthorised'
        '404':
          $ref: '#/components/responses/NotFound'
    post:
      operationId: createContactCallLog
      summary: Create a call log for a contact
      description: Create a call log for a contact. Derived from the request the Apex27-published n8n
        node issues for this resource and operation.
      tags:
      - Call Logs
      parameters:
      - *id001
      requestBody:
        required: true
        description: Request body. The Apex27 CRM API accepts a JSON object; the vendor node passes the
          object through unmodified.
        content:
          application/json:
            schema:
              type: object
              additionalProperties: true
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
        '401':
          $ref: '#/components/responses/Unauthorised'
        '404':
          $ref: '#/components/responses/NotFound'
  /call-logs:
    post:
      operationId: createCallLog
      summary: Create a call log by E.164 number or email
      description: Create a call log by E.164 number or email. Derived from the request the Apex27-published
        n8n node issues for this resource and operation.
      tags:
      - Call Logs
      requestBody:
        required: true
        description: Request body. The Apex27 CRM API accepts a JSON object; the vendor node passes the
          object through unmodified.
        content:
          application/json:
            schema:
              type: object
              additionalProperties: true
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
        '401':
          $ref: '#/components/responses/Unauthorised'
        '404':
          $ref: '#/components/responses/NotFound'
  /contacts/{contactId}/call-logs/{callLogId}:
    put:
      operationId: updateContactCallLog
      summary: Update a call log
      description: Update a call log. Derived from the request the Apex27-published n8n node issues for
        this resource and operation.
      tags:
      - Call Logs
      parameters:
      - *id001
      - name: callLogId
        in: path
        required: true
        schema:
          type: integer
      requestBody:
        required: true
        description: Request body. The Apex27 CRM API accepts a JSON object; the vendor node passes the
          object through unmodified.
        content:
          application/json:
            schema:
              type: object
              additionalProperties: true
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
        '401':
          $ref: '#/components/responses/Unauthorised'
        '404':
          $ref: '#/components/responses/NotFound'
    delete:
      operationId: deleteContactCallLog
      summary: Delete a call log
      description: Delete a call log. Derived from the request the Apex27-published n8n node issues for
        this resource and operation.
      tags:
      - Call Logs
      parameters:
      - *id001
      - name: callLogId
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
        '401':
          $ref: '#/components/responses/Unauthorised'
        '404':
          $ref: '#/components/responses/NotFound'
  /contacts/{contactId}/notes:
    get:
      operationId: listContactNotes
      summary: Get many notes for a contact
      description: Get many notes for a contact. Derived from the request the Apex27-published n8n node
        issues for this resource and operation.
      tags:
      - Notes
      parameters:
      - *id001
      - *id002
      - *id003
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
        '401':
          $ref: '#/components/responses/Unauthorised'
        '404':
          $ref: '#/components/responses/NotFound'
    post:
      operationId: createContactNote
      summary: Create a note on a contact
      description: Create a note on a contact. Derived from the request the Apex27-published n8n node
        issues for this resource and operation.
      tags:
      - Notes
      parameters:
      - *id001
      requestBody:
        required: true
        description: Request body. The Apex27 CRM API accepts a JSON object; the vendor node passes the
          object through unmodified.
        content:
          application/json:
            schema:
              type: object
              additionalProperties: true
              required:
              - content
              properties:
                content: {}
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
        '401':
          $ref: '#/components/responses/Unauthorised'
        '404':
          $ref: '#/components/responses/NotFound'
  /contacts/{contactId}/notes/{noteId}:
    get:
      operationId: getContactNote
      summary: Get a contact note
      description: Get a contact note. Derived from the request the Apex27-published n8n node issues for
        this resource and operation.
      tags:
      - Notes
      parameters:
      - *id001
      - name: noteId
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
        '401':
          $ref: '#/components/responses/Unauthorised'
        '404':
          $ref: '#/components/responses/NotFound'
    put:
      operationId: updateContactNote
      summary: Update a contact note
      description: Update a contact note. Derived from the request the Apex27-published n8n node issues
        for this resource and operation.
      tags:
      - Notes
      parameters:
      - *id001
      - name: noteId
        in: path
        required: true
        schema:
          type: integer
      requestBody:
        required: true
        description: Request body. The Apex27 CRM API accepts a JSON object; the vendor node passes the
          object through unmodified.
        content:
          application/json:
            schema:
              type: object
              additionalProperties: true
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
        '401':
          $ref: '#/components/responses/Unauthorised'
        '404':
          $ref: '#/components/responses/NotFound'
    delete:
      operationId: deleteContactNote
      summary: Delete a contact note
      description: Delete a contact note. Derived from the request the Apex27-published n8n node issues
        for this resource and operation.
      tags:
      - Notes
      parameters:
      - *id001
      - name: noteId
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
        '401':
          $ref: '#/components/responses/Unauthorised'
        '404':
          $ref: '#/components/responses/NotFound'
  /contacts/{contactId}/referrals:
    get:
      operationId: listContactReferrals
      summary: Get many referrals for a contact
      description: Get many referrals for a contact. Derived from the request the Apex27-published n8n
        node issues for this resource and operation.
      tags:
      - Contact Referrals
      parameters:
      - *id001
      - *id002
      - *id003
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
        '401':
          $ref: '#/components/responses/Unauthorised'
        '404':
          $ref: '#/components/responses/NotFound'
    post:
      operationId: createContactReferral
      summary: Create a referral for a contact
      description: Create a referral for a contact. Derived from the request the Apex27-published n8n
        node issues for this resource and operation.
      tags:
      - Contact Referrals
      parameters:
      - *id001
      requestBody:
        required: true
        description: Request body. The Apex27 CRM API accepts a JSON object; the vendor node passes the
          object through unmodified.
        content:
          application/json:
            schema:
              type: object
              additionalProperties: true
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
        '401':
          $ref: '#/components/responses/Unauthorised'
        '404':
          $ref: '#/components/responses/NotFound'
  /contacts/{contactId}/referrals/{contactReferralId}:
    put:
      operationId: updateContactReferral
      summary: Update a contact referral
      description: Update a contact referral. Derived from the request the Apex27-published n8n node issues
        for this resource and operation.
      tags:
      - Contact Referrals
      parameters:
      - *id001
      - name: contactReferralId
        in: path
        required: true
        schema:
          type: integer
      requestBody:
        required: true
        description: Request body. The Apex27 CRM API accepts a JSON object; the vendor node passes the
          object through unmodified.
        content:
          application/json:
            schema:
              type: object
              additionalProperties: true
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
        '401':
          $ref: '#/components/responses/Unauthorised'
        '404':
          $ref: '#/components/responses/NotFound'
    delete:
      operationId: deleteContactReferral
      summary: Delete a contact referral
      description: Delete a contact referral. Derived from the request the Apex27-published n8n node issues
        for this resource and operation.
      tags:
      - Contact Referrals
      parameters:
      - *id001
      - name: contactReferralId
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
        '401':
          $ref: '#/components/responses/Unauthorised'
        '404':
          $ref: '#/components/responses/NotFound'
  /contact-orders:
    get:
      operationId: listContactOrders
      summary: Get many contact orders
      description: Get many contact orders. Derived from the request the Apex27-published n8n node issues
        for this resource and operation.
      tags:
      - Contact Orders
      parameters:
      - name: reference
        in: query
        required: false
        schema:
          type: string
      - *id002
      - *id003
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
        '401':
          $ref: '#/components/responses/Unauthorised'
        '404':
          $ref: '#/components/responses/NotFound'
  /contact-orders/{orderId}:
    get:
      operationId: getContactOrder
      summary: Get a contact order
      description: Get a contact order. Derived from the request the Apex27-published n8n node issues
        for this resource and operation.
      tags:
      - Contact Orders
      parameters:
      - name: orderId
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
        '401':
          $ref: '#/components/responses/Unauthorised'
        '404':
          $ref: '#/components/responses/NotFound'
    put:
      operationId: updateContactOrder
      summary: Update a contact order
      description: Update a contact order. Derived from the request the Apex27-published n8n node issues
        for this resource and operation.
      tags:
      - Contact Orders
      parameters:
      - name: orderId
        in: path
        required: true
        schema:
          type: integer
      requestBody:
        required: true
        description: Request body. The Apex27 CRM API accepts a JSON object; the vendor node passes the
          object through unmodified.
        content:
          application/json:
            schema:
              type: object
              additionalProperties: true
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
        '401':
          $ref: '#/components/responses/Unauthorised'
        '404':
          $ref: '#/components/responses/NotFound'
    delete:
      operationId: deleteContactOrder
      summary: Delete a contact order
      description: Delete a contact order. Derived from the request the Apex27-published n8n node issues
        for this resource and operation.
      tags:
      - Contact Orders
      parameters:
      - name: orderId
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
        '401':
          $ref: '#/components/responses/Unauthorised'
        '404':
          $ref: '#/components/responses/NotFound'
  /listings:
    get:
      operationId: listListings
      summary: Get many listings
      description: Get many listings. Derived from the request the Apex27-published n8n node issues for
        this resource and operation.
      tags:
      - Listings
      parameters:
      - name: branchId
        in: query
        required: false
        schema:
          type: integer
      - name: contactId
        in: query
        required: false
        schema:
          type: integer
      - name: email
        in: query
        required: false
        schema:
          type: string
      - name: uuid
        in: query
        required: false
        schema:
          type: string
      - name: externalId
        in: query
        required: false
        schema:
          type: string
      - name: transactionType
        in: query
        required: false
        schema:
          type: string
          enum: &id008
          - Sale
          - Rent
          - Land
          - Commercial Sale
          - Commercial Rent
      - name: minBeds
        in: query
        required: false
        schema:
          type: integer
      - name: minBaths
        in: query
        required: false
        schema:
          type: integer
      - name: minPrice
        in: query
        required: false
        schema:
          type: number
      - name: maxPrice
        in: query
        required: false
        schema:
          type: number
      - name: city
        in: query
        required: false
        schema:
          type: string
      - name: websiteStatus
        in: query
        required: false
        schema:
          type: string
      - name: mainSearchRegionId
        in: query
        required: false
        schema:
          type: integer
      - name: archived
        in: query
        required: false
        schema:
          type: boolean
      - name: activeTenancies
        in: query
        required: false
        schema:
          type: boolean
      - name: minDtsCreatedUpdated
        in: query
        required: false
        schema:
          type: string
      - name: minDtsUpdated
        in: query
        required: false
        schema:
          type: string
      - name: includeContacts
        in: query
        required: false
        schema:
          type: boolean
      - name: includeImages
        in: query
        required: false
        schema:
          type: boolean
      - name: includeOffers
        in: query
        required: false
        schema:
          type: boolean
      - name: includeValuations
        in: query
        required: false
        schema:
          type: boolean
      - name: includeRooms
        in: query
        required: false
        schema:
          type: boolean
      - *id002
      - *id003
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
        '401':
          $ref: '#/components/responses/Unauthorised'
        '404':
          $ref: '#/components/responses/NotFound'
    post:
      operationId: createListing
      summary: Create a listing
      description: Create a listing. Derived from the request the Apex27-published n8n node issues for
        this resource and operation.
      tags:
      - Listings
      requestBody:
        required: true
        description: Request body. The Apex27 CRM API accepts a JSON object; the vendor node passes the
          object through unmodified.
        content:
          application/json:
            schema:
              type: object
              additionalProperties: true
              required:
              - branchId
              - contactId
              properties:
                branchId: {}
                contactId: {}
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
        '401':
          $ref: '#/components/responses/Unauthorised'
        '404':
          $ref: '#/components/responses/NotFound'
  /listings/{listingId}:
    get:
      operationId: getListing
      summary: Get a listing
      description: Get a listing. Derived from the request the Apex27-published n8n node issues for this
        resource and operation.
      tags:
      - Listings
      parameters:
      - &id004
        name: listingId
        in: path
        required: true
        schema:
          type: integer
        description: Apex27 listing identifier.
      - name: includeContacts
        in: query
        required: false
        schema:
          type: boolean
      - name: includeImages
        in: query
        required: false
        schema:
          type: boolean
      - name: includeOffers
        in: query
        required: false
        schema:
          type: boolean
      - name: includeValuations
        in: query
        required: false
        schema:
          type: boolean
      - name: includeRooms
        in: query
        required: false
        schema:
          type: boolean
      responses:
 

# --- truncated at 32 KB (116 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/apex27/refs/heads/main/openapi/apex27-crm-api-openapi.yml