Fulfillment Locations
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/clickfunnels:clickfunnels-fulfillments-location-api"curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: ClickFunnels Fulfillments::Location 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.
### For AI agents
This document is the catalogue: every operation ClickFunnels exposes over REST is described here, with a unique operationId, typed schemas, and the scopes it needs. It is served from `/openapi.json`, `/openapi.yaml`, `/api/openapi.{json,yaml}`, and `/api/v2/openapi.{json,yaml}` on the accounts host.
Three things it does not describe, each one request away:
- MCP server: the app-native Model Context Protocol server (Streamable HTTP, OAuth 2.1 with PKCE). Prefer it over raw REST when your client supports MCP - it describes itself at runtime.
- Skill guides, also as an Agent Skills index: one task guide per job (pages, blogs, products, orders, workflows, emails, courses, stats, external SDK pages). Read the guide that matches your job before your first write. llms.txt covers when to use ClickFunnels at all, how to get credentials, and how to behave around rate limits.
- Protected resource metadata (RFC 9728) and authorization server metadata (RFC 8414): the scope vocabulary and the OAuth endpoints. Dynamic client registration is for MCP clients only.
On ClickFunnels-owned API hosts (`myclickfunnels.com` and its subdomains), the OpenAPI specification responses and API authentication failures (401, or 403 for insufficient scope) carry those links in an RFC 8288 `Link` header, so clients can discover the documentation and authentication metadata from those responses. Requests sent through a customer''s custom domain keep the Bearer challenge but omit those discovery pointers.'
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: []
- OAuth2: []
tags:
- name: Fulfillments::Location
description: Fulfillment Locations
paths:
/workspaces/{workspace_id}/fulfillments/locations:
get:
tags:
- Fulfillments::Location
summary: List Locations
operationId: listFulfillmentsLocations
parameters:
- name: workspace_id
in: path
required: true
schema:
type: string
- $ref: '#/components/parameters/after'
- $ref: '#/components/parameters/per_page'
- $ref: '#/components/parameters/sort_order'
- 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
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/FulfillmentsLocationAttributes'
example:
- id: 8
public_id: OcTvQz
workspace_id: 42000
name: Example Location
address_name: Example Address
email_address: myemail1754939695@example.com
phone_number: (123)-555-4567
sort_order: 1
archived: false
external_app: true
created_at: null
updated_at: null
address:
address_one: 3443 W. Bavaria St.
address_two: Suite 100
city: Eagle
region: Idaho
country: US
postal_code: '83616'
- id: 9
public_id: ZxWBnk
workspace_id: 42000
name: Example Location
address_name: Example Address
email_address: myemail1754939695@example.com
phone_number: (123)-555-4567
sort_order: 1
archived: false
external_app: true
created_at: null
updated_at: null
address:
address_one: 3443 W. Bavaria St.
address_two: Suite 100
city: Eagle
region: Idaho
country: US
postal_code: '83616'
'401':
description: Unauthorized
content:
application/json:
schema:
type: object
properties:
error:
type: string
hint:
type:
- string
- 'null'
description: 'The next step for the caller: how to authenticate, which scope was missing, or where the route list lives. Always present, and null when this error has no next step to offer.'
example:
error: API key missing or invalid
hint: 'Send the token as `Authorization: Bearer <token>`. Create one under Account > Team > Platform Applications (a workspace API key), or obtain one with OAuth 2.1; both use the same scopes. See https://developers.myclickfunnels.com/docs/authentication, or append .md to that URL for markdown.'
'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.
hint:
type:
- string
- 'null'
description: 'The next step for the caller: how to authenticate, which scope was missing, or where the route list lives. Always present, and null when this error has no next step to offer.'
example:
error: 'Not found: Record missing'
hint: null
'422':
$ref: '#/components/responses/InvalidPageSize'
post:
tags:
- Fulfillments::Location
summary: Create Location
operationId: createFulfillmentsLocations
parameters:
- name: workspace_id
in: path
required: true
schema:
type: string
requestBody:
description: Information about a new Location
required: true
content:
application/json:
schema:
type: object
properties:
fulfillments_location:
type: object
$ref: '#/components/schemas/FulfillmentsLocationParameters'
example:
fulfillments_location:
name: Example Location
address_name: Example Address
email_address: myemail1754939677@example.com
phone_number: (123)-555-4567
archived: false
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/FulfillmentsLocationAttributes'
example:
id: 11
public_id: nKBJXf
workspace_id: 42000
name: Example Location
address_name: Example Address
email_address: myemail1754939695@example.com
phone_number: (123)-555-4567
sort_order: 1
archived: false
external_app: true
created_at: null
updated_at: null
address:
address_one: 3443 W. Bavaria St.
address_two: Suite 100
city: Eagle
region: Idaho
country: US
postal_code: '83616'
'400':
description: Bad Request
content:
application/json:
schema:
type: object
properties:
error:
type: string
hint:
type:
- string
- 'null'
description: 'The next step for the caller: how to authenticate, which scope was missing, or where the route list lives. Always present, and null when this error has no next step to offer.'
example:
error: 'Bad request: HTTP body must be valid JSON'
hint: null
'401':
description: Unauthorized
content:
application/json:
schema:
type: object
properties:
error:
type: string
hint:
type:
- string
- 'null'
description: 'The next step for the caller: how to authenticate, which scope was missing, or where the route list lives. Always present, and null when this error has no next step to offer.'
example:
error: API key missing or invalid
hint: 'Send the token as `Authorization: Bearer <token>`. Create one under Account > Team > Platform Applications (a workspace API key), or obtain one with OAuth 2.1; both use the same scopes. See https://developers.myclickfunnels.com/docs/authentication, or append .md to that URL for markdown.'
/fulfillments/locations/{id}:
get:
tags:
- Fulfillments::Location
summary: Fetch Location
operationId: getFulfillmentsLocations
parameters:
- $ref: '#/components/parameters/id'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/FulfillmentsLocationAttributes'
example:
id: 10
public_id: TfWGdk
workspace_id: 42000
name: Example Location
address_name: Example Address
email_address: myemail1754939695@example.com
phone_number: (123)-555-4567
sort_order: 1
archived: false
external_app: true
created_at: null
updated_at: null
address:
address_one: 3443 W. Bavaria St.
address_two: Suite 100
city: Eagle
region: Idaho
country: US
postal_code: '83616'
'401':
description: Unauthorized
content:
application/json:
schema:
type: object
properties:
error:
type: string
hint:
type:
- string
- 'null'
description: 'The next step for the caller: how to authenticate, which scope was missing, or where the route list lives. Always present, and null when this error has no next step to offer.'
example:
error: API key missing or invalid
hint: 'Send the token as `Authorization: Bearer <token>`. Create one under Account > Team > Platform Applications (a workspace API key), or obtain one with OAuth 2.1; both use the same scopes. See https://developers.myclickfunnels.com/docs/authentication, or append .md to that URL for markdown.'
'404':
description: Not Found
content:
application/json:
schema:
type: object
properties:
error:
type: string
hint:
type:
- string
- 'null'
description: 'The next step for the caller: how to authenticate, which scope was missing, or where the route list lives. Always present, and null when this error has no next step to offer.'
example:
error: 'Not found: Record missing'
hint: null
put:
tags:
- Fulfillments::Location
summary: Update Location
operationId: updateFulfillmentsLocations
parameters:
- $ref: '#/components/parameters/id'
requestBody:
description: Information about updated fields in Location
required: true
content:
application/json:
schema:
type: object
properties:
fulfillments_location:
type: object
$ref: '#/components/schemas/FulfillmentsLocationParametersUpdate'
example:
fulfillments_location:
name: Example Location
address_name: Example Address
email_address: myemail@example.com
phone_number: (123)-555-4567
archived: false
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/FulfillmentsLocationAttributes'
example:
id: 13
public_id: oAyPCr
workspace_id: 42000
name: Example Location
address_name: Example Address
email_address: myemail1754939695@example.com
phone_number: (123)-555-4567
sort_order: 1
archived: false
external_app: true
created_at: null
updated_at: null
address:
address_one: 3443 W. Bavaria St.
address_two: Suite 100
city: Eagle
region: Idaho
country: US
postal_code: '83616'
'400':
description: Bad Request
content:
application/json:
schema:
type: object
properties:
error:
type: string
hint:
type:
- string
- 'null'
description: 'The next step for the caller: how to authenticate, which scope was missing, or where the route list lives. Always present, and null when this error has no next step to offer.'
example:
error: 'Bad request: HTTP body must be valid JSON'
hint: null
'401':
description: Unauthorized
content:
application/json:
schema:
type: object
properties:
error:
type: string
hint:
type:
- string
- 'null'
description: 'The next step for the caller: how to authenticate, which scope was missing, or where the route list lives. Always present, and null when this error has no next step to offer.'
example:
error: API key missing or invalid
hint: 'Send the token as `Authorization: Bearer <token>`. Create one under Account > Team > Platform Applications (a workspace API key), or obtain one with OAuth 2.1; both use the same scopes. See https://developers.myclickfunnels.com/docs/authentication, or append .md to that URL for markdown.'
'404':
description: Not Found
content:
application/json:
schema:
type: object
properties:
error:
type: string
hint:
type:
- string
- 'null'
description: 'The next step for the caller: how to authenticate, which scope was missing, or where the route list lives. Always present, and null when this error has no next step to offer.'
example:
error: 'Not found: Record missing'
hint: null
delete:
tags:
- Fulfillments::Location
summary: Remove Location
operationId: removeFulfillmentsLocations
parameters:
- $ref: '#/components/parameters/id'
responses:
'204':
description: No Content
'401':
description: Unauthorized
content:
application/json:
schema:
type: object
properties:
error:
type: string
hint:
type:
- string
- 'null'
description: 'The next step for the caller: how to authenticate, which scope was missing, or where the route list lives. Always present, and null when this error has no next step to offer.'
example:
error: API key missing or invalid
hint: 'Send the token as `Authorization: Bearer <token>`. Create one under Account > Team > Platform Applications (a workspace API key), or obtain one with OAuth 2.1; both use the same scopes. See https://developers.myclickfunnels.com/docs/authentication, or append .md to that URL for markdown.'
'404':
description: Not Found
content:
application/json:
schema:
type: object
properties:
error:
type: string
hint:
type:
- string
- 'null'
description: 'The next step for the caller: how to authenticate, which scope was missing, or where the route list lives. Always present, and null when this error has no next step to offer.'
example:
error: 'Not found: Record missing'
hint: null
components:
parameters:
id:
name: id
in: path
required: true
schema:
type: string
per_page:
name: per_page
in: query
required: false
description: Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The `Link` next-page URL keeps the value, so a client following it keeps the page size. More [in our guides](https://developers.myclickfunnels.com/docs/pagination).
schema:
type: integer
minimum: 1
default: 20
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).
schemas:
FulfillmentsLocationParametersUpdate:
type: object
title: Locations
description: Locations
required: []
properties:
name:
type: string
description: Location name
address_name:
type: string
description: Address name
email_address:
type: string
description: Email address
phone_number:
type:
- string
- 'null'
description: Phone number
archived:
type: boolean
default: false
description: Indicates if the location is archived
external_app:
type: boolean
description: Indicates a location managed by an external integration. Only to be used for requests made with Oauth 2.0 access tokens. External app locations do not need to provide an address.
address:
type: object
properties:
address_one:
type: string
description: The first line of the address
address_two:
type: string
description: The second line of the address
city:
type: string
description: The city
region:
type: string
description: The state or province
country:
type: string
description: The country (ISO2 code)
postal_code:
type: string
description: The postal code
example:
fulfillments_location:
name: Example Location
address_name: Example Address
email_address: myemail@example.com
phone_number: (123)-555-4567
archived: false
FulfillmentsLocationAttributes:
type: object
title: Locations
description: Locations
properties:
id:
type: integer
description: Location ID
public_id:
type:
- string
- 'null'
description: Public ID
workspace_id:
type: integer
description: Workspace ID
name:
type: string
description: Location name
address_name:
type: string
description: Address name
email_address:
type: string
description: Email address
phone_number:
type:
- string
- 'null'
description: Phone number
sort_order:
type:
- integer
- 'null'
description: Sort order
archived:
type: boolean
description: Indicates if the location is archived
external_app:
type:
- boolean
- 'null'
description: External app
created_at:
type:
- string
- 'null'
description: Added
updated_at:
type:
- string
- 'null'
description: Updated
address:
type: object
title: Locations
description: Locations
properties:
address_one:
type:
- string
- 'null'
description: Address line 1
address_two:
type:
- string
- 'null'
description: Address line 2
city:
type:
- string
- 'null'
description: City
region:
type:
- string
- 'null'
description: Region
country:
type:
- string
- 'null'
description: Country
postal_code:
type:
- string
- 'null'
description: Postal code
example:
id: 2
public_id: jEvMrK
workspace_id: 42000
name: Example Location
address_name: Example Address
email_address: myemail1754939677@example.com
phone_number: (123)-555-4567
sort_order: 1
archived: false
external_app: true
created_at: null
updated_at: null
address:
address_one: 3443 W. Bavaria St.
address_two: Suite 100
city: Eagle
region: Idaho
country: US
postal_code: '83616'
FulfillmentsLocationParameters:
type: object
title: Locations
description: Locations
required:
- name
- address_name
- email_address
properties:
name:
type: string
description: Location name
address_name:
type: string
description: Address name
email_address:
type: string
description: Email address
phone_number:
type:
- string
- 'null'
description: Phone number
archived:
type: boolean
default: false
description: Indicates if the location is archived
external_app:
type: boolean
description: Indicates a location managed by an external integration. Only to be used for requests made with Oauth 2.0 access tokens. External app locations do not need to provide an address.
address:
type: object
properties:
address_one:
type: string
description: The first line of the address
address_two:
type: string
description: The second line of the address
city:
type: string
description: The city
region:
type: string
description: The state or province
country:
type: string
description: The country (ISO2 code)
postal_code:
type: string
description: The postal code
example:
fulfillments_location:
name: Example Location
address_name: Example Address
email_address: myemail1754939677@example.com
phone_number: (123)-555-4567
archived: false
responses:
InvalidPageSize:
description: Unprocessable Entity - `per_page` must be a positive integer.
content:
application/json:
schema:
type: object
properties:
error:
type: string
hint:
type:
- string
- 'null'
description: Next step for the caller, or null when no additional guidance applies.
example:
error: 'Request unprocessable: per_page must be a positive integer, capped at 100 (got "0")'
hint: null
headers:
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
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
securitySchemes:
BearerAuth:
type: http
scheme: bearer
description: 'A workspace API key or an OAuth access token, sent as `Authorization: Bearer <token>`.
Both carry the same scope vocabulary as the `OAuth2` scheme below. Category-only
scopes restrict access to the categories they name. Coarse wildcards remain additive:
`read contacts:read` reads every category, while `write contacts:read` can write every
category. Omit coarse scopes when restricting access to specific categories.
Legacy tokens with only coarse scopes retain their existing unrestricted access;
a bare `read` scope alone does not enforce read-only access.
'
OAuth2:
type: oauth2
description: 'OAuth 2.0 authorization code flow for REST integrations. Create a Platform Application
and follow `https://developers.myclickfunnels.com/docs/oauth-20` to connect users.
Authorization server metadata is published at
`https://accounts.myclickfunnels.com/.well-known/oauth-authorization-server`.
Dynamic client registration at `/oauth/register` is for MCP clients only; MCP-scoped
tokens must use `https://agents.myclickfunnels.com/mcp`, not the REST API.
Scopes are least-privilege by category. Ask for the two coarse wildcards (`read`,
`write`) only when an integration genuinely needs the whole workspace; otherwise ask
for the `<category>:read` / `<category>:write` pairs you use. `write` implies `read`
for the same category. Protected resource metadata (RFC 9728) for this API lives at
`https://accounts.myclickfunnels.com/.well-known/oauth-protected-resource`.
'
flows:
authorizationCode:
authorizationUrl: https://accounts.myclickfunnels.com/oauth/authorize
tokenUrl: https://accounts.myclickfunnels.com/oauth/token
refreshUrl: https://accounts.myclickfunnels.com/oauth/token
scopes:
read: Read any resource in the granted workspaces
write: Read and write any resource in the granted workspaces
contacts:read: Read Contacts
contacts:write: Read and write Contacts
workflows:read: Read Workflows (Automations)
workflows:write: Read and write Workflows (Automations)
funnels:read: Read Funnels
funnels:write: Read and write Funnels
sites:read: Read Sites & Design
sites:write: Read and write Sites & Design
courses:read: Read Courses
courses:write: Read and write Courses
emails:read: Read Emails
emails:write: Read and write Emails
blog:read: Read Blog
blog:write: Read and write Blog
community:read: Read Community
community:write: Read and write Community
appointments:read: Read Appointments
appointments:write: Read and write Appointments
opportunities:read: Read Opportunities
opportunities:write: Read and write Opportunities
store:read: Read Store
store:write: Read and write Store
forms:read: Read Forms
forms:write: Read and write Forms
media:read: Read Media
media:write: Read and write Media
webhooks:read: Read Webhooks
webhooks:write: Read and write Webhooks
account:read: Read Account
account:write: Read and write Account
reference:read: Read Reference Data
reference:write: Read and write Reference Data
externalDocs:
description: More in-depth guides and further resources
url: https://developers.myclickfunnels.com
x-provenance:
method: harvested
publisher: ClickFunnels
source: https://accounts.myclickfunnels.com/openapi.json
note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
stamped by stamp-openapi-provenance.py (roadmap#793)