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 People API

The People API from Talkable — 9 operation(s) for people.

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

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

This API exposes 10 operations across 9 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.

10 operations 9 paths 1 schemas 7 GET2 POST1 PUT

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 People 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 10

Across 9 paths, the API surfaces 10 operations — 7 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

People 10
GET
/api/v2/coupons/{code}/permission/{person_slug}
Check if given coupon code belongs to given person
checkIfGivenCouponCodeBelongsToGivenPerson 3 params → 200
GET
/api/v2/people/{person_slug}
Find a person
findPerson 2 params → 200400
PUT
/api/v2/people/{person_slug}
Update a person
updatePerson 1 param body → 200400422
GET
/api/v2/people/{person_slug}/referrals_as_advocate
Get Friends referred by Advocate
getFriendsReferredByAdvocate 2 params → 200400
GET
/api/v2/people/{person_slug}/referrals_as_friend
Get Advocates who referred the Friend
getAdvocatesWhoReferredFriend 2 params → 200400
GET
/api/v2/people/{person_slug}/rewards
Get rewards received by person
getRewardsReceivedByPerson 2 params → 200400
GET
/api/v2/people/{person_slug}/shares_by
Get shares made by person
getSharesMadeByPerson 2 params → 200400
POST
/api/v2/people/{person_slug}/anonymize
Anonymize a person
anonymizePerson 1 param body → 200400
GET
/api/v2/people/{person_slug}/personal_data
Get personal information about a person
getPersonalInformationAboutPerson 2 params → 200400
POST
/api/v2/people/{person_slug}/unsubscribe
Unsubscribe a person
unsubscribePerson 1 param body → 200422

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-people-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