Hostfully

Hostfully Promo Codes API

The PromoCodes API from Hostfully — 2 operation(s) for promocodes.

GitHub OpenAPI

Operations 4

GET /api/v3.3/promo-codes Get all 15 #
POST /api/v3.3/promo-codes Post 12 #
GET /api/v3.3/promo-codes/{promoCodeUid} Get one 9 #
DELETE /api/v3.3/promo-codes/{promoCodeUid} Delete 11 #

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/hostfully/refs/heads/main/openapi/hostfully-promocodes-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/hostfully/refs/heads/main/json-schema/hostfully-amenity-adding-api3-dto-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/hostfully/refs/heads/main/json-schema/hostfully-fee-saving-api3-3-dto-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/hostfully/refs/heads/main/json-schema/hostfully-properties-creation-api3-dto-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/hostfully/refs/heads/main/json-schema/hostfully-properties-patch-api3-dto-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/hostfully/refs/heads/main/json-schema/hostfully-properties-saving-api3-dto-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/hostfully/refs/heads/main/json-schema/hostfully-unit-type-api3-1-update-request-dto-schema.json

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/hostfully:hostfully-promocodes-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 form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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

OpenAPI Specification

hostfully-promocodes-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Hostfully Promo Codes API
  license:
    name: Apache 2.0
    url: https://www.hostfully.com/
  version: v3.0.1
servers:
- url: https://sandbox-api.hostfully.com
security:
- JWT-Authentication: []
- Agency-API-key: []
tags:
- name: PromoCodes
paths:
  /api/v3.3/promo-codes:
    get:
      tags:
      - PromoCodes
      description: Fetches promo codes by provided filter
      operationId: getAll_15
      parameters:
      - name: propertiesUids
        in: query
        required: false
        schema:
          uniqueItems: true
          type: array
          items:
            type: string
          default: []
      - name: statuses
        in: query
        required: false
        schema:
          uniqueItems: true
          type: array
          items:
            type: string
            enum:
            - ACTIVE
            - EXPIRED
            - REDEEMED
            - DELETED
          default: []
      - name: from
        in: query
        required: false
        schema:
          type: string
          example: '2026-04-20T11:52:36'
        example: '2025-01-01T00:00:00'
      - name: to
        in: query
        required: false
        schema:
          type: string
          example: '2026-04-20T11:52:36'
        example: '2025-01-10T23:59:59'
      - name: sort
        in: query
        required: false
        schema:
          type: string
          enum:
          - SORT_BY_CODE
          - SORT_BY_STATUS
          - SORT_BY_TYPE
          - SORT_BY_VALUE
          - SORT_BY_CURRENCY
          - SORT_BY_SINGLE_USAGE
          - SORT_BY_VALID_FROM_DATE_TIME
          - SORT_BY_VALID_TO_DATE_TIME
          - SORT_BY_EXPIRATION_DATE_TIME
          - SORT_BY_CREATED_DATE
      - name: sortDirection
        in: query
        required: false
        schema:
          type: string
          enum:
          - ASC
          - DESC
      - name: _cursor
        in: query
        description: Cursor for pagination
        required: false
        schema:
          type: string
          description: Cursor for pagination
      - name: _limit
        in: query
        description: Limit for pagination
        required: false
        schema:
          type: string
          description: Limit for pagination
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PromoCodeResponseWrapper'
      summary: Get all 15
      x-summary-source: derived
    post:
      tags:
      - PromoCodes
      operationId: post_12
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PromoCodeApi3AddingDto'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PromoCodeApiResponseWrapper'
      summary: Post 12
      x-summary-source: derived
  /api/v3.3/promo-codes/{promoCodeUid}:
    get:
      tags:
      - PromoCodes
      operationId: getOne_9
      parameters:
      - name: promoCodeUid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PromoCodeApiResponseWrapper'
      summary: Get one 9
      x-summary-source: derived
    delete:
      tags:
      - PromoCodes
      operationId: delete_11
      parameters:
      - name: promoCodeUid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      summary: Delete 11
      x-summary-source: derived
components:
  schemas:
    PromoCodeApiResponseWrapper:
      type: object
      properties:
        promoCode:
          $ref: '#/components/schemas/PromoCodeApi3Dto'
    PromoCodeApi3Dto:
      type: object
      properties:
        uid:
          type: string
        code:
          type: string
        status:
          type: string
          enum:
          - ACTIVE
          - EXPIRED
          - REDEEMED
          - DELETED
        type:
          type: string
          enum:
          - AMOUNT
          - PERCENT
        value:
          type: number
        currency:
          type: string
          enum:
          - AED
          - ARS
          - AUD
          - BGN
          - BHD
          - BRL
          - CAD
          - CHF
          - CLP
          - CNY
          - COP
          - CZK
          - DKK
          - DOP
          - EUR
          - GBP
          - GTQ
          - HKD
          - HUF
          - IDR
          - IKR
          - ILS
          - INR
          - JPY
          - KES
          - KRW
          - MXN
          - MYR
          - NOK
          - NONE
          - NZD
          - PEN
          - PHP
          - PLN
          - RON
          - RUB
          - SEK
          - SGD
          - THB
          - TRY
          - TWD
          - USD
          - UYU
          - VEF
          - VND
          - VUV
          - JOD
          - SAR
          - EGP
          - ZAR
          - TTD
          - BBD
          - CVE
          - AWG
          - MAD
          - PYG
        singleUsage:
          type: boolean
        validFromZonedDateTime:
          type: string
          format: date-time
        validToZonedDateTime:
          type: string
          format: date-time
        expirationZonedDateTime:
          type: string
          format: date-time
        validFromUTCDateTime:
          type: string
          example: '2026-04-20T11:52:36'
        validToUTCDateTime:
          type: string
          example: '2026-04-20T11:52:36'
        expirationUTCDateTime:
          type: string
          example: '2026-04-20T11:52:36'
        propertyUid:
          type: string
        agencyUid:
          type: string
    PromoCodeResponseWrapper:
      type: object
      properties:
        promoCodes:
          type: array
          items:
            $ref: '#/components/schemas/PromoCodeApi3Dto'
        _metadata:
          $ref: '#/components/schemas/Api3ResponseMetadata'
        _paging:
          $ref: '#/components/schemas/Api3ResponsePaging'
    Api3ResponseMetadata:
      type: object
      properties:
        count:
          type: integer
          format: int32
        totalCount:
          type: integer
          format: int32
    Api3ResponsePaging:
      type: object
      properties:
        _limit:
          type: integer
          format: int32
        _nextCursor:
          type: string
    PromoCodeApi3AddingDto:
      required:
      - expirationDate
      - name
      - type
      - validFromDate
      - validToDate
      - value
      type: object
      properties:
        propertyUid:
          type: string
        singleUse:
          type: boolean
        currency:
          type: string
          enum:
          - AED
          - ARS
          - AUD
          - BGN
          - BHD
          - BRL
          - CAD
          - CHF
          - CLP
          - CNY
          - COP
          - CZK
          - DKK
          - DOP
          - EUR
          - GBP
          - GTQ
          - HKD
          - HUF
          - IDR
          - IKR
          - ILS
          - INR
          - JPY
          - KES
          - KRW
          - MXN
          - MYR
          - NOK
          - NONE
          - NZD
          - PEN
          - PHP
          - PLN
          - RON
          - RUB
          - SEK
          - SGD
          - THB
          - TRY
          - TWD
          - USD
          - UYU
          - VEF
          - VND
          - VUV
          - JOD
          - SAR
          - EGP
          - ZAR
          - TTD
          - BBD
          - CVE
          - AWG
          - MAD
          - PYG
        name:
          type: string
        type:
          type: string
          enum:
          - AMOUNT
          - PERCENT
        value:
          type: number
        validFromDate:
          type: string
          example: '2026-04-20T11:52:36'
        validToDate:
          type: string
          example: '2026-04-20T11:52:36'
        expirationDate:
          type: string
          example: '2026-04-20T11:52:36'
  securitySchemes:
    JWT-Authentication:
      type: apiKey
      description: OAuth Access Token
      name: Authorization
      in: header
    Agency-API-key:
      type: apiKey
      description: API Key
      name: X-HOSTFULLY-APIKEY
      in: header
externalDocs:
  description: Hostfully Documentation
  url: https://dev.hostfully.com/v3.0/reference
x-provenance:
  method: searched
  source: https://dev.hostfully.com/reference
  harvested: '2026-10-14'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://dev.hostfully.com/reference/acceptbookingrequest.md
  - https://dev.hostfully.com/reference/acceptjob.md
  - https://dev.hostfully.com/reference/calculatequote.md
  - https://dev.hostfully.com/reference/cancel.md
  - https://dev.hostfully.com/reference/cancelgroupbooking.md
  - https://dev.hostfully.com/reference/changedates.md
  - https://dev.hostfully.com/reference/close.md
  - https://dev.hostfully.com/reference/create.md
  - https://dev.hostfully.com/reference/create_1.md
  - https://dev.hostfully.com/reference/createfee.md
  - https://dev.hostfully.com/reference/creategroupbookinglead.md
  - https://dev.hostfully.com/reference/createlead.md
  - https://dev.hostfully.com/reference/createmessage.md
  - https://dev.hostfully.com/reference/createorderadjustment.md
  - https://dev.hostfully.com/reference/createowneradjustment.md
  - https://dev.hostfully.com/reference/createproperty.md
  - https://dev.hostfully.com/reference/createpropertyrule.md
  - https://dev.hostfully.com/reference/currentapiversion.md
  - https://dev.hostfully.com/reference/declinebookingrequest.md
  - https://dev.hostfully.com/reference/declinejob.md
  - https://dev.hostfully.com/reference/delete.md
  - https://dev.hostfully.com/reference/delete_1.md
  - https://dev.hostfully.com/reference/delete_10.md
  - https://dev.hostfully.com/reference/delete_11.md
  - https://dev.hostfully.com/reference/delete_12.md
  - https://dev.hostfully.com/reference/delete_13.md
  - https://dev.hostfully.com/reference/delete_14.md
  - https://dev.hostfully.com/reference/delete_15.md
  - https://dev.hostfully.com/reference/delete_2.md
  - https://dev.hostfully.com/reference/delete_3.md
  - https://dev.hostfully.com/reference/delete_4.md
  - https://dev.hostfully.com/reference/delete_5.md
  - https://dev.hostfully.com/reference/delete_6.md
  - https://dev.hostfully.com/reference/delete_7.md
  - https://dev.hostfully.com/reference/delete_8.md
  - https://dev.hostfully.com/reference/delete_9.md
  - https://dev.hostfully.com/reference/deleteall.md
  - https://dev.hostfully.com/reference/deletebyuid.md
  - https://dev.hostfully.com/reference/deletefee.md
  - https://dev.hostfully.com/reference/deleteorderadjustment.md
  - https://dev.hostfully.com/reference/deleteowneradjustmentbyuid.md
  - https://dev.hostfully.com/reference/deletepropertybyuid.md
  - https://dev.hostfully.com/reference/deletepropertybyuid_1.md
  - https://dev.hostfully.com/reference/deletepropertyrule.md
  - https://dev.hostfully.com/reference/execute.md
  - https://dev.hostfully.com/reference/extendhold.md
  - https://dev.hostfully.com/reference/fetchextraguestsbylead.md
  - https://dev.hostfully.com/reference/findall.md
  - https://dev.hostfully.com/reference/findall_1.md
  - https://dev.hostfully.com/reference/findall_2.md
  - https://dev.hostfully.com/reference/findall_3.md
  - https://dev.hostfully.com/reference/findall_4.md
  - https://dev.hostfully.com/reference/findall_5.md
  - https://dev.hostfully.com/reference/findall_6.md
  - https://dev.hostfully.com/reference/findall_7.md
  - https://dev.hostfully.com/reference/findall_8.md
  - https://dev.hostfully.com/reference/findallmessagesforagency.md
  - https://dev.hostfully.com/reference/findbyagencyuid.md
  - https://dev.hostfully.com/reference/findbyhoteluid.md
  - https://dev.hostfully.com/reference/findbypropertyuid.md
  - https://dev.hostfully.com/reference/findbypropertyuid_1.md
  - https://dev.hostfully.com/reference/findbypropertyuid_2.md
  - https://dev.hostfully.com/reference/findbypropertyuid_3.md
  - https://dev.hostfully.com/reference/findbypropertyuid_4.md
  - https://dev.hostfully.com/reference/findbyuid.md
  - https://dev.hostfully.com/reference/findbyuid_1.md
  - https://dev.hostfully.com/reference/findbyuid_2.md
  - https://dev.hostfully.com/reference/findbyuid_3.md
  - https://dev.hostfully.com/reference/findbyuid_4.md
  - https://dev.hostfully.com/reference/findbywebhookuid.md
  - https://dev.hostfully.com/reference/findgroupbookingleads.md
  - https://dev.hostfully.com/reference/findhotelsbyagencyuid.md
  - https://dev.hostfully.com/reference/findlead.md
  - https://dev.hostfully.com/reference/findleads.md
  - https://dev.hostfully.com/reference/findmessagesbyuid.md
  - https://dev.hostfully.com/reference/findthreadbyuid.md
  - https://dev.hostfully.com/reference/findthreads.md
  - https://dev.hostfully.com/reference/findunitbyuid.md
  - https://dev.hostfully.com/reference/findunitsbyunittype.md
  - https://dev.hostfully.com/reference/findupdatetaskstatusbyuid.md
  - https://dev.hostfully.com/reference/getagencies.md
  - https://dev.hostfully.com/reference/getagency.md
  - https://dev.hostfully.com/reference/getagencydbssettings.md
  - https://dev.hostfully.com/reference/getall.md
  - https://dev.hostfully.com/reference/getall_1.md
  - https://dev.hostfully.com/reference/getall_10.md
  - https://dev.hostfully.com/reference/getall_11.md
  - https://dev.hostfully.com/reference/getall_12.md
  - https://dev.hostfully.com/reference/getall_13.md
  - https://dev.hostfully.com/reference/getall_14.md
  - https://dev.hostfully.com/reference/getall_15.md
  - https://dev.hostfully.com/reference/getall_16.md
  - https://dev.hostfully.com/reference/getall_17.md
  - https://dev.hostfully.com/reference/getall_18.md
  - https://dev.hostfully.com/reference/getall_19.md
  - https://dev.hostfully.com/reference/getall_2.md
  - https://dev.hostfully.com/reference/getall_3.md
  - https://dev.hostfully.com/reference/getall_4.md
  - https://dev.hostfully.com/reference/getall_5.md
  - https://dev.hostfully.com/reference/getall_6.md
  - https://dev.hostfully.com/reference/getall_7.md
  - https://dev.hostfully.com/reference/getall_8.md
  - https://dev.hostfully.com/reference/getall_9.md
  - https://dev.hostfully.com/reference/getgroupbooking.md
  - https://dev.hostfully.com/reference/getone.md
  - https://dev.hostfully.com/reference/getone_1.md
  - https://dev.hostfully.com/reference/getone_10.md
  - https://dev.hostfully.com/reference/getone_11.md
  - https://dev.hostfully.com/reference/getone_2.md
  - https://dev.hostfully.com/reference/getone_3.md
  - https://dev.hostfully.com/reference/getone_4.md
  - https://dev.hostfully.com/reference/getone_5.md
  - https://dev.hostfully.com/reference/getone_6.md
  - https://dev.hostfully.com/reference/getone_7.md
  - https://dev.hostfully.com/reference/getone_8.md
  - https://dev.hostfully.com/reference/getone_9.md
  - https://dev.hostfully.com/reference/getorderadjustments.md
  - https://dev.hostfully.com/reference/getpropertydbssettings.md
  - https://dev.hostfully.com/reference/getstatistics.md
  - https://dev.hostfully.com/reference/ignore.md
  - https://dev.hostfully.com/reference/markasbooked.md
  - https://dev.hostfully.com/reference/markasdone.md
  - https://dev.hostfully.com/reference/markprearrivalformcompleted.md
  - https://dev.hostfully.com/reference/patch.md
  - https://dev.hostfully.com/reference/patch_1.md
  - https://dev.hostfully.com/reference/patch_2.md
  - https://dev.hostfully.com/reference/patch_3.md
  - https://dev.hostfully.com/reference/patchlead.md
  - https://dev.hostfully.com/reference/patchpropertyrule.md
  - https://dev.hostfully.com/reference/post.md
  - https://dev.hostfully.com/reference/post_1.md
  - https://dev.hostfully.com/reference/post_10.md
  - https://dev.hostfully.com/reference/post_11.md
  - https://dev.hostfully.com/reference/post_12.md
  - https://dev.hostfully.com/reference/post_13.md
  - https://dev.hostfully.com/reference/post_14.md
  - https://dev.hostfully.com/reference/post_15.md
  - https://dev.hostfully.com/reference/post_16.md
  - https://dev.hostfully.com/reference/post_2.md
  - https://dev.hostfully.com/reference/post_3.md
  - https://dev.hostfully.com/reference/post_4.md
  - https://dev.hostfully.com/reference/post_5.md
  - https://dev.hostfully.com/reference/post_6.md
  - https://dev.hostfully.com/reference/post_7.md
  - https://dev.hostfully.com/reference/post_8.md
  - https://dev.hostfully.com/reference/post_9.md
  - https://dev.hostfully.com/reference/put.md
  - https://dev.hostfully.com/reference/put_1.md
  - https://dev.hostfully.com/reference/put_10.md
  - https://dev.hostfully.com/reference/put_11.md
  - https://dev.hostfully.com/reference/put_2.md
  - https://dev.hostfully.com/reference/put_3.md
  - https://dev.hostfully.com/reference/put_4.md
  - https://dev.hostfully.com/reference/put_5.md
  - https://dev.hostfully.com/reference/put_6.md
  - https://dev.hostfully.com/reference/put_7.md
  - https://dev.hostfully.com/reference/put_8.md
  - https://dev.hostfully.com/reference/put_9.md
  - https://dev.hostfully.com/reference/putleadonhold.md
  - https://dev.hostfully.com/reference/rebook.md
  - https://dev.hostfully.com/reference/remove-tag-for-object.md
  - https://dev.hostfully.com/reference/removelead.md
  - https://dev.hostfully.com/reference/reopen.md
  - https://dev.hostfully.com/reference/resendmessage.md
  - https://dev.hostfully.com/reference/set-tags-for-object.md
  - https://dev.hostfully.com/reference/tags-by-object.md
  - https://dev.hostfully.com/reference/update.md
  - https://dev.hostfully.com/reference/updateapiversion.md
  - https://dev.hostfully.com/reference/updatefee.md
  - https://dev.hostfully.com/reference/updateowneradjustment.md
  - https://dev.hostfully.com/reference/updatepropertyinfull.md
  - https://dev.hostfully.com/reference/updatepropertypartially.md
  - https://dev.hostfully.com/reference/updatepropertypartially_1.md
  - https://dev.hostfully.com/reference/updatepropertyrule.md
  - https://dev.hostfully.com/reference/updateratemultipliers.md
  - https://dev.hostfully.com/reference/updaterentalagreementurl.md
  merge:
    pages: 176
    deduped: 773
    conflicts_kept_first: 0