Full Fabric Public API
The Full Fabric API is organised around REST. It has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes and verbs.
Base URL
Every request is scoped to your institution's subdomain:
https://{subdomain}.fullfabric.cloud
Replace {subdomain} with your institution's identifier — for example, https://ff-business-school.fullfabric.cloud.
If your institution has a custom domain set up in Full Fabric, such as apply.example.com, you can call the API on it as well. It accepts the same requests and the same token:
curl https://apply.example.com/apis/profiles/profiles \
-H "Accept: application/json;version=2016-09-16" \
-H "FF-Auth: YOUR_SECRET_TOKEN"
Authentication
The API uses token-based authentication. Include your secret token in every request using the FF-Auth header:
curl https://ff-business-school.fullfabric.cloud/apis/profiles/profiles \
-H "Accept: application/json;version=2016-09-16" \
-H "FF-Auth: YOUR_SECRET_TOKEN"
Keep your API token secret: never put it in client-side code, a public repository, logs or a URL.
Create a token
Staff with the API tokens permission create tokens in Full Fabric. The Administrator role has it by default.
- Sign in to Full Fabric and open Settings.
- Go to Access & security, then API & data access, then API tokens. The page is also at
https://<your-institution>.fullfabric.cloud/i/settings/access/api-tokens. - Click Create a new API Token.
- Fill in the form:
- Name (required) and Description, to tell tokens apart later.
- Access: Read-only (the default) or Read and write.
- IP restrictions: one IPv4 address or CIDR range per line, for example
203.0.113.9or203.0.113.0/24. Leave it empty to allow the token from any address. - Expiration: 30, 90 (the default) or 180 days, a Custom date, or Doesn't expire. Setting an expiry is strongly recommended.
- Click Create, then copy the token from New API token created. It is shown once: afterwards the list only shows it masked.
Store the token as a secret in your integration's configuration, and use a separate token for each integration so you can suspend one without affecting the others.
Manage tokens
The API tokens page lists every token with its access, IP restrictions, status and last activity.
- Edit changes the name, description and IP restrictions. Access and expiry cannot change: create a new token instead.
- Suspend stops a token until you Reactivate it. Revoke stops it for good.
- The Activity tab lists the requests made with each token, and Idempotency keys lists the stored keys of idempotent writes.
- The person who created a token gets an email 14, 7, 3 and 1 days before it expires, and when it expires.
What a token's settings change
Every token can read. It can also write unless it was created read-only. Its settings change what a request gets back:
- Read-only: a write (
POST,PUT,PATCHorDELETE) returns403. - IP restrictions: a request from any other address returns
403. - Expiry date: every response carries an
FF-Auth-Token-Valid-Untilheader with that date. Once the day has passed, the token is refused with403. - Suspended, revoked or expired: every request returns
403withAn active token is required.
All requests must be made over HTTPS. Plain HTTP calls will fail.
Versioning
All requests require an API version. Specify it via the Accept header:
Accept: application/json;version=2016-09-16
Or via a dedicated header:
X-API-Version: 2016-09-16
Accept: application/json
If both are sent, X-API-Version takes precedence. The value must be exactly one of the published versions; any other value is rejected with 400.
When we make backwards-incompatible changes to the API, we release a new dated version. Pin your integration to a specific version to avoid unexpected breakage.
Pagination
List endpoints return paginated results. Use limit (1–1000, default 10) and skip to page through them:
curl "https://ff-business-school.fullfabric.cloud/apis/profiles/profiles?limit=25&skip=50" \
-H "Accept: application/json;version=2016-09-16" \
-H "FF-Auth: YOUR_SECRET_TOKEN"
File Downloads
Files attached to profiles, applications, and form submissions are served from a separate file endpoint. Pass your token via the FF-Auth header:
curl https://ff-business-school.fullfabric.cloud/files/{path}.{extension} \
-H "FF-Auth: YOUR_SECRET_TOKEN"
Request IDs
Every API response includes a X-Request-Id header. If you need to report a problem, include this value — it's the fastest way to trace a specific request.
Idempotent requests
Writes accept an Idempotency-Key header, so a retry after a timeout or a dropped connection cannot apply the same change twice. Send a value that is unique to the operation, such as a UUID, of up to 255 characters:
curl -X POST https://ff-business-school.fullfabric.cloud/apis/profiles/profiles \
-H "Accept: application/json;version=2016-09-16" \
-H "FF-Auth: YOUR_SECRET_TOKEN" \
-H "Idempotency-Key: 5f0c2a8e-4b1d-4e7a-9c3f-2d6b8a1e7c40" \
-H "Content-Type: application/json" \
-d '{"profile": {"email": "james.chen@example.com", "first_name": "James", "last_name": "Chen"}}'
- The first request runs as usual. If it succeeds, its response is kept for 60 days.
- Retrying with the same key, method, path, query and body returns the kept response without running the write again, with an
Idempotent-Replayed: trueheader. - If the first request failed, nothing is kept, and a retry with the same key runs again.
- The same key with a different body or query on that endpoint returns
422. - A retry that arrives while the first request is still running returns
409. Wait a moment and retry. - Keys belong to a token and an endpoint: the same key on another endpoint is a separate request.
GET requests ignore the header.
Errors
Full Fabric uses conventional HTTP status codes to indicate the success or failure of a request. Codes in the 2xx range indicate success. Codes in the 4xx range indicate a problem with the request, which will fail again until it changes. Codes in the 5xx range indicate an error on our servers (rare).
| Code | Meaning |
|---|---|
400 |
Bad Request: a parameter is missing or invalid, the body is malformed, or the API version is missing or not one of the published ones. |
401 |
Unauthorized: no FF-Auth token was sent, or the token is not recognised. |
403 |
Forbidden: the token is suspended, revoked or past its expiry date; a read-only token attempted a write; the request came from an IP address the token does not allow; or the token may not perform this action. |
404 |
Not Found: the resource or the endpoint does not exist. |
406 |
Not Acceptable: the Accept header names an API version this server does not serve. |
409 |
Conflict: the resource already exists, or a request with the same Idempotency-Key is still running. |
422 |
Unprocessable Entity: the request failed validation, or an Idempotency-Key was reused with a different request. |
429 |
Too Many Requests: the token went over the rate limit. |
500 |
Server Error: something went wrong on our side. |
540 |
API access is not available for this institution. |
Error body
Errors return a JSON body:
{
"status": 404,
"message": "The requested resource doesn't exist."
}
statusrepeats the HTTP status code. Authentication errors send it as a string, for example"401".messageexplains the error in English. It can change between releases, so branch on the HTTP status code, not on the text.errorsis only present on validation errors (422). It lists the failing fields by resource, each with its messages:
{
"status": 422,
"message": "Invalid request. Please refer to the documentation on how to build requests for this endpoint.",
"errors": {
"profile": {
"email": ["is invalid"]
}
}
}
Two responses are plain text rather than JSON: 429 (Too many requests, throttled) and 540 (Not available.).
Handling errors
- Retry
429after the number of seconds in itsRetry-Afterheader. - Retry
500responses and network failures with exponential backoff. Send anIdempotency-Keyon writes so a retry cannot apply a change twice. - Do not retry other
4xxresponses unchanged; fix the request first. The exception is409for a request still in progress. - When you report a problem, include the
X-Request-Idheader of the failing response.
Rate Limiting
To maintain reliability for all integrations, each token can make 40 requests every 8 seconds.
When you exceed the limit, the API returns 429 Too Many Requests with a plain text body. The Retry-After response header gives the number of seconds until the window resets. To avoid hitting the limit, make requests for a single token serially and wait at least 1 second between write operations.