openapi: 3.2.0 info: title: ClickFunnels Store API termsOfService: https://www.clickfunnels.com/terms-of-service contact: name: ClickFunnels API Team url: https://developers.myclickfunnels.com x-logo: url: https://statics.myclickfunnels.com/image/1126065/file/31edf05760fafe41a82f16a668ab251f.png description: 'The ClickFunnels REST API that powers webhooks, native integrations, and Zapier lets you manage your ClickFunnels data, automate your workflows, and recreate ClickFunnels functionality in your own apps. ' license: name: MIT url: https://opensource.org/licenses/MIT version: 2.0.0 servers: - url: https://{subdomain}.myclickfunnels.com/api/v2 description: ClickFunnels API variables: subdomain: default: myworkspace security: - BearerAuth: [] tags: - name: Store description: '> Stores ' paths: /workspaces/{workspace_id}/stores: get: tags: - Store summary: List Stores description: List Stores operationId: listStores parameters: - name: workspace_id in: path required: true schema: type: string - $ref: '#/components/parameters/after' - $ref: '#/components/parameters/sort_order' - $ref: '#/components/parameters/sort_property' responses: '200': description: OK headers: Pagination-Next: $ref: '#/components/headers/PaginationNext' Link: $ref: '#/components/headers/Link' content: application/json: schema: type: array items: $ref: '#/components/schemas/StoreAttributes' example: - id: 2 public_id: QAPwuI name: Example Store current_path: /example-store seo_title: Example Store seo_description: Example Store seo_indexable: true social_image_id: null status: draft created_at: null updated_at: null workspace_id: 42000 - id: 3 public_id: ZnVywX name: Example Store current_path: /example-store seo_title: Example Store seo_description: Example Store seo_indexable: true social_image_id: null status: draft created_at: null updated_at: null workspace_id: 42000 '401': description: Unauthorized content: application/json: schema: type: object properties: error: type: string example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: type: object properties: error: type: string description: Not found - This usually happens when you try to access a record that does not exist in your account. It can also happen when the provided parent record is missing, e.g. you have put in a non-existent Workspaces parent ID. example: error: 'Not found: Record missing' post: tags: - Store summary: Create Store description: Create Store operationId: createStores parameters: - name: workspace_id in: path required: true schema: type: string requestBody: description: Information about a new Store required: true content: application/json: schema: type: object properties: store: type: object $ref: '#/components/schemas/StoreParameters' example: store: name: Example Store current_path: /example-store seo_title: Example Store seo_description: Example Store seo_indexable: true social_image_id: null status: draft responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/StoreAttributes' example: id: 5 public_id: TxdbiC name: Example Store current_path: /example-store seo_title: Example Store seo_description: Example Store seo_indexable: true social_image_id: null status: draft created_at: null updated_at: null workspace_id: 42000 '400': description: Bad Request content: application/json: schema: type: object properties: error: type: string example: error: 'Bad request: HTTP body must be valid JSON' '401': description: Unauthorized content: application/json: schema: type: object properties: error: type: string example: error: API key missing or invalid /stores/{id}: get: tags: - Store summary: Fetch Store description: Fetch Store operationId: getStores parameters: - $ref: '#/components/parameters/id' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StoreAttributes' example: id: 4 public_id: xUHtvh name: Example Store current_path: /example-store seo_title: Example Store seo_description: Example Store seo_indexable: true social_image_id: null status: draft created_at: null updated_at: null workspace_id: 42000 '401': description: Unauthorized content: application/json: schema: type: object properties: error: type: string example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: type: object properties: error: type: string example: error: 'Not found: Record missing' put: tags: - Store summary: Update Store description: Update Store operationId: updateStores parameters: - $ref: '#/components/parameters/id' requestBody: description: Information about updated fields in Store required: true content: application/json: schema: type: object properties: store: type: object $ref: '#/components/schemas/StoreParametersUpdate' example: store: name: Example Store current_path: /example-store seo_title: Example Store seo_description: Example Store seo_indexable: true social_image_id: null status: draft responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StoreAttributes' example: id: 7 public_id: SLxmql name: Example Store current_path: /example-store seo_title: Example Store seo_description: Example Store seo_indexable: true social_image_id: null status: draft created_at: null updated_at: null workspace_id: 42000 '400': description: Bad Request content: application/json: schema: type: object properties: error: type: string example: error: 'Bad request: HTTP body must be valid JSON' '401': description: Unauthorized content: application/json: schema: type: object properties: error: type: string example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: type: object properties: error: type: string example: error: 'Not found: Record missing' delete: tags: - Store summary: Remove Store description: Remove Store operationId: removeStores parameters: - $ref: '#/components/parameters/id' responses: '204': description: No Content '401': description: Unauthorized content: application/json: schema: type: object properties: error: type: string example: error: API key missing or invalid '404': description: Not Found content: application/json: schema: type: object properties: error: type: string example: error: 'Not found: Record missing' components: schemas: StoreParametersUpdate: type: object title: Stores description: Stores required: [] properties: name: type: string description: Name current_path: type: - string - 'null' description: Current path seo_title: type: - string - 'null' description: SEO title seo_description: type: - string - 'null' description: SEO description seo_indexable: type: - boolean - 'null' description: SEO Indexable social_image_id: type: - string - 'null' description: Social image status: type: - string - 'null' enum: - draft - published - null description: Store Status example: store: name: Example Store current_path: /example-store seo_title: Example Store seo_description: Example Store seo_indexable: true social_image_id: null status: draft StoreParameters: type: object title: Stores description: Stores required: - name properties: name: type: string description: Name current_path: type: - string - 'null' description: Current path seo_title: type: - string - 'null' description: SEO title seo_description: type: - string - 'null' description: SEO description seo_indexable: type: - boolean - 'null' description: SEO Indexable social_image_id: type: - string - 'null' description: Social image status: type: - string - 'null' enum: - draft - published - null description: Store Status example: store: name: Example Store current_path: /example-store seo_title: Example Store seo_description: Example Store seo_indexable: true social_image_id: null status: draft StoreAttributes: type: object title: Stores description: Stores properties: id: type: integer description: Store ID public_id: type: - string - 'null' description: Store Public ID name: type: string description: Name current_path: type: - string - 'null' description: Current path seo_title: type: - string - 'null' description: SEO title seo_description: type: - string - 'null' description: SEO description seo_indexable: type: - boolean - 'null' description: SEO Indexable social_image_id: type: - string - 'null' description: Social image status: type: - string - 'null' enum: - draft - published - null description: Store Status created_at: type: - string - 'null' description: Added updated_at: type: - string - 'null' description: Updated workspace_id: type: - integer - 'null' description: Workspace ID example: id: 1 public_id: hlXaqR name: Example Store current_path: /example-store seo_title: Example Store seo_description: Example Store seo_indexable: true social_image_id: null status: draft created_at: null updated_at: null workspace_id: 42000 required: - created_at - current_path - id - name - public_id - seo_description - seo_indexable - seo_title - social_image_id - status - updated_at - workspace_id parameters: id: name: id in: path required: true schema: type: string sort_property: name: sort_property in: query description: 'Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values. ' required: false schema: type: string enum: - id - updated_at sort_order: name: sort_order in: query description: Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination). required: false schema: type: string enum: - asc - desc after: name: after in: query required: false schema: type: string description: ID of item after which the collection should be returned. More examples and info about pagination [in our guides](https://developers.myclickfunnels.com/docs/pagination). headers: Link: description: A direct link to the next page for the cursor-based pagination. It includes the `after` and the Pagination-Next ID value. schema: type: string PaginationNext: description: ID of the last item in the current response after which more records exist. You can use it in an `after` query parameter for cursor-based pagination to get to the next page. schema: type: string securitySchemes: BearerAuth: type: http scheme: bearer externalDocs: description: More in-depth guides and further resources url: https://developers.myclickfunnels.com