Ontraport

Ontraport is a business automation platform combining CRM, marketing automation, email marketing, landing pages, ecommerce, and membership site capabilities for small businesses and entrepreneurs. The platform unifies contact management, sales pipelines, payment processing, and visual automation campaigns in a single workspace. Ontraport's REST API exposes contacts, transactions, tags, sequences, forms, landing pages, and ecommerce objects using API-Key and Api-Appid header authentication.

1 APIs 0 Features

CRMMarketing AutomationEmail MarketingEcommerceLanding PagesMembership Sites

APIs

Ontraport REST API

RESTful API providing CRUD access to contacts, transactions, tags, sequences, forms, landing pages, and ecommerce objects. Authentication uses two headers, Api-Key and Api-Appid...

Collections

Ontraport REST API

OPEN

Resources

GitHubOrganization

GitHubOrganization

Sources

opencollection: 1.0.0
info:
  name: Ontraport REST API
  version: 1.0.0
request:
  auth:
    type: apikey
    key: Api-Key
    value: '{{Api-Key}}'
    placement: header
items:
- info:
    name: Objects
    type: folder
  items:
  - info:
      name: List objects
      type: http
    http:
      method: GET
      url: https://api.ontraport.com/1/objects
      params:
      - name: objectID
        value: ''
        type: query
        description: Numeric Ontraport object type ID (e.g. 0 = Contacts).
      - name: start
        value: ''
        type: query
      - name: range
        value: ''
        type: query
    docs: Retrieves a collection of objects based on a set of parameters.
  - info:
      name: Create object
      type: http
    http:
      method: POST
      url: https://api.ontraport.com/1/objects
      body:
        type: json
        data: '{}'
    docs: Adds new data to your database.
  - info:
      name: Update object
      type: http
    http:
      method: PUT
      url: https://api.ontraport.com/1/objects
      body:
        type: json
        data: '{}'
    docs: Updates existing object data.
  - info:
      name: Delete object(s)
      type: http
    http:
      method: DELETE
      url: https://api.ontraport.com/1/objects
      params:
      - name: objectID
        value: ''
        type: query
        description: Numeric Ontraport object type ID (e.g. 0 = Contacts).
      - name: id
        value: ''
        type: query
    docs: Permanently removes data from the database.
  - info:
      name: Retrieve a single object by ID
      type: http
    http:
      method: GET
      url: https://api.ontraport.com/1/object
      params:
      - name: objectID
        value: ''
        type: query
        description: Numeric Ontraport object type ID (e.g. 0 = Contacts).
      - name: id
        value: ''
        type: query
    docs: Retrieve a single object by ID
  - info:
      name: Save or update object
      type: http
    http:
      method: POST
      url: https://api.ontraport.com/1/objects/saveorupdate
      body:
        type: json
        data: '{}'
    docs: Creates a new object or merges with an existing one if a unique field matches.
  - info:
      name: Retrieve objects by tag
      type: http
    http:
      method: GET
      url: https://api.ontraport.com/1/objects/tag
      params:
      - name: objectID
        value: ''
        type: query
        description: Numeric Ontraport object type ID (e.g. 0 = Contacts).
      - name: tag_id
        value: ''
        type: query
    docs: Retrieve objects by tag
  - info:
      name: Retrieve object ID by email
      type: http
    http:
      method: GET
      url: https://api.ontraport.com/1/object/getByEmail
      params:
      - name: objectID
        value: ''
        type: query
        description: Numeric Ontraport object type ID (e.g. 0 = Contacts).
      - name: email
        value: ''
        type: query
    docs: Retrieve object ID by email
- info:
    name: Metadata
    type: folder
  items:
  - info:
      name: Retrieve object field metadata
      type: http
    http:
      method: GET
      url: https://api.ontraport.com/1/objects/meta
      params:
      - name: objectID
        value: ''
        type: query
        description: Numeric Ontraport object type ID (e.g. 0 = Contacts).
    docs: Retrieve object field metadata
  - info:
      name: Retrieve collection info
      type: http
    http:
      method: GET
      url: https://api.ontraport.com/1/objects/getInfo
      params:
      - name: objectID
        value: ''
        type: query
        description: Numeric Ontraport object type ID (e.g. 0 = Contacts).
    docs: Returns collection information such as object counts.
  - info:
      name: Create custom fields and sections
      type: http
    http:
      method: POST
      url: https://api.ontraport.com/1/objects/fieldeditor
      body:
        type: json
        data: '{}'
    docs: Create custom fields and sections
bundled: true