Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Talkable Shares API

The Shares API from Talkable — 4 operation(s) for shares.

Talkable Shares API is one of 26 APIs that Talkable publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Shares. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 4 operations across 4 paths, and defines 1 schema. It is described by OpenAPI 3.0.3, at version 2.0.

Requests are made against a single base URL, https://www.talkable.com.

4 operations 4 paths 1 schemas 1 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
2.0
Base URL
https://www.talkable.com/api/v2
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Talkable Shares API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (api_key). By default, every request must be authenticated.

  • api_key — Please provide here your API key, you can find it in Site Settings - API Integration - API Key

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 1 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Shares 4
POST
/api/v2/offer_claims
Share and claim an offer
shareAndClaimOffer 3 params → 200400
GET
/api/v2/people/{person_slug}/shares_by
Get shares made by person
getSharesMadeByPerson 2 params → 200400
POST
/api/v2/offers/{short_url_code}/shares/email
Share offer with recipients via email
shareViaEmail 1 param body → 200400
POST
/api/v2/offers/{short_url_code}/shares/social
Share offer with recipients via social channel
shareViaSocialChannel 1 param body → 200400

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. Each schema is shown below with its type and property counts.

person_slug
string
Person’s email, phone number, customer ID or username

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

talkable-shares-api-openapi.yml Raw ↑

Other APIs Talkable publishes across the network.

Talkable Advocate Offers API
Talkable Advocate Signup API
Talkable Assets API
Talkable Campaigns API
Talkable Check Unsubscribe API
Talkable Claim Links API
Talkable Coupons API
Talkable Create Coupon API
Talkable Event API
Talkable Friend Email Gating API
Talkable Friend Offers API
Talkable Loyalty API