info:
contact:
email: support@clozd.com
description: Documentation on how to utilize the Clozd Data API.
license:
name: Public API v3.0
url: ''
termsOfService: https://www.clozd.com/privacy/terms-of-use
title: Clozd Data API
version: v3.0
openapi: 3.0.3
paths:
/programs:
get:
description: 'Get a paginated list of programs associated with the organization for the provided API token. Make sure the header is set with a key value pair being Key: x-api-token Value: (api token provided from the settings section within the Clozd application).'
summary: Get list of programs
operationId: get-programs-op
security:
- apiKey: []
responses:
'200':
description: Successful get operation
content:
application/json:
schema:
$ref: '#/components/schemas/ListOfPrograms'
example:
success: true
message: Successfully retrieved program data.
links:
self: https://app.clozd.com/public-api/v3/programs?limit=2&offset=0
prev: null
next: https://app.clozd.com/public-api/v3/programs?limit=2&offset=2
first: https://app.clozd.com/public-api/v3/programs?limit=2&offset=0
last: https://app.clozd.com/public-api/v3/programs?limit=2&offset=2
count: 2
total: 4
data:
- clozd_program_id: c0cc3cd8-4566-4ffd-8125-bec22cf06e47
clozd_program_name: Enterprise Win-Loss Program
clozd_program_type: win-loss
- clozd_program_id: 2427ee0e-fc37-4537-ae83-b648d5a7c7f5
clozd_program_name: Customer Experience Research
clozd_program_type: qualitative-research
'400':
description: Failed operation (Bad Request)
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequest'
'401':
description: Failed operation (Unauthorized)
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
'403':
description: Failed operation (Forbidden)
content:
application/json:
schema:
$ref: '#/components/schemas/Forbidden'
tags:
- /programs
parameters:
- description: Limit for paging (min:1, max:1000)
in: query
name: limit
required: false
schema:
description: Limit for paging (min:1, max:1000)
default: 1000
example: 100
minimum: 1
maximum: 1000
format: int64
type: integer
example: 100
- description: Offset for paging (min:0, max:100000)
in: query
name: offset
required: false
schema:
description: Offset for paging (min:0, max:100000)
default: 0
example: 100
minimum: 0
maximum: 100000
format: int64
type: integer
example: 200
/programs/{program_id}/competitors:
get:
description: "Get a paginated list of competitors for a program (optionally with deals and responses referenced by competitors). Make sure the header is set with a key value pair being Key: x-api-token Value: (api token provided from the settings section within the Clozd application).\n - :program_id is required, you can get the program id from the settings page within the Clozd app."
summary: Get list of competitors
operationId: get-competitors-op
security:
- apiKey: []
responses:
'200':
description: Successful get operation
content:
application/json:
schema:
$ref: '#/components/schemas/ListOfCompetitorsWithDeals'
example:
success: true
message: Successfully retrieved competitor data.
links:
self: https://app.clozd.com/public-api/v3/programs/c0cc3cd8-4566-4ffd-8125-bec22cf06e47/competitors?limit=2&offset=4
prev: https://app.clozd.com/public-api/v3/programs/c0cc3cd8-4566-4ffd-8125-bec22cf06e47/competitors?limit=2&offset=2
next: https://app.clozd.com/public-api/v3/programs/c0cc3cd8-4566-4ffd-8125-bec22cf06e47/competitors?limit=2&offset=6
first: https://app.clozd.com/public-api/v3/programs/c0cc3cd8-4566-4ffd-8125-bec22cf06e47/competitors?limit=2&offset=0
last: https://app.clozd.com/public-api/v3/programs/c0cc3cd8-4566-4ffd-8125-bec22cf06e47/competitors?limit=2&offset=12
count: 2
total: 13
data:
- clozd_competitor_id: aef18e08-cbc0-4d86-9013-c74564de2960
clozd_competitor_name: ACME, Inc.
clozd_competitor_domain: acme.com
clozd_update_date: '2022-04-09T18:57:08.485Z'
clozd_competitor_deals:
- clozd_deal_id: ec672b7a-f7c9-4d95-b6a0-82b562876a7f
clozd_competitor_responses:
- 08d86887-2cbf-4a54-a73b-4101bdd96aab
- clozd_deal_id: fc41f67e-3050-492e-a0f2-957870ccfb18
clozd_competitor_responses:
- b24619b4-0283-4b9b-9340-130fe7e2cead
- 8b1aa294-ee82-4264-a885-64521847b9d1
- clozd_competitor_id: 934e1861-d942-41e9-98a2-b07f20af93aa
clozd_competitor_name: FUNCO, Inc.
clozd_competitor_domain: fun.co
clozd_update_date: '2022-04-08T18:57:08.485Z'
clozd_competitor_deals:
- clozd_deal_id: 7d0b27cf-e6d4-495b-b0c7-e46110976c85
clozd_competitor_responses:
- 39e0e3ae-cde5-4043-be09-7fa2d329337f
- clozd_competitor_id: 934e1861-d942-41e9-98a2-b07f20af93aa
clozd_competitor_name: DONECO, Inc.
clozd_competitor_domain: done.co
clozd_update_date: '2022-04-07T18:57:08.485Z'
clozd_competitor_deals: []
- clozd_competitor_name: unknown
clozd_competitor_deals:
- clozd_deal_id: 74d05a49-dcf8-4bf1-83eb-da97179f55e2
clozd_competitor_responses:
- eb47fe87-fe31-4785-80a4-2d086c643d27
'400':
description: Failed operation (Bad Request)
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequest'
'401':
description: Failed operation (Unauthorized)
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
'403':
description: Failed operation (Forbidden)
content:
application/json:
schema:
$ref: '#/components/schemas/Forbidden'
tags:
- /programs/:program_id/competitors
parameters:
- description: Limit for paging (min:1, max:1000)
in: query
name: limit
required: false
schema:
description: Limit for paging (min:1, max:1000)
default: 1000
example: 100
minimum: 1
maximum: 1000
format: int64
type: integer
example: 100
- description: Offset for paging (min:0, max:100000)
in: query
name: offset
required: false
schema:
description: Offset for paging (min:0, max:100000)
default: 0
example: 100
minimum: 0
maximum: 100000
format: int64
type: integer
example: 200
- description: 'Specifies type of data to include with competitor. NOTE: Cannot include ''responses'' without also including ''deals''. (maxItems:2)'
in: query
name: include
required: false
explode: true
schema:
description: 'Specifies type of data to include with competitor. NOTE: Cannot include ''responses'' without also including ''deals''. (maxItems:2)'
default: []
maxItems: 2
nullable: true
type: array
items:
description: Type of data to include with competitor.
enum:
- deals
- responses
- ''
type: string
example:
- deals
- responses
- description: Returns only competitors updated since the date and time specified. Specifying this parameter will enable periodic query of incremental changes since the last pull (instead of always having to pull all competitors). (max:25 chars, ISO8601 date-time format)
in: query
name: filter
required: false
style: deepObject
explode: true
schema:
description: 'Returns only competitors updated since the date and time specified. See clozd_update_date. NOTE: Specifying this parameter will enable periodic query of incremental changes since last pull (instead of always having to pull all competitors). (max:25 chars, ISO8601 date-time format)'
type: object
properties:
competitor_updated_since:
description: Updated since date
format: date-time
maxLength: 25
type: string
minLength: 16
- description: Clozd program ID (min:36 chars, max:36 chars)
in: path
name: program_id
required: true
schema:
description: Clozd program ID (min:36 chars, max:36 chars)
minLength: 36
maxLength: 36
type: string
format: uuid
example: 2427ee0e-fc37-4537-ae83-b648d5a7c7f5
/programs/{program_id}/deals/{deal_id}:
get:
description: "Get a specific deal with details (basic fields, extra fields, optional custom metadata fields, participants, products, published feedback responses, and full feedback transcript). Make sure the header is set with a key value pair being Key: x-api-token Value: (api token provided from the settings section within the Clozd application).\n - :program_id is required, you can get the program id from the settings page within the Clozd app. \n - :deal_id is required, see /programs/:program_id/deals to get a paginated list of program deals."
summary: Get deal with details
operationId: get-deal-op
security:
- apiKey: []
responses:
'200':
description: Successful get operation
content:
application/json:
schema:
description: Success response
type: object
properties:
success:
description: Success flag
type: boolean
message:
description: Success message
type: string
data:
$ref: '#/components/schemas/DealFull'
example:
success: true
message: Successfully retrieved deal details
data:
clozd_deal_id: f9437462-7e03-4bcc-a4db-84fc0dba4d01
clozd_share_link: https://app.clozd.com/share/deals/f9437462-7e03-4bcc-a4db-84fc0dba4d01
clozd_insight_gems:
- type: expansion
created_by_type: user
reason: null
created_at: '2026-07-01T12:00:00.000Z'
notification_date: null
clozd_external_id: '0000001'
clozd_organization_domain: acme.com
clozd_organization_name: ACME, Inc.
clozd_deal_name: ACME, Inc.
clozd_industry: SaaS
clozd_amount: 10000
clozd_currency: USD
clozd_outcome: loss
clozd_outcome_type: churn
clozd_closed_date: '2022-01-09T18:57:08.485Z'
clozd_created_date: '2022-03-09T18:57:08.485Z'
clozd_lead_source: SDR
clozd_segment: B2B
clozd_region: East
clozd_headcount: 12
clozd_revenue: 10000
clozd_sales_rep_name: Sales Rep
clozd_sales_rep_email: rep@sales.com
clozd_products:
- Flagship
clozd_participants:
- clozd_participant_id: 7624ba11-291a-450b-9781-dda5977321ba
clozd_participant_external_id: '0000002'
clozd_participant_first_name: First
clozd_participant_last_name: Last
clozd_participant_email: participant@email.com
clozd_participant_type: buyer
clozd_participant_is_primary: true
clozd_participant_phone: 888-111-2222
clozd_participant_title: Chief Buyer
clozd_participant_role: Buying Agent
clozd_responses:
- clozd_response_id: d2c7ffae-2be7-4d4c-b081-2c6153c105f5
clozd_response_participant:
clozd_participant_id: 7624ba11-291a-450b-9781-dda5977321ba
clozd_participant_external_id: '0000002'
clozd_participant_first_name: First
clozd_participant_last_name: Last
clozd_participant_email: participant@email.com
clozd_participant_type: buyer
clozd_participant_is_primary: true
clozd_participant_phone: 888-111-2222
clozd_participant_title: Chief Buyer
clozd_participant_role: Buying Agent
clozd_channel: buyer interview
clozd_decision: lost to competitor
clozd_primary_competitor:
clozd_competitor_id: 8b3079b0-8a01-44e3-a829-f85caad04317
clozd_competitor_name: BigCo, Inc.
clozd_competitor_domain: big.co
clozd_publish_date: '2022-04-09T18:57:08.485Z'
clozd_summary: ACME chose BigCo over MyCo because they felt it offered totally comparable features for only one-third the cost. BigCo had the strongest sales experience and would have been the first choice, but was removed from consideration because the price was so much higher than competitors.
clozd_drivers:
- clozd_category_name: Pricing, Value & Packaging
clozd_driver_name: Perceived Value Relative to Price
clozd_driver_rating: -1
clozd_driver_quotes:
- MyCo's pricing is just wildly higher than every [other vendor] I spoke to, with the exception of TheirCo. [HereCo] is maybe a third of what [MyCo] was quoting us . . . There was really just no way to justify that massive premium.
- clozd_category_name: Sales
clozd_driver_name: Trust & Professionalism
clozd_driver_rating: 1
clozd_driver_quotes:
- '[MyCo''s biggest strength] was that the people I interacted with in the process were all very knowledgeable, very authoritative. Every question I asked, they had an answer to. Every scenario I posed, they had handled before. [MyCo''s] website really gives you a good sense of security and that they know what they''re doing. I mean, everybody I dealt with over there was fantastic.'
clozd_tags:
- tag_category_id: a9c27012-cef4-4655-8a8a-08a1dec87171
tag_category: User Interface
tag_id: 74bee386-4198-42ef-8af1-6334d303362a
tag_name: Feedback
tag_type: manual
thread_id: c60de976-53e0-4232-bad4-e1ab87ba61e6
quote: not very user friendly.
- tag_category_id: a9c27012-cef4-4655-8a8a-08a1dec87171
tag_category: Business Strategy
tag_id: 74bee386-4198-42ef-8af1-6334d303362a
tag_name: Direction
tag_type: manual
thread_id: 45601e8d-7367-4fe5-a533-08cf8b2395eb
quote: we did not want to go the direction of a PEO
- tag_category_id: 923e9fbe-2830-45a7-8b0b-ae2f05cb28d7
tag_category: Feature Capability
tag_id: ab753b8c-ba60-4532-8e08-f414a9a7d64c
tag_name: Expertise
tag_type: manual
thread_id: 03ff92e1-af06-4a44-abab-b780107e8135
quote: ' their specialty is really that PEO side, which if we really needed it, that''s that would be the direction we would have gone in.'
clozd_update_date: '2022-04-09T18:57:08.485Z'
clozd_transcript:
- clozd_section: Overview & Origination
clozd_dialogue:
- clozd_question: What was your company's final decision?
clozd_answer: We decided not to purchase MyCo.
- clozd_question: How did you first hear about MyCo?
clozd_answer: I'm pretty sure I just Googled for secure hosting providers, service providers, those sorts of terms.
- clozd_section: Product Offering
clozd_dialogue:
- clozd_question: Did MyCo's service justify any type of premium compared to other vendors?
clozd_answer: I definitely have confidence, just based on who I spoke to and all the stuff that they laid out that they do, but I wouldn't say that they're markedly better than their competitors.
- clozd_question: Did MyCo offer any outsourcing in terms of who manages your service?
clozd_answer: So, MyCo basically is the same exact thing except it's their own infrastructure. So, they're not using AWS. They have their own data centers and their own servers.
- clozd_section: Conclusion
clozd_dialogue:
- clozd_question: What is MyCo's biggest strength that makes them stand out against their competitors?
clozd_answer: Honestly, it was just the people that I interacted with in the process were all very knowledgeable, very authoritative. Every question I asked, they had an answer to, every scenario I posed, they had handled before.
- clozd_question: Is there anything else MyCo should know about your experience?
clozd_answer: No, I think that is all. I hope this was helpful.
clozd_survey_questions:
- clozd_question: What is MyCo's biggest strength that makes them stand out against their competitors?
clozd_answer: Honestly, it was just the people that I interacted with in the process were all very knowledgeable, very authoritative. Every question I asked, they had an answer to, every scenario I posed, they had handled before.
- clozd_question: What areas would you like improved?
clozd_answer: Support;Website;Pricing
'400':
description: Failed operation (Bad Request)
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequest'
'401':
description: Failed operation (Unauthorized)
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
'403':
description: Failed operation (Forbidden)
content:
application/json:
schema:
$ref: '#/components/schemas/Forbidden'
tags:
- /programs/:program_id/deals/:deal_id
parameters:
- description: 'Specifies type of data to include with deal. NOTE: Cannot include ''transcripts'', ''surveyQuestions, or ''tags'' without also including ''feedback'' (maxItems:7)'
in: query
name: include
required: false
explode: true
schema:
description: 'Specifies type of data to include with deal. NOTE: Cannot include ''transcripts'', ''surveyQuestions'', or ''tags'' without also including ''feedback'' (maxItems:7)'
default:
- customFields
- participants
- products
- feedback
maxItems: 7
nullable: true
type: array
items:
description: Parameter without description.
enum:
- customFields
- participants
- products
- feedback
- transcripts
- tags
- surveyQuestions
- ''
type: string
example:
- customFields
- participants
- products
- description: Clozd program ID (min:36 chars, max:36 chars)
in: path
name: program_id
required: true
schema:
description: Clozd program ID (min:36 chars, max:36 chars)
minLength: 36
maxLength: 36
type: string
format: uuid
example: 760c040c-5dda-41e8-85ff-ef8f411d39d5
- description: Clozd deal ID (min:36 chars, max:36 chars)
in: path
name: deal_id
required: true
schema:
description: Clozd deal ID (min:36 chars, max:36 chars)
minLength: 36
maxLength: 36
type: string
format: uuid
example: f9437462-7e03-4bcc-a4db-84fc0dba4d01
/programs/{program_id}/deals:
get:
description: "Get a paginated list of deals with basic fields and share link (if there is published feedback). See /programs/:program_id/deals/:deal_id endpoint to get a specific deal with details. Make sure the header is set with a key value pair being Key: x-api-token Value: (api token provided from the settings section within the Clozd application).\n - :program_id is required, you can get the program id from the settings page within the Clozd app."
summary: Get list of Clozd program deals
operationId: get-deals-op
security:
- apiKey: []
responses:
'200':
description: Successful get operation
content:
application/json:
schema:
$ref: '#/components/schemas/ListOfDealsWithResponses'
example:
success: true
message: Successfully retrieved deal data.
links:
self: https://app.clozd.com/public-api/v3/programs/c0cc3cd8-4566-4ffd-8125-bec22cf06e47/deals?limit=2&offset=4
prev: https://app.clozd.com/public-api/v3/programs/c0cc3cd8-4566-4ffd-8125-bec22cf06e47/deals?limit=2&offset=2
next: https://app.clozd.com/public-api/v3/programs/c0cc3cd8-4566-4ffd-8125-bec22cf06e47/deals?limit=2&offset=6
first: https://app.clozd.com/public-api/v3/programs/c0cc3cd8-4566-4ffd-8125-bec22cf06e47/deals?limit=2&offset=0
last: https://app.clozd.com/public-api/v3/programs/c0cc3cd8-4566-4ffd-8125-bec22cf06e47/deals?limit=2&offset=12
count: 2
total: 13
data:
- clozd_deal_id: aef18e08-cbc0-4d86-9013-c74564de2960
clozd_external_id: '0000001'
clozd_deal_name: ACME, Inc.
clozd_organization_name: ACME, Inc.
clozd_organization_domain: acme.com
clozd_share_link: https://app.clozd.com/share/deals/aef18e08-cbc0-4d86-9013-c74564de2960
clozd_insight_gems:
- type: at_risk
created_by_type: ai
reason: No buyer engagement in the last 30 days.
created_at: '2026-07-01T12:00:00.000Z'
notification_date: '2026-07-01T12:00:00.000Z'
clozd_industry: SaaS
clozd_amount: 10000
clozd_currency: USD
clozd_outcome: loss
clozd_outcome_type: churn
clozd_closed_date: '2022-01-09T18:57:08.485Z'
clozd_created_date: '2022-03-09T18:57:08.485Z'
clozd_lead_source: SDR
clozd_segment: B2B
clozd_region: East
clozd_headcount: 12
clozd_revenue: 10000
clozd_sales_rep_name: Sales Rep
clozd_sales_rep_email: rep@sales.com
clozd_products:
- Flagship
clozd_responses:
- clozd_response_id: d2c7ffae-2be7-4d4c-b081-2c6153c105f5
clozd_response_participant:
clozd_participant_id: 7624ba11-291a-450b-9781-dda5977321ba
clozd_participant_external_id: '0000002'
clozd_participant_first_name: First
clozd_participant_last_name: Last
clozd_participant_email: participant@email.com
clozd_participant_type: buyer
clozd_participant_is_primary: true
clozd_participant_phone: 888-111-2222
clozd_participant_title: Chief Buyer
clozd_participant_role: Buying Agent
clozd_channel: buyer interview
clozd_decision: lost to competitor
clozd_primary_competitor:
clozd_competitor_id: 8b3079b0-8a01-44e3-a829-f85caad04317
clozd_competitor_name: BigCo, Inc.
clozd_competitor_domain: big.co
clozd_publish_date: '2022-04-09T18:57:08.485Z'
clozd_summary: ACME chose BigCo over MyCo because they felt it offered totally comparable features for only one-third the cost. BigCo had the strongest sales experience and would have been the first choice, but was removed from consideration because the price was so much higher than competitors.
clozd_drivers:
- clozd_category_name: Pricing, Value & Packaging
clozd_driver_name: Perceived Value Relative to Price
clozd_driver_rating: -1
clozd_driver_quotes:
- MyCo's pricing is just wildly higher than every [other vendor] I spoke to, with the exception of TheirCo. [HereCo] is maybe a third of what [MyCo] was quoting us . . . There was really just no way to justify that massive premium.
- clozd_category_name: Sales
clozd_driver_name: Trust & Professionalism
clozd_driver_rating: 1
clozd_driver_quotes:
- '[MyCo''s biggest strength] was that the people I interacted with in the process were all very knowledgeable, very authoritative. Every question I asked, they had an answer to. Every scenario I posed, they had handled before. [MyCo''s] website really gives you a good sense of security and that they know what they''re doing. I mean, everybody I dealt with over there was fantastic.'
clozd_survey_questions:
- clozd_question: What is MyCo's biggest strength that makes them stand out against their competitors?
clozd_answer: Honestly, it was just the people that I interacted with in the process were all very knowledgeable, very authoritative. Every question I asked, they had an answer to, every scenario I posed, they had handled before.
- clozd_question: What areas would you like improved?
clozd_answer: Support;Website;Pricing
clozd_update_date: '2022-04-09T18:57:08.485Z'
- clozd_deal_id: 934e1861-d942-41e9-98a2-b07f20af93aa
clozd_external_id: '0000002'
clozd_deal_name: FUNCO, Inc.
clozd_organization_name: FUNCO, Inc.
clozd_organization_domain: funco.com
clozd_industry: SaaS
clozd_amount: 20000
clozd_currency: USD
clozd_outcome: win
clozd_outcome_type: new business
clozd_closed_date: '2022-01-09T18:57:08.485Z'
clozd_created_date: '2022-03-09T18:57:08.485Z'
clozd_lead_source: event
clozd_segment: B2B
clozd_region: West
clozd_headcount: 44
clozd_revenue: 20000
clozd_sales_rep_name: Sales Rep
clozd_sales_rep_email: rep@sales.com
clozd_products:
- Great Product
- Another Great Product
clozd_responses:
- clozd_response_id: 273039e7-f980-4348-ad62-cf819f97cdd4
clozd_response_participant:
clozd_participant_id: 8d29f492-eb16-4748-bd13-fae8118e27ab
clozd_participant_external_id: '0000003'
clozd_participant_first_name: First2
clozd_participant_last_name: Last2
clozd_participant_email: participant2@email.com
clozd_participant_type: buyer
clozd_participant_is_primary: true
clozd_participant_phone: 888-111-2222
clozd_participant_title: Chief Buyer
clozd_participant_role: Buying Agent
clozd_channel: buyer interview
clozd_decision: won
clozd_primary_competitor:
clozd_competitor_id: 18c2ee16-cdcc-493d-8f40-0f8114aedd06
clozd_competitor_name: SmallCo, Inc.
clozd_competitor_domain: small.co
clozd_publish_date: '2022-04-09T18:57:08.485Z'
clozd_summary: FUNCO chose SmallCo over TheirCo because they felt it offered totally comparable features for only one-third the cost. SmallCo had the strongest sales experience and would have been the first choice, but was removed from consideration because the price was so much higher than competitors.
clozd_drivers:
- clozd_category_name: Pricing, Value & Packaging
clozd_driver_name: Perceived Value Relative to Price
clozd_driver_rating: 2
clozd_driver_quotes:
- TheirCo's pricing is just much lower than every [other vendor] I spoke to, with the exception of MyCo. [HereCo] is maybe twice of what [MyCo] was quoting us . . . It was really a no brainer.
- clozd_category_name: Sales
clozd_driver_name: Trust & Professionalism
clozd_driver_rating: 1
clozd_driver_quotes:
- '[TheirCo''s biggest strength] was that the people I interacted with in the process were all very knowledgeable, very authoritative. Every question I asked, they had an answer to. Every scenario I posed, they had handled before. [TheirCo''s] website really gives you a good sense of security and that they know what they''re doing. I mean, everybody I dealt with over there was fantastic.'
clozd_survey_questions:
- clozd_question: What is MyCo's biggest strength that makes them stand out against their competitors?
clozd_answer: Honestly, it was just the people that I interacted wi
# --- truncated at 32 KB (102 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/clozd/refs/heads/main/openapi/clozd-data-api-v3-openapi.yml