Kantata Kantata OX Knowledge Base Release Notes Status Page

Workspace Groups

Workspace Groups (also known as groups) allow for the categorization of Kantata OX Workspaces. Workspace Groups are unique to each Kantata OX Account.

Fetching a list of Workspace Groups

This endpoint returns structured Workspace Group objects. As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array and will be indexed by ID in the workspace_groups top-level JSON key. Please see our Response Format section for more information.

Request
query Parameters
by_custom_choice_value
string

Filter by a custom field choice value, represented as a string with the custom field id, followed by a colon, and 0 to many comma separated custom field choice values IDs. The custom field choice value can also be the word 'blank'. Multiple custom field choice values IDs can be provided by separating them with a semi-colon.

The filter supports the following formats:

  • custom_field_ID:choice_value_ID
  • custom_field_ID:choice_value_1_ID,choice_value_2_ID
  • custom_field_ID:blank
  • custom_field_1_ID:choice_value_1_ID,choice_value_2_ID;custom_field_2_ID:choice_value_2_ID;custom_field_3_ID:blank.
by_custom_currency_value
string

Filter by a custom field currency value, represented as a string with the custom field id and the currency value, separated by a colon. Optionally, the currency can be supplied, separted from the currency value with another colon. Multiple custom field currency values an be provided by separating them with a semi-colon. For example, "1:200.2:USD; 2:100".

by_custom_date_value
string

Filter by a custom field date value, represented as a string with the custom field id, starting date, and ending date, seperated by colons. Both a starting date and ending date can be supplied, or just one can be provided. Multiple custom field date values an be provided by separating them with a semi-colon. For example, "1:2014-12-05:2014-12-25;2:2014-12-05".

by_custom_number_value
string

Filter by a custom field number value, represented as a string with the custom field id and the number value, separated by a colon. Multiple custom field number values an be provided by separating them with a semi-colon. For example, "1:200; 2:101".

by_custom_text_value
string

Filter by a custom field text value, represented as a string with the custom field id and the text value, separated by a colon. Multiple custom field text values an be provided by separating them with a semi-colon. For example, "1:something; 2:else".

companies_only
boolean

Filter by groups that represent a company.

created_after
string

Filter for records created after a specified datetime.

created_before
string

Filter for records created before a specified datetime.

external_reference_external_message
string

Filter the objects based on the external message of their associated external references. This is an exact match.

external_reference_external_status
string

Filter by the status of the external object in the external system.

external_reference_service_model
string

Filter by the type of the external object this external reference belongs to.

external_reference_service_model_ref
integer <int32>

Filter by the id of the external object this external reference belongs to.

external_reference_service_name
string

Filter by the name of the provider for integration.

external_reference_status
string

Filter by the status of the integration, this can be successful or fail.

has_external_references
boolean

Filter by whether or not the object has external references.

has_value_for_custom_field_ids
string

Filter by the presence of a custom field value for the specified comma-separated custom field ID(s).

include
string

Any of the below associations can be included in your request by providing the include param, e.g. include=association1,association2.

  • external_references (ExternalReference) - Includes references to external integrations for this object.
  • rate_card_sets (RateCardSet) - Rate Card Sets associated with the group.
  • workspaces (Workspace) - Workspaces associated with the group.
matching
string

Filter by groups that have a name similar to the supplied string.

only
string

Allows you to request one or more resources directly by ID. Multiple IDs can be supplied in a comma separated list, like GET /api/v1/workspaces.json?only=5,6,7.

order
string
Default: "name:ASC"

Supply order with the name of a valid sort field for the endpoint and a direction.

Valid values: created_at:asc, created_at:desc, name:asc, name:desc, updated_at:asc, and updated_at:desc.

page
integer <int32>
Default: 1
per_page
integer <int32> <= 200
Default: 20
updated_after
string

Filter for records updated after a specified datetime.

updated_before
string

Filter for records updated before a specified datetime.

without_external_reference_service_name
string

Exclude by the existence of an external reference with the specified service name.

Responses
200

A list of Workspace Groups have been retrieved.

Response Schema: application/json
count
integer <int32>
object
Array of objects
object
object
object
object
400

Bad Request

401

Unauthorized request

403

Forbidden request

404

Page Not Found

422

Unprocessable Entity

503

Service is unavailable

get/workspace_groups
Request samples
Response samples
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "workspace_groups": {
    },
  • "external_references": {
    },
  • "workspaces": {
    },
  • "rate_card_sets": {
    }
}

Creating a new Workspace Group

This endpoint returns structured Workspace Group objects. As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array and will be indexed by ID in the workspace_groups top-level JSON key. Please see our Response Format section for more information.

Request
query Parameters
include
string

Any of the below associations can be included in your request by providing the include param, e.g. include=association1,association2.

  • external_references (ExternalReference) - Includes references to external integrations for this object.
  • rate_card_sets (RateCardSet) - Rate Card Sets associated with the group.
  • workspaces (Workspace) - Workspaces associated with the group.
Request Body schema: application/json
object
name
required
string

The name of the new workspace group. Names must be unique and are not case sensitive. (ie: an account cannot both have a workspace group named "Kantata" and another named "kantata").

add_workspace_ids
Array of integers <int32>

The IDs of the workspaces to add to this group. The authorizing user must have access to all specified workspaces.

notes
string

Notes on the group.

company
boolean

Whether the group represents a company.

contact_name
string

The name of the company contact.

email
string

The email of the company contact.

phone_number
string

The phone number of the company contact.

address
string

The address of the company contact.

website
string

The website of the company contact.

object

Typically populated programmatically by a third party system via an integration, this is an optional object that holds data from an external system. It connects objects in an external system with objects in Kantata OX (for example, to connect a HubSpot Deal to a Kantata OX Project).

Responses
200

Workspace Group has been created.

Response Schema: application/json
count
integer <int32>
object
Array of objects
object
object
object
object
400

Bad Request

401

Unauthorized request

403

Forbidden request

404

Page Not Found

422

Unprocessable Entity

503

Service is unavailable

post/workspace_groups
Request samples
application/json
{
  • "workspace_group": {
    }
}
Response samples
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "workspace_groups": {
    },
  • "external_references": {
    },
  • "workspaces": {
    },
  • "rate_card_sets": {
    }
}

Fetching a single Workspace Group

This endpoint returns structured Workspace Group objects. As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array and will be indexed by ID in the workspace_groups top-level JSON key. Please see our Response Format section for more information.

Request
path Parameters
id
required
integer

The ID of the Model.

query Parameters
include
string

Any of the below associations can be included in your request by providing the include param, e.g. include=association1,association2.

  • external_references (ExternalReference) - Includes references to external integrations for this object.
  • rate_card_sets (RateCardSet) - Rate Card Sets associated with the group.
  • workspaces (Workspace) - Workspaces associated with the group.
Responses
200

The Workspace Group has been retrieved.

Response Schema: application/json
count
integer <int32>
object
Array of objects
object
object
object
object
400

Bad Request

401

Unauthorized request

403

Forbidden request

404

Page Not Found

422

Unprocessable Entity

503

Service is unavailable

get/workspace_groups/{id}
Request samples
Response samples
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "workspace_groups": {
    },
  • "external_references": {
    },
  • "workspaces": {
    },
  • "rate_card_sets": {
    }
}

Updating an existing Workspace Group

This endpoint returns structured Workspace Group objects. As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array and will be indexed by ID in the workspace_groups top-level JSON key. Please see our Response Format section for more information.

Request
path Parameters
id
required
integer

The ID of the Model.

query Parameters
include
string

Any of the below associations can be included in your request by providing the include param, e.g. include=association1,association2.

  • external_references (ExternalReference) - Includes references to external integrations for this object.
  • rate_card_sets (RateCardSet) - Rate Card Sets associated with the group.
  • workspaces (Workspace) - Workspaces associated with the group.
Request Body schema: application/json
object
name
required
string

The name of the group.

add_workspace_ids
Array of integers <int32>

The IDs of the workspaces to add to this group. Workspaces already associated with the workspace group will retain association. The authorizing user must have access to all the specified workspaces.

remove_workspace_ids
Array of integers <int32>

The IDs of the workspaces to remove from this group. The authorizing user must have access to all specified workspaces.

notes
string

Notes on the group.

company
boolean

Whether the group represents a company.

contact_name
string

The name of the company contact.

email
string

The email of the company contact.

phone_number
string

The phone number of the company contact.

address
string

The address of the company contact.

website
string

The website of the company contact.

object

Typically populated programmatically by a third party system via an integration, this is an optional object that holds data from an external system. It connects objects in an external system with objects in Kantata OX (for example, to connect a HubSpot Deal to a Kantata OX Project).

Responses
200

Workspace Group has been updated.

Response Schema: application/json
count
integer <int32>
object
Array of objects
object
object
object
object
400

Bad Request

401

Unauthorized request

403

Forbidden request

404

Page Not Found

422

Unprocessable Entity

503

Service is unavailable

put/workspace_groups/{id}
Request samples
application/json
{
  • "workspace_group": {
    }
}
Response samples
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "workspace_groups": {
    },
  • "external_references": {
    },
  • "workspaces": {
    },
  • "rate_card_sets": {
    }
}

Deleting an existing Workspace Group

The response will contain no content and an HTTP 204 status code if the request was successful, or a standard Kantata OX error message explaining why the object could not be deleted.

Request
path Parameters
id
required
integer

The ID of the Model.

Responses
204

Workspace Group has been deleted.

400

Bad Request

401

Unauthorized request

403

Forbidden request

404

Page Not Found

422

Unprocessable Entity

503

Service is unavailable

delete/workspace_groups/{id}
Request samples
Response samples
application/json
{
  • "errors": [
    ]
}