The ContentWorkspace API can be accessed at: https://api.contentworkspace.com


API Headers #

All headers can be obtained within your Workspace under Settings → Developers → API:

• organization_id: Unique ID of your Org (created when you create your new org).
• workspace_id: Unique ID of your Workspace (created when you create a new workspace).
• api_key: Generated when the API is enabled under Settings → Developers → API.

---

Endpoints #

1. Get List Content Records #

Description:
Query for a list of Content Records under the model represented by [model_id].

Request:

• Method: GET
• URL: https://api.contentworkspace.com/[model_id]
• Headers:
  • organization_id: [organization_id]
  • workspace_id: [workspace_id]
  • api_key: [api_key]

---

2. Get Single Content Record #

Description:
Retrieve a single content record using the model’s API ID and the record’s API ID.

Request:

• Method: GET
• URL: https://api.contentworkspace.com/[model_api_id]/[record_api_id]
• Headers:
  • organization_id: [organization_id]
  • workspace_id: [workspace_id]
  • api_key: [api_key]
• Parameters:
  • model_api_id: API ID of the model (can be viewed in the Model record’s “General” section).
  • record_api_id: API ID of the content record (can be viewed in the Content Record’s “General” section).

---

3. Get Single Asset Record #

Description:
Retrieve a single asset record.

Request:

• Method: GET
• URL: https://api.contentworkspace.com/sys_asset/[asset_api_id]
• Headers:
  • organization_id: [organization_id]
  • workspace_id: [workspace_id]
  • api_key: [api_key]
• Parameters:
  • asset_api_id: API ID of the asset (can be viewed in the Content Record’s “General” section).

---

4. Get Asset Records #

Description:
Query for a list of assets created in your Workspace.

Request:

• Method: GET
• URL: https://api.contentworkspace.com/sys_asset
• Headers:
  • organization_id: [organization_id]
  • workspace_id: [workspace_id]
  • api_key: [api_key]

Query Parameters #

• sys_search (Optional):
  Search string to filter your content. The following search operators can be used:
  • = : Field equals value.
  • ^!= : Not equal.
  • ^STARTSWITH : Field starts with value.
  • ^CONTAINS : Field contains value.
  • ^GT : Greater than (typically for number fields).
  • ^GTE : Greater than or equal to (typically for number fields).
  • ^LT : Less than (typically for number fields).
  • ^LTE : Less than or equal to (typically for number fields).
  • ^IN : Field value is one of the provided values.
• sys_locale (Optional):
  Language code for the desired language. If not provided, content in the default language will be returned. Languages can be configured under Settings → Localization. Example:
  To get a list of records in Spanish: rubyCopyGET https://api.contentworkspace.com/[model_api_id]?sys_locale=es
• sys_limit (Optional):
  Maximum number of records to return (default is 1000).
• sys_fields:
  List of fields from your model to return. You can also dot-walk to referenced models by setting sys_fields to [reference_field_id].[referenced_model_field].
  
  Example: iniCopysys_fields=text^author.first_name
  
  Context Example:
  • Blog Model:
    • text: Text Field.
    • author: Reference to Author Model.
  • Author Model:
    • first_name: Text Field.
    • last_name: Text Field.
• sort_by:
  Sort results by the specified field. Prefix with a minus (-) to sort in descending order. Examples:
  • Ascending: &sort_by=sys_number
  • Descending: &sort_by=-sys_number
• page_num:
  Starting with 1, this parameter lets you skip a number of records in combination with sys_limit to fetch the next group of records. Example:
  To limit results to 10 records while skipping the first 20: Copy&sys_limit=10&page_num=3
• sys_group_by:
  Group records by a specific field.