Kapost Developer Documentation

/api/v1/collections : Collections

/api/v1/content : Content

GET

/api/v1/content/:id : Show Content

Parameter	Value	Type	Description
id		String	Content id or slug, ex 'welcome-to-kapost' or '51f05bc04aaaae4ae800000d'.
detail		Enumeration	The level of detail in the response for each record.

GET

/api/v1/content : List Content

Parameter	Type	Description
campaign_id	String	Content filtered for a specified campaign. Accepts both object ids and slugs. e.g. '51f05bc04aaaae4ae80000d' or 'awesome-video-campaign-1'
category	Array	Filter content using the specified category name(s).
columns	Array	Content column names to include in the result set.
content_number	String	Filter by content number.
content_type_id	Id	Filter content by content type id.
creator_id	Array	Filter content by creator (user) ids. Accepts both object ids and slugs. e.g. '51f05bc04aaaae4ae800000d' or 'samantha-james-2'.
date_type	Enumeration	Filter content using the specified date field.
destination_id	Id	Filter content by destination id.
detail	Enumeration	The level of detail in the response for each record.
end	Date	Relevant only if filtering by date. Content less than or equal to this timestamp will be returned.
include_empty_categories	Enumeration	Relevant only if filtering by category.
listener_id	Array	Filter content by listener (user) id. Accepts both object ids and slugs. e.g. '51f05bc04aaaae4ae800000d' or 'samantha-james-2'.
page	Numeric	The (1-indexed) page number to retrieve.
per_page	Numeric	The number of entries to retrieve per page.
search	String	Filter by search phrase.
start	Date	Relevant only if filtering by date. Content greater or equal to this timestamp will be returned.
state	Enumeration	Filter content by content state.
user_id	String	Content filtered for a specified user. Accepts both object ids and slugs. e.g. '51f05bc04aaaae4ae800000d' or 'john-6'.

POST

/api/v1/content : Create Content

Parameter	Type	Description
title	String	Title.
body	String	Content (HTML OK).
assignee_id	String	Assigned user id or username slug for this content, e.g. '51f05bc04aaaae4ae800000d' or 'reuben-dewitt'.
privacy	Enumeration	Select the privacy setting for this content.
invitee_ids	Array	Array of invited user object ids or username slugs, relevant only if a content privacy is set to private and not yet in production.
is_draft	Enumeration	Whether or not this content is in draft state.
campaign_ids	Array	Array of campaign object ids or slugs associated with this content
submission_deadline	Date	Submission deadline.
publish_deadline	Date	Publish deadline.
payment_type	Enumeration	Use a payment for this post, and select a payment strategy.
payment_fixed_rate	Numeric	Relevant when using a fixed rate for the payment amount for this post.
tags	String	A string containing a comma-separated list of tags.
external_file_url	String	Certain types of posts, such as google drive documents, require an external URL reference.
persona_ids	Array	If using personas and buying stages, an array of object id's of personas targeted by this content.
stage_ids	Array	If using personas and buying stages, an array of object id's of buying stages targeted by this content.
content_type_id	Id	Change the content type.
private_access	Enumeration	Set to true to make private and ignore any access defined by prefills.
prefill_id	Id	Prefill id to apply.
social_media_channel	String	Relevant when using a content type with a social media body type.

PUT

/api/v1/content/:id : Update Content

Parameter	Type	Description
id	String	Content id or slug, ex 'welcome-to-kapost' or '51f05bc04aaaae4ae800000d'.
operation	Enumeration	An optional action to perform on this content.
reject_reason	String	Relevant only if performing a reject operation. The reason for the rejection.
title	String	Title.
body	String	Content (HTML OK).
assignee_id	String	Assigned user id or username slug for this content, e.g. '51f05bc04aaaae4ae800000d' or 'reuben-dewitt'.
privacy	Enumeration	Select the privacy setting for this content.
invitee_ids	Array	Array of invited user object ids or username slugs, relevant only if a content privacy is set to private and not yet in production.
is_draft	Enumeration	Whether or not this content is in draft state.
campaign_ids	Array	Array of campaign object ids or slugs associated with this content
submission_deadline	Date	Submission deadline.
publish_deadline	Date	Publish deadline.
payment_type	Enumeration	Use a payment for this post, and select a payment strategy.
payment_fixed_rate	Numeric	Relevant when using a fixed rate for the payment amount for this post.
tags	String	A string containing a comma-separated list of tags.
external_file_url	String	Certain types of posts, such as google drive documents, require an external URL reference.
persona_ids	Array	If using personas and buying stages, an array of object id's of personas targeted by this content.
stage_ids	Array	If using personas and buying stages, an array of object id's of buying stages targeted by this content.
content_type_id	Id	Change the content type.
social_media_channel	String	Relevant when using a content type with a social media body type.

DELETE

/api/v1/content/:id : Delete Content

Parameter	Value	Type	Description
id		String	Content id or slug, ex 'welcome-to-kapost' or '51f05bc04aaaae4ae800000d'.

/api/v1/content/:content_id/comments : Content Activity (Comments)

GET

/api/v1/content/:content_id/comments : List Comments

Retrieves the activity feed for the specified content.

Parameter	Value	Type	Description
content_id		String	The content id or slug, ex 'welcome-to-kapost' or '51f05bc04aaaae4ae800000d'.

POST

/api/v1/content/:content_id/comments : Create Comment

Creates a comment on the specified #content.

Parameter	Value	Type	Description
content_id		String	The content id or slug, ex 'welcome-to-kapost' or '51f05bc04aaaae4ae800000d'.
body		String	The body of the comment.

DELETE

/api/v1/content/:content_id/comments/:id : Delete Comment

Deletes a comment on the specified content.

Parameter	Value	Type	Description
content_id		String	The content id or slug, ex 'welcome-to-kapost' or '51f05bc04aaaae4ae800000d'.
id		String	The id of the comment to delete.

/api/v1/content/:content_id/reminders : Content Reminders

GET

/api/v1/content/:content_id/reminders : List Reminders

Retrieves a list of your reminders for the specified content.

Parameter	Value	Type	Description
content_id		String	The content id or slug, ex 'welcome-to-kapost' or '51f05bc04aaaae4ae800000d'.

POST

/api/v1/content/:content_id/reminders : Create Reminder

Create a reminder on the specified content and task.

Parameter	Type	Description
content_id	String	The content id or slug, ex 'welcome-to-kapost' or '51f05bc04aaaae4ae800000d'.
id	Id	The task id to create the reminder for.
lead_time	Numeric	The time in minutes before the reminder should be sent.

PUT

/api/v1/content/:content_id/reminders/:id : Update Reminder

Update a reminder on the specified content and task.

Parameter	Type	Description
content_id	String	The content id or slug, ex 'welcome-to-kapost' or '51f05bc04aaaae4ae800000d'.
id	Id	The task id to update the reminder for.
lead_time	Numeric	The time in minutes before the reminder should be sent.

DELETE

/api/v1/content/:content_id/reminders/:id : Delete Reminder

Delete a reminder on the specified content and task.

Parameter	Value	Type	Description
content_id		String	The content id or slug, ex 'welcome-to-kapost' or '51f05bc04aaaae4ae800000d'.
id		Id	The task id to delete the reminder for.

/api/v1/content/:content_id/tasks : Content Tasks

GET

/api/v1/content/:content_id/tasks : List Tasks

Retrieves a list of tasks for the specified content.

Parameter	Value	Type	Description
content_id		String	The content id or slug, ex 'welcome-to-kapost' or '51f05bc04aaaae4ae800000d'.

GET

/api/v1/content/:content_id/tasks/:id : Show Task

Retrieves a task for the specified content.

Parameter	Value	Type	Description
content_id		String	The content id or slug, ex 'welcome-to-kapost' or '51f05bc04aaaae4ae800000d'.
id		Id	The task id

POST

/api/v1/content/:content_id/tasks : Create Task

Creates a task on the specified content.

Parameter	Type	Description
content_id	String	The content id or slug, ex 'welcome-to-kapost' or '51f05bc04aaaae4ae800000d'.
description	String	The title for the task.
completion_action	Enumeration	The action required for this task to be completed.
position	Numeric	The numeric ordering of this task [within the same 'state' for content]. Be aware that other tasks will likely be repositioned based on this value.
deadline	Date	If using an absolute date, the deadline of the task.
deadline_offset	String	If using a relative deadline, the interval to use.
deadline_offset_unit	Numeric	If using a relative deadline, the number of units to offset the relative deadline by.
deadline_offset_action	String	If using a relative deadline, action to make the deadline relative to.
user_ids	String	A string containing a comma-separated list of user ids to assign as the task owners.

PUT

/api/v1/content/:content_id/tasks/:id : Update Task

Updates a task on the specified content.

Parameter	Type	Description
content_id	String	The content id or slug, ex 'welcome-to-kapost' or '51f05bc04aaaae4ae800000d'.
task_id	Id	The task id.
description	String	The title for the task.
completion_action	Enumeration	The action required for this task to be completed.
position	Numeric	The numeric ordering of this task [within the same 'state' for content]. Be aware that other tasks will likely be repositioned based on this value.
state	Enumeration	Not used for initiatives. The state group which the task appears in the workflow.
deadline	Date	If using an absolute date, the deadline of the task.
deadline_offset	String	If using a relative deadline, the interval to use.
deadline_offset_unit	Numeric	If using a relative deadline, the number of units to offset the relative deadline by.
deadline_offset_action	String	If using a relative deadline, action to make the deadline relative to.
user_ids	String	A string containing a comma-separated list of user ids to assign as the task owners.

DELETE

/api/v1/content/:content_id/tasks/:id : Delete Task

Deletes a task on the specified content.

Parameter	Value	Type	Description
content_id		String	The content id or slug, ex 'welcome-to-kapost' or '51f05bc04aaaae4ae800000d'.
id		Id	The task id.

/api/v1/content/:content_id/visibility : Content Visibility

GET

/api/v1/content/:content_id/visibility : List Visibility

Retrieves a list of all instance members (and eligible groups) and their visibility and notification configuration for the specified content.

Parameter	Value	Type	Description
content_id		String	The content id or slug, ex 'welcome-to-kapost' or '51f05bc04aaaae4ae800000d'.

POST

/api/v1/content/:content_id/visibility : Grant Visibility

Grant access to the specified content to an individual contributor.

Parameter	Value	Type	Description
content_id		String	The content id or slug, ex 'welcome-to-kapost' or '51f05bc04aaaae4ae800000d'.
user_id		Id	The id of the contributor that should be granted access to the specified content.

POST

/api/v1/content/:content_id/visibility/bulkcreate : Bulk Grant Visibility

Grant access to this content for muliple contributors OR for a group containing contributors.

Parameter	Value	Type	Description
content_id		String	The content id or slug, ex 'welcome-to-kapost' or '51f05bc04aaaae4ae800000d'.
ids		Array	The ids of contributors that should have access granted to the specified content.

POST

/api/v1/content/:content_id/visibility/bulkdestroy : Bulk Revoke Visibility

Revoke access to this content for muliple contributors OR for a group containing contributors.

Parameter	Value	Type	Description
content_id		String	The content id or slug, ex 'welcome-to-kapost' or '51f05bc04aaaae4ae800000d'.
ids		Array	The ids of contributors that should have access revoked to the specified content.

DELETE

/api/v1/content/:content_id/visibility/:id : Revoke Visibility

Revoke access to this content for an individual contributor.

Parameter	Value	Type	Description
content_id		String	The content id or slug, ex 'welcome-to-kapost' or '51f05bc04aaaae4ae800000d'.
id		Id	The id of the contributor that should have access revoked from the specified content.

/api/v1/content_types_reference : Content Types Reference

/api/v1/custom_fields : Custom Fields

GET

/api/v1/custom_fields/:id : Show Custom Field

Retrieve a custom field from your current instance.

Parameter	Value	Type	Description
id		Id	Custom field id, ex '51f05bc04aaaae4ae800000d'.

GET

/api/v1/custom_fields : List Custom Fields

Retrieve a paged list of custom fields for your current instance.

Parameter	Value	Type	Description
page		Numeric	The (1-indexed) page number to retrieve.
per_page		Numeric	The number of entries to retrieve per page.

POST

/api/v1/custom_fields : Create Custom Field

Create a custom field for your current instance.

Parameter	Type	Description
id	Id	Custom field id, ex '51f05bc04aaaae4ae800000d'
display_label	String	Display name of the field to create.
name	String	Field name (Must be unique to your instance).
location	Enumeration	Location of this field
default_value	String	Relevant only if field_type is 'text'.
default_currency	String	Relevant only if field_type is 'currency'.
select_values	Array	Array of values to select from, relevant only if field_type is 'select' or 'multiselect'.
archived_value_ids	Array	Array of value IDs that should be treated as archived.
editor_or_admin_only	Enumeration	Field option: If true, this field is only viewable by Editors and Admins.
display_as_column_selector	Enumeration	Field option: If true, this field will be available as a column on content feeds. Relevant only if field_type is 'text', 'select' or 'date'.
display_as_filter	Enumeration	Field option: If true, this field will be available as a custom filter on content feeds. Relevant only if field_type is 'select' or 'multiselect'.
required_field	Enumeration	Field option: If true, this field will be required when creating a new post.
html	Enumeration	Field option: If true, this field will provide a rich editor and allow HTML. Relevant only if field_type is 'text'.
multiline	Enumeration	Field option: If true, this field will provide a multiline editor. Relevant only if field_type is 'text'.

PUT

/api/v1/custom_fields/:id : Update Custom Field

Update a custom field for your current instance.

Parameter	Type	Description
id	Id	Custom field id, ex '51f05bc04aaaae4ae800000d'
display_label	String	Display name of the field to create.
name	String	Field name (Must be unique to your instance).
location	Enumeration	Location of this field
default_value	String	Relevant only if field_type is 'text'.
select_values	Array	Array of values to select from, relevant only if field_type is 'select' or 'multiselect'.
editor_or_admin_only	Enumeration	Field option: If true, this field is only viewable by Editors and Admins.
display_as_column_selector	Enumeration	Field option: If true, this field will be available as a column on content feeds. Relevant only if field_type is 'text', 'select' or 'date'.
display_as_filter	Enumeration	Field option: If true, this field will be available as a custom filter on content feeds. Relevant only if field_type is 'select' or 'multiselect'.
required_field	Enumeration	Field option: If true, this field will be required when creating a new post.
html	Enumeration	Field option: If true, this field will provide a rich editor and allow HTML. Relevant only if field_type is 'text'.
multiline	Enumeration	Field option: If true, this field will provide a multiline editor. Relevant only if field_type is 'text'.
visible_in_previews	Enumeration	Field option: If true, this field will show in Studio preview and Gallery.
visible_in_insights	Enumeration	Field option: If true, this field will show as an option in the Insights Dashboard.
instructions	String	Instructions to show user on how to use the field

DELETE

/api/v1/custom_fields/:id : Delete Custom Field

Delete a custom field from your current instance.

Parameter	Value	Type	Description
id		Id	Custom field id, ex '51f05bc04aaaae4ae800000d'.

/api/v1/ideas : Ideas

GET

/api/v1/ideas : List Ideas

Parameter	Type	Description
detail	Enumeration	The level of detail in the response for each record.
page	Numeric	The (1-indexed) page number to retrieve.
per_page	Numeric	The number of entries to retrieve per page.
state	Enumeration	Filter idea by its state.
creator_id	Array	Filter ideas by creator (user) ids. Accepts both object ids and slugs, ex. '51f05bc04aaaae4ae800000d' or 'samantha-james-2'.
campaign_ids	Array	Filter ideas for specified campaigns. Accepts both object ids and slugs, ex. '51f05bc04aaaae4ae80000d' or 'awesome-video-campaign-1'.
persona_ids	Array	If using personas and buying stages, filter by personas object ids targeted by this idea.
stage_ids	Array	If using personas and buying stages, filter by buying stage ids targeted by this idea.
categories	Array	Filter ideas using the specified category names(s).
search	String	Filter ideas by search phrase.

GET

/api/v1/ideas/:id : Show idea

Parameter	Value	Type	Description
id		String	Idea id or slug, ex 'welcome-to-kapost' or '51f05bc04aaaae4ae800000d'.
detail		Enumeration	The level of detail in the response for each record.

POST

/api/v1/ideas : Create Idea

Parameter	Type	Description
title	String	Title.
body	String	Content of idea (HTML OK).
is_draft	Enumeration	Whether or not this idea is in draft state.
campaign_ids	Array	Array of campaign object ids or slugs associated with this idea.
persona_ids	Array	If using personas and buying stages, an array of object id's of personas targeted by this idea.
stage_ids	Array	If using personas and buying stages, an array of object id's of buying stages targeted by this idea.
tags	String	A string containing a comma-separated list of tags.

PUT

/api/v1/ideas/:id : Update Idea

Parameter	Type	Description
id	String	Idea id or slug, ex 'welcome-to-kapost' or '51f05bc04aaaae4ae800000d'.
title	String	Title.
body	String	Content of idea (HTML OK).
operation	Enumeration	Perform action to change idea state.
is_draft	Enumeration	Whether or not this idea is in draft state.
campaign_ids	Array	Array of campaign object ids or slugs associated with this idea.
persona_ids	Array	If using personas and buying stages, an array of object id's of personas targeted by this idea.
stage_ids	Array	If using personas and buying stages, an array of object id's of buying stages targeted by this idea.
tags	String	A string containing a comma-separated list of tags.

DELETE

/api/v1/ideas/:id : Delete Idea

Parameter	Value	Type	Description
id		String	Idea id or slug, ex 'welcome-to-kapost' or '51f05bc04aaaae4ae800000d'.

/api/v1/ideas/:idea_id/comments : Idea Activity (Comments)

GET

/api/v1/ideas/:idea_id/comments : List Comments

Retrieves the activity feed for the specified idea.

Parameter	Value	Type	Description
idea_id		String	The idea id or slug, ex 'welcome-to-kapost' or '51f05bc04aaaae4ae800000d'.

POST

/api/v1/ideas/:idea_id/comments : Create Comment

Creates a comment on the specified #idea.

Parameter	Value	Type	Description
idea_id		String	The idea id or slug, ex 'welcome-to-kapost' or '51f05bc04aaaae4ae800000d'.
body		String	The body of the comment.

DELETE

/api/v1/ideas/:idea_id/comments/:id : Delete Comment

Deletes a comment on the specified idea.

Parameter	Value	Type	Description
idea_id		String	The idea id or slug, ex 'welcome-to-kapost' or '51f05bc04aaaae4ae800000d'.
id		String	The id of the comment to delete.

/api/v1/initiatives : Initiatives

GET

/api/v1/initiatives : List Initiatives

Parameter	Value	Type	Description
page		Numeric	Changes page of initiatives returned

GET

/api/v1/initiatives/:id : Show Initiative

Parameter	Value	Type	Description
id		String	Initiative id or slug, ex 'welcome-to-kapost' or '51f05bc04aaaae4ae800000d'.

POST

/api/v1/initiatives : Create Initiative

Parameter	Type	Description
name	String	The name of the initiative.
description	String	The description of the initiative.
campaign_type_id	Id	If not supplied, will default to the first initiative type.
start_date	Date	Start date of the initiative.
end_date	Date	End date of the initiative.
owner_ids	Array	The ids of users that should own the initiative.
custom_fields	Hash	A hash of custom fields ids to their values.

POST

/api/v1/initiatives : Bulk Archive Initiatives

Parameter	Value	Type	Description
ids		Array	The initiative ids that the archive action will be performed on.
command	archive	Enumeration	The Archive action.

POST

/api/v1/initiatives : Bulk Unarchive Initiatives

Parameter	Value	Type	Description
ids		Array	The initiative ids that the unarchive action will be performed on.
command	unarchive	Enumeration	The Unarchive action.

POST

/api/v1/initiatives : Bulk Delete Initiatives

Parameter	Value	Type	Description
ids		Array	The initiative ids that the delete action will be performed on.
command	delete	Enumeration	The delete action.

PUT

/api/v1/initiatives/:id : Update Initiative

Parameter	Type	Description
id	String	Initiative id or slug, ex 'welcome-to-kapost' or '51f05bc04aaaae4ae800000d'.
name	String	The name of the initiative.
description	String	The description of the initiative.
campaign_type_id	Id	If not supplied, will default to the first initiative type.
start_date	Date	Start date of the initiative.
end_date	Date	End date of the initiative.
owner_ids	Array	The ids of users that should own the initiative.
custom_fields	Hash	A hash of custom fields ids to their values.

DELETE

/api/v1/initiatives/:id : Delete Initiative

Parameter	Value	Type	Description
id		String	Initiative id or slug, ex 'welcome-to-kapost' or '51f05bc04aaaae4ae800000d'.

/api/v1/initiatives/:initiative_id/comments : Initiative Activity (Comments)

GET

/api/v1/initiatives/:initiative_id/comments : List Comments

Retrieves the activity feed for the specified initiative.

Parameter	Value	Type	Description
initiative_id		String	The initiative id or slug, ex 'welcome-to-kapost' or '51f05bc04aaaae4ae800000d'.

POST

/api/v1/initiatives/:initiative_id/comments : Create Comment

Creates a comment on the specified #initiative.

Parameter	Value	Type	Description
initiative_id		String	The initiative id or slug, ex 'welcome-to-kapost' or '51f05bc04aaaae4ae800000d'.
body		String	The body of the comment.

DELETE

/api/v1/initiatives/:initiative_id/comments/:id : Delete Comment

Deletes a comment on the specified initiative.

Parameter	Value	Type	Description
initiative_id		String	The initiative id or slug, ex 'welcome-to-kapost' or '51f05bc04aaaae4ae800000d'.
id		String	The id of the comment to delete.

/api/v1/initiatives/:initiative_id/reminders : Initiative Reminders

GET

/api/v1/initiatives/:initiative_id/reminders : List Reminders

Retrieves a list of your reminders for the specified initiative.

Parameter	Value	Type	Description
initiative_id		String	The initiative id or slug, ex 'welcome-to-kapost' or '51f05bc04aaaae4ae800000d'.

POST

/api/v1/initiatives/:initiative_id/reminders : Create Reminder

Create a reminder on the specified initiative and task.

Parameter	Type	Description
initiative_id	String	The initiative id or slug, ex 'welcome-to-kapost' or '51f05bc04aaaae4ae800000d'.
id	Id	The task id to create the reminder for.
lead_time	Numeric	The time in minutes before the reminder should be sent.

PUT

/api/v1/initiatives/:initiative_id/reminders/:id : Update Reminder

Update a reminder on the specified initiative and task.

Parameter	Type	Description
initiative_id	String	The initiative id or slug, ex 'welcome-to-kapost' or '51f05bc04aaaae4ae800000d'.
id	Id	The task id to update the reminder for.
lead_time	Numeric	The time in minutes before the reminder should be sent.

DELETE

/api/v1/initiatives/:initiative_id/reminders/:id : Delete Reminder

Delete a reminder on the specified initiative and task.

Parameter	Value	Type	Description
initiative_id		String	The initiative id or slug, ex 'welcome-to-kapost' or '51f05bc04aaaae4ae800000d'.
id		Id	The task id to delete the reminder for.

/api/v1/initiatives/:initiative_id/tasks : Initiative Tasks

GET

/api/v1/initiatives/:initiative_id/tasks : List Tasks

Retrieves a list of tasks for the specified initiative.

Parameter	Value	Type	Description
initiative_id		String	The initiative id or slug, ex 'welcome-to-kapost' or '51f05bc04aaaae4ae800000d'.

GET

/api/v1/initiatives/:initiative_id/tasks/:id : Show Task

Retrieves a task for the specified initiative.

Parameter	Value	Type	Description
initiative_id		String	The initiative id or slug, ex 'welcome-to-kapost' or '51f05bc04aaaae4ae800000d'.
id		Id	The task id

POST

/api/v1/initiatives/:initiative_id/tasks : Create Task

Creates a task on the specified initiative.

Parameter	Type	Description
initiative_id	String	The initiative id or slug, ex 'welcome-to-kapost' or '51f05bc04aaaae4ae800000d'.
description	String	The title for the task.
completion_action	Enumeration	The action required for this task to be completed.
position	Numeric	The numeric ordering of this task [within the same 'state' for content]. Be aware that other tasks will likely be repositioned based on this value.
deadline	Date	If using an absolute date, the deadline of the task.
deadline_offset	String	If using a relative deadline, the interval to use.
deadline_offset_unit	Numeric	If using a relative deadline, the number of units to offset the relative deadline by.
deadline_offset_action	String	If using a relative deadline, action to make the deadline relative to.
user_ids	String	A string containing a comma-separated list of user ids to assign as the task owners.

PUT

/api/v1/initiatives/:initiative_id/tasks/:id : Update Task

Updates a task on the specified initiative.

Parameter	Type	Description
initiative_id	String	The initiative id or slug, ex 'welcome-to-kapost' or '51f05bc04aaaae4ae800000d'.
task_id	Id	The task id.
description	String	The title for the task.
completion_action	Enumeration	The action required for this task to be completed.
position	Numeric	The numeric ordering of this task [within the same 'state' for content]. Be aware that other tasks will likely be repositioned based on this value.
state	Enumeration	Not used for initiatives. The state group which the task appears in the workflow.
deadline	Date	If using an absolute date, the deadline of the task.
deadline_offset	String	If using a relative deadline, the interval to use.
deadline_offset_unit	Numeric	If using a relative deadline, the number of units to offset the relative deadline by.
deadline_offset_action	String	If using a relative deadline, action to make the deadline relative to.
user_ids	String	A string containing a comma-separated list of user ids to assign as the task owners.

DELETE

/api/v1/initiatives/:initiative_id/tasks/:id : Delete Task

Deletes a task on the specified initiative.

Parameter	Value	Type	Description
initiative_id		String	The initiative id or slug, ex 'welcome-to-kapost' or '51f05bc04aaaae4ae800000d'.
id		Id	The task id.

/api/v1/insights/content : Insights Content

GET

/api/v1/insights/content : List

Parameter	Type	Description
content_ids	Array	the content ids to retrieve stats on
stats	Array	the stats to retrieve, valid values
start_date	Date	beginning of range to retrieve
end_date	Date	end of range to retrieve

/api/v1/insights/events : Insights Events

GET

/api/v1/insights/events : List

Parameter	Type	Description
start_date	Date	beginning of range to retrieve
end_date	Date	end of range to retrieve
stats:	Array	whitelisted gallery stat keys

/api/v1/memberships : Memberships

GET

/api/v1/memberships : List Memberships

Parameter	Type	Description
user_id	String	Memberships filtered for a specified user. Accepts object ids, ex. '51f05bc04aaaae4ae800000d'.
newsroom_id	String	Memberships filtered for a specified newsroom, ex. '51f05bc04aaaae4ae800000d'.
group_id	String	Memberships filtered for a specified group, ex. '51f05bc04aaaae4ae800000d'.
org_members	Enumeration	Memberships filtered for org_members.
state	Enumeration	Memberships filtered for the specified state.
search_term	String	Filter by search phrase.
suspended	Enumeration	Memberships filtered by suspended state.
page	Numeric	The (1-indexed) page number to retrieve.
per_page	Numeric	The number of entries to retrieve per page.

/api/v1/tasks : Tasks

GET

/api/v1/tasks : List Tasks

Retrieves a list of tasks.

Parameter	Type	Description
page	Numeric	The (1-indexed) page number to retrieve.
per_page	Numeric	The number of entries to retrieve per page.
workflow_ids	Array	Filter tasks by a list of Content or Initiatives. Accepts both object ids and slugs, ex. '51f05bc04aaaae4ae80000d' or 'awesome-video-campaign-1'.

/api/v1/users/:id : Users

GET

/api/v1/users/:id : Show User

Parameter	Value	Type	Description
id		String	User id or slug, ex 'welcome-to-kapost' or '51f05bc04aaaae4ae800000d'.

PUT

/api/v1/users/:id : Update User

Parameter	Type	Description
id	String	User id or slug, ex 'welcome-to-kapost' or '51f05bc04aaaae4ae800000d'.
phone	String	Phone number, ex '303-555-5555'
remote_avatar_url	String	Image url
name	String	User name

Subdomain:
Token:

Kapost Developer Documentation

API Playground

Collections

Content

Custom Fields

Ideas

Initiatives

Insights Content

Insights Events

Memberships

Tasks

Users