Authentication
Send an API key as a bearer token. The key must carry the sites.view permission; a key without it is refused with 403, not 404.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/ftp-users \
-H "Authorization: Bearer zdk_live_…"Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
The FTP accounts on the site's hosting package, including the package's own primary account so the customer can see it exists. **No password is returned for any of them, and none can be read back**: the vendor does expose the primary account's live credentials in cleartext, and this platform deliberately never calls that endpoint. `limit` is the **effective** ceiling — the lower of what the package permits and what the customer bought, with either side being unlimited yielding to the other. `permitted` and `can_create` are separate because the screen says different things: *"your plan does not include this"* is not *"you have used all of them"*. `404` for a site with no vendor hosting package. Requires `sites.view`.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
siteId (path) | Uuid | Yes | Site ID (UUIDv7). |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
data | SiteFtpUser[] | Yes | The accounts on the package, the primary one first. |
limit | VendorAllowance | Yes | The effective ceiling on FTP accounts for this site. |
permitted | boolean | Yes | Whether the package type includes FTP at all. This is the flag behind *"your plan does not include this"*. |
can_create | boolean | Yes | `permitted`, **and** the effective ceiling has room. This is the flag behind *"you have used all of them"*. Two fields rather than one because those are different sentences, and… |
Errors this endpoint can return
401 · 403 · 404 · 429 · 503