KAkantata
External References

Fetches all external references on a user's account

Returns external references, for objects of particular types, that are synced with the third-party systems.

This endpoint returns structured External Reference 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 external_references top-level JSON key. Please see our Response Format section for more information.

get/external_references

Request

  • Base URL
    https://api.mavenlink.com/api/v1
  • Auth
    none declared

Query parameters

subject_typestring required

The type of the Kantata OX object that has the external reference. One of Assignment, BillingMilestone, CustomField, CustomFieldChoice, CustomFieldSet, CustomFieldValue, Estimate, EstimateScenario, EstimateScenarioResource, Expense, ExpenseBudget, Invoice, Participation, Post, RateCard, Role, Skill, StatusReport, Story, StoryAllocationDay, Submission, SurveyAnswer, SurveyQuestion, SurveyResponse, SurveyTemplate, TimeEntry, TimeOffEntry, User, Vendor, Workspace, WorkspaceAllocation, WorkspaceGroup, or WorkspaceResource.

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.

external_messagestring

Only include external references with the specified external message.

external_statusstring

The status of the external object in the external system.

includestring

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

  • subject (polymorphic) - The item with which the external reference is associated.
last_synced_afterstring date-time

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

last_synced_beforestring date-time

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

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, created_at:desc, last_synced_at:asc, and last_synced_at:desc.

pageinteger
per_pageinteger
service_modelstring

The type of the external object.

service_model_refstring

The object ID of an external object.

service_namestring

The provider name of the integration.

statusstring

The status of the integration. Options are 'pending', 'successful', or 'failed'.

subject_idinteger

The ID of the Kantata OX object that has the external reference.

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.

Response

A list of External References have been retrieved.

countinteger
external_referencesobject
assignmentsobject
billing_milestonesobject
custom_fieldsobject
custom_field_choicesobject
custom_field_setsobject
custom_field_valuesobject
estimatesobject
estimate_scenariosobject
estimate_scenario_resourcesobject
expensesobject
expense_budgetsobject
invoicesobject
participationsobject
postsobject
rate_cardsobject
rolesobject
skillsobject
status_reportsobject
storiesobject
story_allocation_daysobject
submissionsobject
survey_answersobject
survey_questionsobject
survey_responsesobject
survey_templatesobject
time_entriesobject
time_off_entriesobject
usersobject
vendorsobject
workspacesobject
workspace_allocationsobject
workspace_groupsobject
workspace_resourcesobject

Changes

No recorded changes to this operation across all 1 revision of this API.