Skip to content
API Reference/
/
Delete a Workspace

Foleon API (1.0.0)

The Foleon API enables you to quickly and easily develop functional applications or integrations. In fact, this is the same API that powers the Foleon platform itself.

The API follows RESTful principles, so if you've worked with a RESTful API before, many of its concepts will be familiar to you. It leverages standard HTTP features, making it compatible with most HTTP clients. Most responses, including errors, are returned in JSON format.

Designed for clarity and ease of use, the API adheres to standard HTTP response codes, providing detailed error messages when necessary.

Download OpenAPI description
index.json
index.yaml
Overview
License
Proprietary
Languages
Servers
EU cluster
https://api.foleon.com/
US cluster
https://api.us.foleon.com/

Authentication

Authenticate your requests using your api credentials by creating a bearer token.

Operations

Docs

All endpoints related to creating, retrieving or deleting Docs (editions), or updating their settings.

Operations

Projects

All endpoints related to Projects (titles).

Operations

Users

All endpoints related to Users.

Operations

Workspaces

All endpoints related to Workspaces (accounts).

Operations

Retrieve a Workspace

Request

Get a Workspace resource by it's ID.

Security
BearerAuth
Path
workspace_idinteger(ResourceIdSchema)required

The resource ID of the Workspace

Example: 123456789
curl -i -X GET \
  https://api.foleon.com/v2/account/123456789 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

JSON response for a Workspace resource

Bodyapplication/json
namestring
identifierstring
statusstring
is_trialboolean
industrystring
is_companyboolean
metaobject
idinteger(ResourceIdSchema)
created_onstring(date-time)
modified_onstring or null(date-time)
clientsobject
partnersobject
billing_countrystring or null
_embeddedobject
_linksobject
_computedobject
Response
application/json
{
  "name": "string",
  "identifier": "string",
  "status": "string",
  "is_trial": true,
  "industry": "string",
  "is_company": true,
  "meta": {
    "num_accounts": 0,
    "num_users": 0,
    "num_titles": 0,
    "num_titles_published": 0,
    "num_editions": 0,
    "num_editions_published": 0,
    "num_presets": 0,
    "num_templates": 0,
    "computed_on": "2019-08-24T14:15:22Z"
  },
  "id": 123456789,
  "created_on": "2019-08-24T14:15:22Z",
  "modified_on": "2019-08-24T14:15:22Z",
  "clients": {},
  "partners": {},
  "billing_country": "string",
  "_embedded": {
    "parent": { … },
    "children": { … },
    "memberships": { … },
    "titles": { … },
    "grants": { … },
    "country": { … }
  },
  "_links": {
    "self": { … }
  },
  "_computed": {
    "num_accounts": 0,
    "num_users": 0,
    "num_titles": 0,
    "num_titles_published": 0,
    "num_editions": 0,
    "num_editions_published": 0,
    "num_presets": 0,
    "num_templates": 0,
    "computed_on": "2019-08-24T14:15:22Z",
    "label": "string",
    "can_access_parent": true,
    "parent_account_name": "string"
  }
}

Update a Workspace

Request

Update a Workspace's settings.

Security
BearerAuth
Path
workspace_idinteger(ResourceIdSchema)required

The resource ID of the Workspace

Example: 123456789
Bodyapplication/jsonrequired

Updated Workspace attributes in JSON. Only the listed attributes can be updated. Not all of them have to be included in the request body.

namestring<= 50 characters
identifierstring<= 50 characters
statusstring
industrystring<= 255 characters
is_trialboolean or null
is_internalboolean or null
countrystring
billing_countrystring
parentstring or null
purged_onstring or null(date-time)
curl -i -X PATCH \
  https://api.foleon.com/v2/account/123456789 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "identifier": "string",
    "status": "string",
    "industry": "string",
    "is_trial": true,
    "is_internal": true,
    "country": "string",
    "billing_country": "string",
    "parent": "string",
    "purged_on": "2019-08-24T14:15:22Z"
  }'

Responses

JSON response for a Workspace resource

Bodyapplication/json
namestring
identifierstring
statusstring
is_trialboolean
industrystring
is_companyboolean
metaobject
idinteger(ResourceIdSchema)
created_onstring(date-time)
modified_onstring or null(date-time)
clientsobject
partnersobject
billing_countrystring or null
_embeddedobject
_linksobject
_computedobject
Response
application/json
{
  "name": "string",
  "identifier": "string",
  "status": "string",
  "is_trial": true,
  "industry": "string",
  "is_company": true,
  "meta": {
    "num_accounts": 0,
    "num_users": 0,
    "num_titles": 0,
    "num_titles_published": 0,
    "num_editions": 0,
    "num_editions_published": 0,
    "num_presets": 0,
    "num_templates": 0,
    "computed_on": "2019-08-24T14:15:22Z"
  },
  "id": 123456789,
  "created_on": "2019-08-24T14:15:22Z",
  "modified_on": "2019-08-24T14:15:22Z",
  "clients": {},
  "partners": {},
  "billing_country": "string",
  "_embedded": {
    "parent": { … },
    "children": { … },
    "memberships": { … },
    "titles": { … },
    "grants": { … },
    "country": { … }
  },
  "_links": {
    "self": { … }
  },
  "_computed": {
    "num_accounts": 0,
    "num_users": 0,
    "num_titles": 0,
    "num_titles_published": 0,
    "num_editions": 0,
    "num_editions_published": 0,
    "num_presets": 0,
    "num_templates": 0,
    "computed_on": "2019-08-24T14:15:22Z",
    "label": "string",
    "can_access_parent": true,
    "parent_account_name": "string"
  }
}

Delete a Workspace

Request

WARNING: Deleting a Workspace is permanent and cannot be undone. Using this endpoint is risky.

Security
BearerAuth
Path
workspace_idinteger(ResourceIdSchema)required

The resource ID of the Workspace

Example: 123456789
curl -i -X DELETE \
  https://api.foleon.com/v2/account/123456789 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Deletion was successful

List Workspaces

Request

Query all Workspaces available in your scope to return a list of Workspaces. Use bracket notation in the parameters to filter and order the data.

Security
BearerAuth
Query
filter[0][field]string(FilterFieldParameterSchema)

The field to filter on

Example: filter[0][field]=id
filter[0][type]string(FilterTypeParameterSchema)

The type of filtering operation

Enum"eq""neq""lt""lte""gt""gte""isnull""isnotnull"
filter[0][value]string or integer(FilterValueParameterSchema)

The value to filter on

Example: filter[0][value]=123456789
order-by[0][field]string(OrderByFieldParameterSchema)

The field to sort by

Example: order-by[0][field]=created_on
order-by[0][type]string(OrderByTypeParameterSchema)

a fixed value

Value"field"
order-by[0][direction]string(OrderByDirectionParameterSchema)

Descending or ascending.

Enum"desc""asc"
curl -i -X GET \
  'https://api.foleon.com/v2/account?filter%5B0%5D%5Bfield%5D=id&filter%5B0%5D%5Btype%5D=eq&filter%5B0%5D%5Bvalue%5D=123456789&order-by%5B0%5D%5Bfield%5D=created_on&order-by%5B0%5D%5Btype%5D=field&order-by%5B0%5D%5Bdirection%5D=desc' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

JSON response for a list of Workspaces. Additionally, it contains handy query information and href links to help navigate pagination.

Bodyapplication/json
_linksobject
page_countinteger
page_sizeinteger
total_itemsinteger
pageinteger
countinteger
totalinteger
_embeddedobject
Response
application/json
{
  "_links": {
    "self": { … },
    "first": { … },
    "last": { … }
  },
  "page_count": 0,
  "page_size": 0,
  "total_items": 0,
  "page": 0,
  "count": 0,
  "total": 0,
  "_embedded": {
    "account": [ … ]
  }
}

Create a Workspace

Request

Create a new Workspace.

Security
BearerAuth
Bodyapplication/jsonrequired
namestring<= 50 charactersrequired

Name of the Workspace.

identifierstring<= 50 charactersrequired

Unique identifier for the Workspace.

statusstringrequired

Status of the Workspace.

industrystring<= 255 charactersrequired

Industry associated with the Workspace.

is_trialboolean or nullrequired

Indicates if the Workspace is a trial.

is_internalboolean or nullrequired

Indicates if the Workspace is internal.

countrystringrequired

Country associated with the Workspace.

billing_countrystringrequired

Billing country associated with the Workspace.

parentstring or null

Parent Account reference.

purged_onstring or null(date-time)

Date when the Workspace was purged.

curl -i -X POST \
  https://api.foleon.com/v2/account \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "identifier": "string",
    "status": "string",
    "industry": "string",
    "is_trial": true,
    "is_internal": true,
    "country": "string",
    "billing_country": "string",
    "parent": "string",
    "purged_on": "2019-08-24T14:15:22Z"
  }'

Personalization Categories

All endpoints related to Personalization Categories.

Operations

Personalization Options

All endpoints related to Personalization Options.

Operations

Personalization Properties

All endpoints related to Personalization Properties.

Operations

Personalization Values

All endpoints related to Personalization Values.

Operations

Personalization Tokens

All endpoints related to Personalization Tokens.

Operations

Editing Content

All endpoints related to editing the content of you Foleon Docs.

Operations

Exporting Gzipped Docs

Export tar.gz webpackages to host Foleon Docs on your own server.

Operations

Foleon Analytics

All endpoints related to Foleons native analytics.

Operations

Media Library

All endpoints related to managing media in Foleon's media library.

Operations
Copyright © Foleon B.V. All rights reserved.