{"info":{"_postman_id":"5e48af5c-8142-4a79-955d-2dd7696616ca","name":"Collectif API","description":"

📄 Get started here

Collectif provides API that enables you to import new Voice of the Customer data to your Collectif app.

Add a churn reason
Add a customer interview
Add a customer review
Add a deal won/lost reason
Add a sales call
Add a survey submission
Add a support ticket

Getting started guide

You must use a valid API token to send requests to the API endpoints. You can find your API token on the Integrations page in your Collectif app.
The API has rate limit of 100 calls per minute.
The API only responds to HTTPS-secured communications. Any requests sent via HTTP return an HTTP 301 redirect to the corresponding HTTPS resources.
The API returns request responses in JSON format. When an API request returns an error, it is sent in the JSON response as an error key.

Authentication

The Collectif API uses API token for authentication.

You can find yours on the Integrations page in your Collectif app.

Authentication error response

If an API token is missing, malformed, or invalid, you will receive an HTTP 401 Unauthorized response code.

Rate and usage limits

API access rate limits apply at a per-API token basis in unit time. The limit is 100 requests per minute. If you exceed the limit, your request will return an HTTP 429 Too Many Requests status code.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"📄 Get started here","slug":"get-started-here"}],"owner":"28223587","collectionId":"5e48af5c-8142-4a79-955d-2dd7696616ca","publishedId":"2s93zB4gRG","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"00171F","highlight":"FF98D6"},"publishDate":"2023-06-29T19:53:12.000Z"},"item":[{"name":"Add Churn Reason","event":[{"listen":"test","script":{"id":"18fe2e2a-b10b-4330-af17-3bc3976f4206","exec":[""],"type":"text/javascript"}}],"id":"92edc454-285f-4351-aabb-dfdabf5a5b82","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-length":true,"user-agent":true,"connection":true}},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"reason\": \"Missing functionality\",\n \"date\": 1688057218,\n \"customer\": \"Denis Designer\",\n \"comment\": \"We need the possibility to expand images with AI.\",\n \"country\": \"United States\",\n \"customer_name\": \"My Company LLC\",\n \"user_id\": \"23522\",\n \"value\": 1200,\n \"subscription_name\": \"Premium\",\n \"subscription_type\": \"paid_plan\",\n \"customer_journey_stage\": \"active_user\",\n \"months_as_customer\": 6,\n \"first_payment_date\": 1703616894,\n \"signup_date\": 1701616894 \n}","options":{"raw":{"language":"json"}}},"url":"https://app.collectif.ai/api/1.1/wf/add_churn_reason","description":"

Creates a new churn reason submission.

Request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Definition
reason string, required	Reason why the customer churned or deleted an account
date integer, required	Date of the event as UNIX timestamp.
comment string	Additional comment left by the customer or noted down by your team.

Request body - User attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Definition
country string	The user's country.
customer_name string	The user's business name.
user_id string	The user's id.
value numeric	The customer's value (e.g. MRR, ARR, etc.). Make sure all imported resources use the same type of value to avoid inconsistencies in data.
subscription_name string	The user's subscription plan's name.
subscription_type string	One of: freemium, free_trial, paid_plan.
customer_journey_stage string	One of: prospect, onboarding, active_user
months_as_customer integer	The number of months since the user's account creation.
signup_date integer	Date of the user's account creation as UNIX timestamp.
first_payment_date numeric	Date of the user's first payment as UNIX timestamp.

Creates a new deal won/lost reason submission.

Request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Definition
status string, required	Status of the deal. Accepts one of the two values: \"won\", or \"lost\".
reason string, required	Reason for why the deal was won or lost.
date integer, required	Date of the event as UNIX timestamp.
comment string	Additional comment noted down by your sales team.

Request body - User attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Definition
country string	The user's country.
customer_name string	The user's business name.
user_id string	The user's id.
value numeric	The customer's value (e.g. MRR, ARR, etc.). Make sure all imported resources use the same type of value to avoid inconsistencies in data.
subscription_name string	The user's subscription plan's name.
subscription_type string	One of: freemium, free_trial, paid_plan.
customer_journey_stage string	One of: prospect, onboarding, active_user
months_as_customer integer	The number of months since the user's account creation.
signup_date integer	Date of the user's account creation as UNIX timestamp.
first_payment_date numeric	Date of the user's first payment as UNIX timestamp.

Creates a new interview. Recordings can be uploaded only manually, in the app.

Request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Definition
title string, required	Title of the interview
date integer, required	Date of the interview as UNIX timestamp.
recording_link string, required	Link to the recording. Make sure the recording is accessible by anyone with the link.
additional_link string	Link to additional resources, e.g., a Google document with more information.
interview_notes string	Notes taken during the interview.
team string	Team conducting the interview. Accepts one of the values: \"UX\", \"Marketing\", \"Product\", \"Sales\", \"Operations\", \"Other\".

Request body - User attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Definition
country string	The user's country.
customer_name string	The user's business name.
user_id string	The user's id.
value numeric	The customer's value (e.g. MRR, ARR, etc.). Make sure all imported resources use the same type of value to avoid inconsistencies in data.
subscription_name string	The user's subscription plan's name.
subscription_type string	One of: freemium, free_trial, paid_plan.
customer_journey_stage string	One of: prospect, onboarding, active_user
months_as_customer integer	The number of months since the user's account creation.
signup_date integer	Date of the user's account creation as UNIX timestamp.
first_payment_date numeric	Date of the user's first payment as UNIX timestamp.

Creates a new customer review.

Request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Definition
title string, required	Title of the review
text string, required	Main text of the review
date integer, required	Date of the review as UNIX timestamp.
source string	Source of the review (e.g., Trustpilot, Capterra)
review_link string	Link to the review on the source's website.
reviewer_name string	Name of the customer leaving the review.
reviewer_position string	Position of the customer leaving the review.
reviewer_company string	Name of the customer's company.
rating integer	Rating/score chosen by the customer.
rating_max integer	Max. rating/score one can choose on the source's website.

Creates a new sales call.

Request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Definition
title string, required	The call's title.
recording_link string, required	Link to the call recording (audio or video).
date integer, required	Date of the call as UNIX timestamp.

Request body - User attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Definition
country string	The user's country.
customer_name string	The user's business name.
user_id string	The user's id.
value numeric	The customer's value (e.g. MRR, ARR, etc.). Make sure all imported resources use the same type of value to avoid inconsistencies in data.
subscription_name string	The user's subscription plan's name.
subscription_type string	One of: freemium, free_trial, paid_plan.
customer_journey_stage string	One of: prospect, onboarding, active_user
months_as_customer integer	The number of months since the user's account creation.
signup_date integer	Date of the user's account creation as UNIX timestamp.
first_payment_date numeric	Date of the user's first payment as UNIX timestamp.

Creates a new support ticket.

Request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Definition
title string, required	Title of the support ticket.
text string, required	Text of the support ticket.
date integer, required	Date of the ticket submission as UNIX timestamp.
source string	Source of the support ticket (e.g. Zendesk)
external_id string	ID of the ticket in the source system.
custom_tags list	List of custom tags (strings) used in the source system.

Request body - User attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Definition
country string	The user's country.
customer_name string	The user's business name.
user_id string	The user's id.
device string	The user's device.
browser string	The user's browser.
value numeric	The customer's value (e.g. MRR, ARR, etc.). Make sure all imported resources use the same type of value to avoid inconsistencies in data.
subscription_name string	The user's subscription plan's name.
subscription_type string	One of: freemium, free_trial, paid_plan.
customer_journey_stage string	One of: prospect, onboarding, active_user
months_as_customer integer	The number of months since the user's account creation.
signup_date integer	Date of the user's account creation as UNIX timestamp.
first_payment_date numeric	Date of the user's first payment as UNIX timestamp.

","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"5e48af5c-8142-4a79-955d-2dd7696616ca","id":"5e48af5c-8142-4a79-955d-2dd7696616ca","name":"Collectif API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","1.1","wf","add_support_ticket"],"host":["app","collectif","ai"],"query":[],"variable":[]}},"response":[],"_postman_id":"82c3ac7b-23fb-49b3-82de-957781040333"},{"name":"Add Survey Submission","id":"b69f49bb-31fa-4367-b905-58f508aed334","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"survey_response\": {\n \"survey_id\": \"sid1\",\n \"survey_title\": \"My survey\",\n \"survey_description\": \"This is an example survey.\",\n \"team\": \"marketing\",\n \"source\": \"Typeform\",\n \"source_link\": \"https://typeform.com/123\",\n \"date\": 1688057218,\n \"country\": \"United States\",\n \"customer_name\": \"My Company LLC\",\n \"user_id\": \"23522\",\n \"value\": 1200,\n \"subscription_name\": \"Premium\",\n \"subscription_type\": \"paid_plan\",\n \"customer_journey_stage\": \"active_user\",\n \"months_as_customer\": 6,\n \"first_payment_date\": 1703616894,\n \"signup_date\": 1701616894,\n \"browser\" : \"Chrome\",\n \"device\" : \"MacBook Pro\",\n \"questions\": [\n {\n \"question_id\": \"qid1\",\n \"question_type\": \"text\",\n \"question_type_additional\": \"other\",\n \"question_title\": \"Tell us about your experience with our product.\",\n \"question_description\": \"\"\n },\n {\n \"question_id\": \"qid2\",\n \"question_type\": \"boolean\",\n \"question_type_additional\": \"other\",\n \"question_title\": \"Have you used our product for more than 2 years?\",\n \"question_description\": \"\"\n },\n {\n \"question_id\": \"qid3\",\n \"question_type\": \"single_choice\",\n \"question_type_additional\": \"other\",\n \"question_title\": \"What's your favourite feature?\",\n \"question_description\": \"\"\n },\n {\n \"question_id\": \"qid4\",\n \"question_type\": \"multiple_choice\",\n \"question_type_additional\": \"other\",\n \"question_title\": \"What are the 3 features you find the least useful?\",\n \"question_description\": \"\"\n },\n {\n \"question_id\": \"qid5\",\n \"question_type\": \"scale\",\n \"question_type_additional\": \"nps\",\n \"question_title\": \"On a scale of 0 to 10, how likely are you to recommend our business to a friend or colleague?\",\n \"question_description\": \"Hello, what's your name?\"\n }\n \n ],\n \"answers\": [\n {\n \"question_id\": \"qid1\",\n \"answer_value\": \"I love it!\"\n },\n {\n \"question_id\": \"qid2\",\n \"answer_value\": \"yes\"\n },\n {\n \"question_id\": \"qid3\",\n \"answer_value\": \"AI image generation\"\n },\n {\n \"question_id\": \"qid4\",\n \"answer_value_multi\": [\"Boards\", \"Notes\", \"Comments\"]\n },\n {\n \"question_id\": \"qid5\",\n \"answer_value\": \"10\"\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://app.collectif.ai/api/1.1/wf/add_survey_submission/","description":"

Creates a new survey or form submission.
Survey submissions will start showing up in your app within 3 minutes after the call.

Request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Definition
survey_id string, required	ID of the survey in the source system. Used to match all submissions.
survey_title string, required	Title of the survey.
survey_description string	Description of the survey.
date integer, required	Date of the survey submission as UNIX timestamp.
source string	The system where the survey was created.
source_link string	The link to the survey in the source system.
team string	The team conducting the survey.
questions list	List of questions in JSON format (see below).
answers list	List of answers in JSON format (see below).

Questions

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Definition
question_id string, required	ID of the question in the source system. Used to match answers to the question.
question_type string, required	Accepts one of the values: \"text\", choice\", \"scale\". 1. \"text\" - results displayed in a list 2. \"choice\" - results displayed on a bar chart, ordered from most to least popular; use for predefined sets of answers (boolean, single choice, multiple choice, dropdown, etc.) 3. \"scale\" - results displayed on a bar chart in alphabetical order; use for scales, ratings, etc.
question_type_additional string	Accepts one of the values: \"Other\", \"NPS\", \"CSAT\". If is set to \"NPS\" or \"CSAT\", the values sent in answers will be used to calculate the appropriate score.
question_title string, required	The question itself.
question_description string	Description of the question.

Answers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Definition
question_id string, required	ID of the question the answer refers to. Used to match answers to the question.
answer_value string	The answer — for all types of questions apart from \"multiple_choice\".
answer_value_multi list	The list of answers (strings) — for \"multiple_choice\" questions.

Request body - User attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Definition
country string	The user's country.
customer_name string	The user's business name.
user_id string	The user's id.
device string	The user's device.
browser string	The user's browser.
value numeric	The customer's value (e.g. MRR, ARR, etc.). Make sure all imported resources use the same type of value to avoid inconsistencies in data.
subscription_name string	The user's subscription plan's name.
subscription_type string	One of: freemium, free_trial, paid_plan.
customer_journey_stage string	One of: prospect, onboarding, active_user
months_as_customer integer	The number of months since the user's account creation.
signup_date integer	Date of the user's account creation as UNIX timestamp.
first_payment_date numeric	Date of the user's first payment as UNIX timestamp.

","urlObject":{"protocol":"https","path":["api","1.1","wf","add_survey_submission",""],"host":["app","collectif","ai"],"query":[],"variable":[]}},"response":[{"id":"6d423885-3257-4f97-a325-7bddf743c863","name":"Add Survey Submission","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"survey_response\": {\n \"survey_id\": \"sid1\",\n \"survey_title\": \"My survey\",\n \"survey_description\": \"This is an example survey.\",\n \"team\": \"marketing\",\n \"source\": \"Typeform\",\n \"source_link\": \"https://typeform.com/123\",\n \"date\": 1688057218,\n \"country\": \"United States\",\n \"customer_name\": \"My Company LLC\",\n \"user_id\": \"23522\",\n \"arr\": 1200,\n \"mrr\": 100,\n \"ltv_current\": 600,\n \"ltv_estimated\": 2400,\n \"subscription_name\": \"Premium\",\n \"subscription_type\": \"paid_plan\",\n \"customer_journey_stage\": \"active_user\",\n \"months_as_customer\": 6,\n \"first_payment_date\": 1703616894,\n \"signup_date\": 1701616894, \n \"questions\": [\n {\n \"question_id\": \"qid1\",\n \"question_type\": \"text\",\n \"question_type_additional\": \"other\",\n \"question_title\": \"Tell us about your experience with our product.\",\n \"question_description\": \"\"\n },\n {\n \"question_id\": \"qid2\",\n \"question_type\": \"boolean\",\n \"question_type_additional\": \"other\",\n \"question_title\": \"Have you used our product for more than 2 years?\",\n \"question_description\": \"\"\n },\n {\n \"question_id\": \"qid3\",\n \"question_type\": \"single_choice\",\n \"question_type_additional\": \"other\",\n \"question_title\": \"What's your favourite feature?\",\n \"question_description\": \"\"\n },\n {\n \"question_id\": \"qid4\",\n \"question_type\": \"multiple_choice\",\n \"question_type_additional\": \"other\",\n \"question_title\": \"What are the 3 features you find the least useful?\",\n \"question_description\": \"\"\n },\n {\n \"question_id\": \"qid5\",\n \"question_type\": \"scale\",\n \"question_type_additional\": \"nps\",\n \"question_title\": \"On a scale of 0 to 10, how likely are you to recommend our business to a friend or colleague?\",\n \"question_description\": \"Hello, what's your name?\"\n }\n \n ],\n \"answers\": [\n {\n \"question_id\": \"qid1\",\n \"answer_value\": \"I love it!\"\n },\n {\n \"question_id\": \"qid2\",\n \"answer_value\": \"no\"\n },\n {\n \"question_id\": \"qid3\",\n \"answer_value\": \"AI image generation\"\n },\n {\n \"question_id\": \"qid4\",\n \"answer_value_multi\": [\"Boards\", \"Notes\", \"Comments\"]\n },\n {\n \"question_id\": \"qid5\",\n \"answer_value\": \"10\"\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://app.collectif.ai/api/1.1/wf/add_survey_submission/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 08 Jul 2023 17:51:37 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-powered-by","value":"Express"},{"key":"access-control-allow-origin","value":"*"},{"key":"x-bubble-perf","value":"{\"total\":2572.1,\"percents\":{\"top\":{\"bubble_cpu\":4.7,\"block\":95.4,\"capacity_rl\":0,\"other_pause\":0,\"pre_fiber\":0},\"sub\":{\"pp_userdb\":3.2,\"pp_wait_userdb\":0,\"http_request\":0,\"serverjson\":130,\"appserver_cache_misses_time\":0,\"redis\":55.7,\"fiber_queue\":1.1,\"capacity_wait\":0.8}},\"counts\":{\"pp_userdb\":17,\"http_request\":0,\"derived_build\":1,\"derived_cache_attempts\":3,\"derived_cache_memory_misses\":3,\"derived_cache_redis_misses\":1,\"derived_cache_postgres_misses\":1,\"serverjson\":387,\"appserver_cache_attempts\":2,\"appserver_mem_cache_hits\":0,\"appserver_cache_hits\":0,\"appserver_cache_misses\":2,\"redis\":726,\"fiber_queue\":269,\"blocks\":268},\"misc\":{\"userdb_results\":4,\"userdb_data\":1523,\"spent_time\":139027893,\"derived_build_time_spent\":58}}"},{"key":"x-bubble-capacity-used","value":"2.139 unit-seconds used"},{"key":"x-bubble-capacity-limit","value":"21.4 ms slower"},{"key":"vary","value":"Accept-Encoding"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"7e3a2d13ec848214-IAD"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"response\": {}\n}"}],"_postman_id":"b69f49bb-31fa-4367-b905-58f508aed334"}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]}},"event":[{"listen":"prerequest","script":{"id":"b9215cc7-1d6e-4138-bf3b-d44ccfa24f42","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"62ce76f9-b05c-4bf8-8052-b5a2293f4840","type":"text/javascript","exec":[""]}}]}