Information
- OpenAPI version:
3.0.0
Overview
Threadkite API 1
Section titled “Threadkite API 1”Connect your own systems to Threadkite: send in leads, keep your catalogue up to date, and hear about new leads and messages the moment they arrive.
Start here:
Then find each endpoint in the menu, by what it works with.
Operations
Section titled “Operations”POST
/v1/appointmentsGET
/v1/appGET
/v1/flowsPOST
/v1/flowsDELETE
/v1/flows/{id}PATCH
/v1/flows/{id}PATCH
/v1/flow-settingsPATCH
/v1/campaigns/{id}POST
/v1/companiesDELETE
/v1/companies/{id}PATCH
/v1/companies/{id}DELETE
/v1/contact-fields/{id}POST
/f/{publicKey}GET
/v1/contactsPOST
/v1/contactsPATCH
/v1/contacts/{id}DELETE
/v1/contacts/{id}/avatarPOST
/v1/eventsPOST
/v1/events/batchGET
/healthGET
/v1/importsPOST
/v1/importsGET
/v1/inboxesPOST
/v1/invitationsDELETE
/v1/invitations/{id}GET
/v1/itemsPOST
/v1/itemsPOST
/v1/items/bulkDELETE
/v1/items/{id}PATCH
/v1/items/{id}POST
/v1/leadsPOST
/v1/leads/loggedPOST
/v1/locationsDELETE
/v1/locations/{id}PATCH
/v1/locations/{id}POST
/v1/lost-reasonsDELETE
/v1/lost-reasons/{id}POST
/v1/messagesPOST
/v1/attachmentsGET
/v1/targetsPUT
/v1/targetsGET
/v1/rulesPOST
/v1/rulesDELETE
/v1/rules/{id}PATCH
/v1/rules/{id}PATCH
/v1/inbox/settingsGET
/v1/salesPOST
/v1/salesDELETE
/v1/sales/{id}DELETE
/v1/saved-replies/{id}GET
/v1/segmentsGET
/v1/sourcesPOST
/v1/sourcesPATCH
/v1/sources/{id}GET
/v1/tagsPOST
/v1/tagsDELETE
/v1/tags/{id}PATCH
/v1/tags/{id}GET
/v1/tasksPOST
/v1/tasksDELETE
/v1/tasks/{id}PATCH
/v1/tasks/{id}GET
/v1/threadsPOST
/v1/threads/bulkDELETE
/v1/threads/{id}Authentication
Section titled “Authentication”api_key
Section titled “api_key”An API key from Settings > Developers, or a partner app’s installation token (tkin_…)
Security scheme type: http
Bearer format: tk_live_...
app_token
Section titled “app_token”A partner app’s token from the client credentials grant (HTTP Basic with the app’s client id and secret). Works for 15 minutes on the app’s own endpoints (/v1/app, /v1/partner) only.
Security scheme type: oauth2
Flow type: clientCredentials
Token URL: /api/auth/oauth2/token
Scopes:
- app - The app's own endpoints