Skip to content

Workspace Status Changes

Workspace Status Changes represent changes made to the status of a project.

Operations

Fetching a list of Workspace Status Changes

Request

Returns all project status changes that are visible to the user for the passed project ID.

This endpoint returns structured Workspace Status Change 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_status_changes top-level JSON key. Please see our Response Format section for more information.

Query
workspace_idinteger, (int32)required

Required parameter for retrieving status changes for a specified project.

created_afterstring, (date-time)

Filter for records created after a specified datetime. The datetime must be in ISO 8601 format.

created_beforestring, (date-time)

Filter for records created before a specified datetime. The datetime must be in ISO 8601 format.

includestring

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

  • user (User) - References the user who made the change.
  • workspace (Workspace) - References the project for which the status changed.
onlystring

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.

orderstring

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

Valid values: created_at:asc and created_at:desc.

Default:"created_at:desc"
pageinteger, (int32)
Default:1
per_pageinteger, (int32), <= 200
Default:20
updated_afterstring, (date-time)

Filter for records updated after a specified datetime. The datetime must be in ISO 8601 format.

updated_beforestring, (date-time)

Filter for records updated before a specified datetime. The datetime must be in ISO 8601 format.

GET
/workspace_status_changes
curl -i -X GET \
  'https://api.mavenlink.com/api/v1/workspace_status_changes?workspace_id=0&created_after=2019-08-24T14%3A15%3A22Z&created_before=2019-08-24T14%3A15%3A22Z&include=string&only=string&order=created_at%3Adesc&page=1&per_page=20&updated_after=2019-08-24T14%3A15%3A22Z&updated_before=2019-08-24T14%3A15%3A22Z'

Responses

A list of Workspace Status Changes have been retrieved.

Bodyapplication/json
countinteger, (int32)
metaobject
resultsArray of objects
workspace_status_changesobject
usersobject
workspacesobject
Response
{
  "count": 0,
  "meta": {
    "count": 0,
    "page_count": 0,
    "page_number": 0,
    "page_size": 0
  },
  "results": [
    {
      "key": "string",
      "id": "string"
    }
  ],
  "workspace_status_changes": {
    "property1": {
      "created_at": "2019-08-24T14:15:22Z",
      "from_color": "string",
      "from_message": "string",
      "from_status_key": "string",
      "to_color": "string",
      "to_message": "string",
      "to_status_key": "string",
      "updated_at": "2019-08-24T14:15:22Z",
      "user_id": "string",
      "workspace_id": "string"
    },
    "property2": {
      "created_at": "2019-08-24T14:15:22Z",
      "from_color": "string",
      "from_message": "string",
      "from_status_key": "string",
      "to_color": "string",
      "to_message": "string",
      "to_status_key": "string",
      "updated_at": "2019-08-24T14:15:22Z",
      "user_id": "string",
      "workspace_id": "string"
    }
  },
  "users": {
    "property1": {
      "abbreviated_timezone": "string",
      "account_membership_id": "string",
      "bio": "string",
      "city": "string",
      "classification": "string",
      "country": "string",
      "custom_field_value_ids": [
        "string"
      ],
      "email_address": "string",
      "external_reference_ids": [
        "string"
      ],
      "full_name": "string",
      "headline": "string",
      "last_site_activity": "2019-08-24T14:15:22Z",
      "manager_id": "string",
      "photo_path": "string",
      "role_id": "string",
      "skill_ids": [
        "string"
      ],
      "skill_membership_ids": [
        "string"
      ],
      "state": "string",
      "website": "string",
      "work_sample_ids": [
        "string"
      ]
    },
    "property2": {
      "abbreviated_timezone": "string",
      "account_membership_id": "string",
      "bio": "string",
      "city": "string",
      "classification": "string",
      "country": "string",
      "custom_field_value_ids": [
        "string"
      ],
      "email_address": "string",
      "external_reference_ids": [
        "string"
      ],
      "full_name": "string",
      "headline": "string",
      "last_site_activity": "2019-08-24T14:15:22Z",
      "manager_id": "string",
      "photo_path": "string",
      "role_id": "string",
      "skill_ids": [
        "string"
      ],
      "skill_membership_ids": [
        "string"
      ],
      "state": "string",
      "website": "string",
      "work_sample_ids": [
        "string"
      ]
    }
  },
  "workspaces": {
    "property1": {
      "access_level": "string",
      "account_color_id": "string",
      "account_id": 0,
      "account_insights_mapping_ids": [
        "string"
      ],
      "actual_fees_includes_additional_line_items": true,
      "actual_fees_includes_expenses": true,
      "approver_id": "string",
      "approver_ids": [
        "string"
      ],
      "archived": true,
      "billable_minutes": 0,
      "billing_milestone_ids": [
        "string"
      ],
      "budget_remaining": "string",
      "budget_used": "string",
      "budget_used_in_cents": 0,
      "budgeted": true,
      "can_create_line_items": true,
      "can_invite": true,
      "change_orders_enabled": true,
      "client_lead_name": "string",
      "client_role_name": "string",
      "consultant_role_name": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "creator_id": "string",
      "currency": "string",
      "currency_base_unit": 0,
      "currency_symbol": "string",
      "current_status_report_id": "string",
      "current_user_participation_id": "string",
      "custom_field_value_ids": [
        "string"
      ],
      "default_rate": "string",
      "description": "string",
      "due_date": "2019-08-24",
      "effective_due_date": "2019-08-24",
      "estimated_minutes": 0,
      "exclude_archived_stories_percent_complete": true,
      "expenses_in_burn_rate": true,
      "external_link": {
        "url": "string",
        "text": "string"
      },
      "external_reference_ids": [
        "string"
      ],
      "financial_viewer_ids": [
        "string"
      ],
      "has_active_expense_report_submissions": true,
      "has_active_timesheet_submissions": true,
      "has_budget_access": true,
      "incoming_email_address": "string",
      "lock_date": "2019-08-24",
      "minutes_logged": 0,
      "next_uncompleted_milestone_id": "string",
      "non_billable_minutes": 0,
      "over_budget": true,
      "participant_ids": [
        "string"
      ],
      "participation_ids": [
        "string"
      ],
      "percent_of_budget_used": 0,
      "percentage_complete": 0,
      "permissions": {
        "can_upload_files": true,
        "can_private_message": true,
        "can_join": true,
        "is_participant": true,
        "access_level": "string",
        "team_lead": true,
        "user_is_client": true,
        "can_change_price": true,
        "can_change_story_billable": true,
        "can_post": true,
        "can_edit": true,
        "restricted": true,
        "can_see_financials": true,
        "is_guest_on_project": true
      },
      "possible_approver_ids": [
        "string"
      ],
      "posts_require_privacy_decision": true,
      "price": "string",
      "price_in_cents": 0,
      "primary_counterpart_id": "string",
      "primary_maven_id": "string",
      "primary_workspace_group_id": "string",
      "provider_lead_name": "string",
      "rate_card_id": 0,
      "require_expense_approvals": true,
      "require_notes_on_time_entries": true,
      "require_time_approvals": true,
      "revenue_recognition_method_id": "string",
      "revenue_recognition_method_name": "string",
      "stage": "string",
      "start_date": "2019-08-24",
      "status": {
        "color": "string",
        "key": "string",
        "message": "string"
      },
      "status_report_ids": [
        "string"
      ],
      "stories_are_fixed_fee_by_default": true,
      "target_margin": 0.1,
      "task_status_set_id": "string",
      "task_status_set_name": "string",
      "task_statuses": [
        "string"
      ],
      "tasks_default_non_billable": true,
      "time_trackable": true,
      "timesheet_submission_ids": [
        "string"
      ],
      "title": "string",
      "total_expenses_in_cents": 0,
      "total_invoiced": "string",
      "total_minutes_approved": 0,
      "updated_at": "2019-08-24T14:15:22Z",
      "workspace_group_ids": [
        "string"
      ],
      "workspace_invoice_preference_id": 0,
      "workspace_resource_ids": [
        "string"
      ],
      "workspace_resources_with_unnamed_ids": [
        "string"
      ]
    },
    "property2": {
      "access_level": "string",
      "account_color_id": "string",
      "account_id": 0,
      "account_insights_mapping_ids": [
        "string"
      ],
      "actual_fees_includes_additional_line_items": true,
      "actual_fees_includes_expenses": true,
      "approver_id": "string",
      "approver_ids": [
        "string"
      ],
      "archived": true,
      "billable_minutes": 0,
      "billing_milestone_ids": [
        "string"
      ],
      "budget_remaining": "string",
      "budget_used": "string",
      "budget_used_in_cents": 0,
      "budgeted": true,
      "can_create_line_items": true,
      "can_invite": true,
      "change_orders_enabled": true,
      "client_lead_name": "string",
      "client_role_name": "string",
      "consultant_role_name": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "creator_id": "string",
      "currency": "string",
      "currency_base_unit": 0,
      "currency_symbol": "string",
      "current_status_report_id": "string",
      "current_user_participation_id": "string",
      "custom_field_value_ids": [
        "string"
      ],
      "default_rate": "string",
      "description": "string",
      "due_date": "2019-08-24",
      "effective_due_date": "2019-08-24",
      "estimated_minutes": 0,
      "exclude_archived_stories_percent_complete": true,
      "expenses_in_burn_rate": true,
      "external_link": {
        "url": "string",
        "text": "string"
      },
      "external_reference_ids": [
        "string"
      ],
      "financial_viewer_ids": [
        "string"
      ],
      "has_active_expense_report_submissions": true,
      "has_active_timesheet_submissions": true,
      "has_budget_access": true,
      "incoming_email_address": "string",
      "lock_date": "2019-08-24",
      "minutes_logged": 0,
      "next_uncompleted_milestone_id": "string",
      "non_billable_minutes": 0,
      "over_budget": true,
      "participant_ids": [
        "string"
      ],
      "participation_ids": [
        "string"
      ],
      "percent_of_budget_used": 0,
      "percentage_complete": 0,
      "permissions": {
        "can_upload_files": true,
        "can_private_message": true,
        "can_join": true,
        "is_participant": true,
        "access_level": "string",
        "team_lead": true,
        "user_is_client": true,
        "can_change_price": true,
        "can_change_story_billable": true,
        "can_post": true,
        "can_edit": true,
        "restricted": true,
        "can_see_financials": true,
        "is_guest_on_project": true
      },
      "possible_approver_ids": [
        "string"
      ],
      "posts_require_privacy_decision": true,
      "price": "string",
      "price_in_cents": 0,
      "primary_counterpart_id": "string",
      "primary_maven_id": "string",
      "primary_workspace_group_id": "string",
      "provider_lead_name": "string",
      "rate_card_id": 0,
      "require_expense_approvals": true,
      "require_notes_on_time_entries": true,
      "require_time_approvals": true,
      "revenue_recognition_method_id": "string",
      "revenue_recognition_method_name": "string",
      "stage": "string",
      "start_date": "2019-08-24",
      "status": {
        "color": "string",
        "key": "string",
        "message": "string"
      },
      "status_report_ids": [
        "string"
      ],
      "stories_are_fixed_fee_by_default": true,
      "target_margin": 0.1,
      "task_status_set_id": "string",
      "task_status_set_name": "string",
      "task_statuses": [
        "string"
      ],
      "tasks_default_non_billable": true,
      "time_trackable": true,
      "timesheet_submission_ids": [
        "string"
      ],
      "title": "string",
      "total_expenses_in_cents": 0,
      "total_invoiced": "string",
      "total_minutes_approved": 0,
      "updated_at": "2019-08-24T14:15:22Z",
      "workspace_group_ids": [
        "string"
      ],
      "workspace_invoice_preference_id": 0,
      "workspace_resource_ids": [
        "string"
      ],
      "workspace_resources_with_unnamed_ids": [
        "string"
      ]
    }
  }
}