API Reference

Introduction

The Shape Open API is a REST API for building applications on top of Shape — create and update records, read and change statuses, look up system data, and schedule calendar events, all programmatically.

This reference is for developers writing client applications against Shape. Anything your team does by hand in the Shape UI — creating records, updating and retrieving their information, reading and changing statuses, scheduling calendar events — you can do through the API. Pick the endpoints that fit your use case; you don’t need to use all of them.

Base URL

Every request is an HTTPS call to the same base URL:

https://secure-api.setshape.com/api

Append the endpoint path to build the full URL. For example, you create a record with a POST to /add/new/lead:

POSThttps://secure-api.setshape.com/api/add/new/lead

Conventions

  • REST over HTTP. Resources are accessed at predictable URLs using standard HTTP methods.
  • JSON in, JSON out. Send Content-Type: application/json and parse JSON responses.
  • Standard status codes. A 2xx means success; a 4xx means the request needs fixing. See Status Codes.
  • Per-account rate limits. Limits are shared across every app on an account. See Rate Limits.

Authentication

Every request must include your API Authorization Key in the Authorization header. You’ll need a Shape account; if you have one, grab your key from the API Integrations page. See Authentication for the exact header format and a complete request.

Finding field names

Request bodies use the field names defined on your marketing sources. Find them under:

Settings → Marketing Sources → Edit any Marketing Source → Campaign Source Post URL Instructions

Open a campaign and scroll to the Campaign Source Post URL Instructions section at the bottom. It lists every available field name in a searchable table, which you can export to CSV from the Export dropdown.

Terms of use

Using the Shape API means agreeing to all Shape Software guidelines and policies — including, but not limited to, Acceptable Use, Terms of Service, Security, and Privacy, along with any other agreed-upon policies or contracts. Violations may result in immediate termination of your API access and possible legal action.