This endpoint returns structured Estimate 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 estimates top-level JSON key. Please see our Response Format section for more information.
Filter by a custom field choice value, represented as a string with the custom field ID, followed by a colon, and then comma-separated custom field choice value IDs. The custom field choice value can also be the word blank. Multiple custom fields can be delimited by semicolons or by parentheses and colons.
The following formats are supported:
custom_field_ID:choice_value_IDcustom_field_ID:choice_value_1_ID,choice_value_2_IDcustom_field_ID:blank(custom_field_1_ID:choice_value_1_ID,choice_value_2_ID):(custom_field_2_ID:choice_value_3_ID).
Filter by a custom field currency value, represented as a string with the custom field ID, followed by a colon, and then the currency value. Optionally, the currency ISO code can be supplied as well, separated from the currency value by another colon. Multiple custom fields can be delimited by semicolons or by parentheses and colons. The following formats are supported:
(1:200.2:USD):(2:100).
Filter by a custom field date value, represented as a string with the custom field ID, followed by a colon, the starting date, another colon, and then the ending date. You can provide both a starting date and ending date, or provide just one. Multiple custom fields can be delimited by semicolons or by parentheses and colons. The following formats are supported:
(1:2014-12-05:2014-12-25):(2:2014-12-05).
Filter by a custom field number value, represented as a string with the custom field ID, followed by a colon, and then the number value. Multiple custom fields can be delimited by semicolons or by parentheses and colons. The following formats are supported:
(1:200):(2:101).
Filter by a custom field text value, represented as a string with the custom field ID, followed by a colon, and then the text value. Multiple custom fields can be delimited by semicolons or by parentheses and colons. The following formats are supported:
(1:something):(2:else)(1:something):(1:else)(multiple values for the same field, returns objects matching any value)1(bare field ID with no value, returns all objects that have any value for that field).
Filter for records created after a specified datetime. The datetime must be in ISO 8601 format.
Filter for records created before a specified datetime. The datetime must be in ISO 8601 format.
Any of the below associations can be included in your request by providing the include param, e.g. include=association1,association2.
creator(User) - The user who created the estimate.custom_field_values(CustomFieldValue) - The value set on estimate custom fields.estimate_scenarios(EstimateScenario) - The EstimateScenarios of the estimate.external_references(ExternalReference) - Includes references to external integrations for this object.workspace(Workspace) - The Workspace that was created from the Project.workspace_group(WorkspaceGroup) - The WorkspaceGroup (client) of the estimate.
Filter for records updated after a specified datetime. The datetime must be in ISO 8601 format.
Filter for records updated before a specified datetime. The datetime must be in ISO 8601 format.
GET
curl -i -X GET \
'https://api.mavenlink.com/api/v1/estimates?by_custom_choice_value=string&by_custom_currency_value=string&by_custom_date_value=string&by_custom_number_value=string&by_custom_text_value=string&created_after=2019-08-24T14%3A15%3A22Z&created_before=2019-08-24T14%3A15%3A22Z&creator=string&external_reference_external_message=string&external_reference_external_status=string&external_reference_service_model=string&external_reference_service_model_ref=0&external_reference_service_model_refs=string&external_reference_service_name=string&external_reference_status=string&has_external_references=true&has_value_for_custom_field_ids=string&include=string&matching=string&only=string&order=name&page=1&per_page=20&updated_after=2019-08-24T14%3A15%3A22Z&updated_before=2019-08-24T14%3A15%3A22Z&with_workspace_group_ids=string&without_external_reference_service_name=string'Response
{ "count": 0, "meta": { "count": 0, "page_count": 0, "page_number": 0, "page_size": 0 }, "results": [ { "key": "string", "id": "string" } ], "estimates": { "property1": { "created_at": "2019-08-24T14:15:22Z", "creator_id": "string", "currency": "string", "custom_field_value_ids": [ "string" ], "description": "string", "estimate_scenario_ids": [ "string" ], "external_reference_ids": [ "string" ], "is_locked": true, "name": "string", "updated_at": "2019-08-24T14:15:22Z", "workspace_group_id": "string", "workspace_id": "string" }, "property2": { "created_at": "2019-08-24T14:15:22Z", "creator_id": "string", "currency": "string", "custom_field_value_ids": [ "string" ], "description": "string", "estimate_scenario_ids": [ "string" ], "external_reference_ids": [ "string" ], "is_locked": true, "name": "string", "updated_at": "2019-08-24T14:15:22Z", "workspace_group_id": "string", "workspace_id": "string" } }, "external_references": { "property1": { "created_at": "2019-08-24T14:15:22Z", "external_link": "string", "external_message": "string", "external_status": "string", "last_synced_at": "2019-08-24T14:15:22Z", "locked": true, "service_model": "string", "service_model_ref": "string", "service_name": "string", "status": "string", "subject_id": 0, "subject_ref": { "key": "string", "id": "string" }, "subject_type": "string", "updated_at": "2019-08-24T14:15:22Z" }, "property2": { "created_at": "2019-08-24T14:15:22Z", "external_link": "string", "external_message": "string", "external_status": "string", "last_synced_at": "2019-08-24T14:15:22Z", "locked": true, "service_model": "string", "service_model_ref": "string", "service_name": "string", "status": "string", "subject_id": 0, "subject_ref": { "key": "string", "id": "string" }, "subject_type": "string", "updated_at": "2019-08-24T14:15:22Z" } }, "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" ] } }, "workspace_groups": { "property1": { "address": "string", "company": true, "contact_name": "string", "created_at": "2019-08-24T14:15:22Z", "email": "string", "external_reference_ids": [ "string" ], "name": "string", "notes": "string", "phone_number": "string", "rate_card_set_ids": [ "string" ], "updated_at": "2019-08-24T14:15:22Z", "website": "string", "workspace_ids": [ "string" ] }, "property2": { "address": "string", "company": true, "contact_name": "string", "created_at": "2019-08-24T14:15:22Z", "email": "string", "external_reference_ids": [ "string" ], "name": "string", "notes": "string", "phone_number": "string", "rate_card_set_ids": [ "string" ], "updated_at": "2019-08-24T14:15:22Z", "website": "string", "workspace_ids": [ "string" ] } }, "estimate_scenarios": { "property1": { "budget_in_cents": 0, "created_at": "2019-08-24T14:15:22Z", "estimate_id": 0, "estimate_scenario_resource_ids": [ "string" ], "external_reference_ids": [ "string" ], "name": "string", "rate_card_id": "string", "start_date": "2019-08-24T14:15:22Z", "target_margin_percent": 0, "updated_at": "2019-08-24T14:15:22Z" }, "property2": { "budget_in_cents": 0, "created_at": "2019-08-24T14:15:22Z", "estimate_id": 0, "estimate_scenario_resource_ids": [ "string" ], "external_reference_ids": [ "string" ], "name": "string", "rate_card_id": "string", "start_date": "2019-08-24T14:15:22Z", "target_margin_percent": 0, "updated_at": "2019-08-24T14:15:22Z" } }, "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" ] } }, "custom_field_values": { "property1": { "account_id": 0, "can_edit": true, "created_at": "2019-08-24T14:15:22Z", "custom_field_id": "string", "custom_field_name": "string", "display_value": "string", "external_reference_ids": [ "string" ], "selected_choice_ids": [ "string" ], "setter_id": "string", "subject_id": 0, "subject_ref": { "key": "string", "id": "string" }, "subject_type": "string", "type": "string", "updated_at": "2019-08-24T14:15:22Z", "value": "string" }, "property2": { "account_id": 0, "can_edit": true, "created_at": "2019-08-24T14:15:22Z", "custom_field_id": "string", "custom_field_name": "string", "display_value": "string", "external_reference_ids": [ "string" ], "selected_choice_ids": [ "string" ], "setter_id": "string", "subject_id": 0, "subject_ref": { "key": "string", "id": "string" }, "subject_type": "string", "type": "string", "updated_at": "2019-08-24T14:15:22Z", "value": "string" } } }