How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Mavenlink External References API

External References allows users see which objects (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`are synced with third party systems. This allows you to view the sync status of items inaddition to the integration specifics for a synced object.Objects that are synced with a third party system have external integrationattributes that include the corresponding ID of the third-party object withwhich it is synced, a link that allows you to view the object in the thirdparty system, the status of the external object in the external system,the status of the sync, and a link to exceptions.

Mavenlink External References API is one of 103 APIs that Mavenlink publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include External References. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, and rate-limit docs.

This API exposes 3 operations across 3 paths, and defines 36 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://api.mavenlink.com/api/v1.

3 operations 3 paths 36 schemas 1 DELETE1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.mavenlink.com/api/v1/
Authentication
API Key, OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 2

Mavenlink External References API declares 2 security schemes for authenticating requests. An API key is passed in the header as Bearer (BearerToken). It supports OAuth 2.0 (OauthSecurity) using the authorizationCode flow.

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 1 DELETE, 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

External References 3

External References allows users see which objects (one of Assignment, BillingMilestone, CustomField, CustomFieldChoice, CustomFieldSet, CustomFieldValue, Estimate, EstimateScenar…

GET
/external_references
Fetches all external references on a user's account
Get External References 19 params → 200400401403404422503
POST
/external_references/create_or_update
Create or update an external reference
Create Or Update External Reference 1 param body → 200400401403404422503
DELETE
/external_references/{id}
Deleting an existing External Reference
Delete External Reference 1 param → 204400401403404422503

Schemas 36

The contract defines 36 schemas that model the data the API accepts and returns. The most detailed are Workspace (88 properties), Story (70 properties), Participation (27 properties), Invoice (27 properties). Each schema is shown below with its type and property counts.

Post
object
A Post represents a message written by participants in a project that appears in the project.
24 properties
RateCard
object
A Rate Card belongs to a Rate Card Set, and represents a currency in the set. Rate Cards have many Rate Card Versions which represent the effective version of…
10 properties
SurveyQuestion
object
Survey Questions (Legacy) appear on and can be responded to through surveys. This feature requires the Legacy Surveys account add-on. This feature is unrelated…
6 properties
Error
object
2 properties
TimeEntry
object
This object allows you to manage Kantata OX time entries, depending on your permissions. Creating and updating time entries allows you to include time when inv…
25 properties
Workspace
object
Workspaces (also called projects) represent the space in which Kantata OX users plan, communicate, and collaborate.
88 properties
WorkspaceResource
object
With workspace resources it is possible for a user to have many resources with different roles within a single workspace. Workspace resource can be assigned to…
18 properties
Expense
object
Expenses are non-time related costs incurred in a project. Once created, expenses can be included in generated invoices.
26 properties
Participation
object
Participations in Kantata OX connect Users and Workspaces (projects). It includes permissions, cost rate, bill rate and role details for the participant in the…
27 properties
EstimateScenarioResource
object
An Estimate Scenario Resource is an unnamed resource in an estimate scenario.
14 properties
SurveyAnswer
object
Survey Answers (Legacy) represent a user's answer to a survey question on a survey response. This feature requires the Legacy Surveys account add-on. This feat…
7 properties
SurveyTemplate
object
Survey Templates (Legacy) define a set a questions for which survey responses can be created from. This feature requires the Legacy Surveys account add-on. Thi…
14 properties
Submission
object
Submissions contain a set of Time Entries for a specific week or Expenses for a specified time period. Submission Time Entries and Expenses must be approved be…
19 properties
StoryAllocationDay
object
Daily Scheduled Hours (Story Allocation Day) is the planned amount of time for a project resource on a specific task for a specified day. Daily Scheduled Hours…
9 properties
CustomFieldChoice
object
Custom Field Choices are possible values for single and multi type custom fields.
6 properties
Role
object
A Role represents the main position or title assigned to members on an account. Roles may be associated with account memberships, account invitations, particip…
5 properties
EstimateScenario
object
An Estimate Scenario represents a possible project configuration. It includes a rate card, budget, and associated resources and allocations.
10 properties
CustomFieldValue
object
If [Custom Fields](/tag/Custom-Fields) represent the fields themselves, Custom Field Values represent the values in/of those fields.
15 properties
Invoice
object
An Invoice is defined as a list of costs incurred during a Kantata OX project, which are billable to an end user.
27 properties
WorkspaceAllocation
object
A workspace allocation represents a resource’s allocation over a specific period of time, and is always associated with a workspace resource. Note: When an all…
13 properties
Estimate
object
An Estimate represents a potential project. Estimates allow you to plan out a project's budget, resources, and allocations through associated estimate scenario…
12 properties
CustomField
object
The [Custom Fields](https://mavenlink.zendesk.com/hc/en-us/articles/202924760-Custom-Fields-Overview-arrange) object allows you to view, create, update, and de…
12 properties
Errors
object
1 property
CustomFieldSet
object
Custom Field Sets contain custom fields and definitions of each fields' subject type. The supported subjects are currently Estimate, Project, Project Group, Re…
6 properties
Skill
object
Skills are used in Kantata OX to describe capabilities of users for the purposes of resource planning. They can be associated with a user through a Skill Membe…
7 properties
StatusReport
object
A Status Report provides a color level and description for a projects status. Referred to as Health Report in the UI.
9 properties
SurveyResponse
object
Survey Response (Legacy) represents an instance of a particular survey that has been assigned for response. This feature requires the Legacy Surveys account ad…
15 properties
ExternalReference
object
External References allows users see which objects (one of Assignment, BillingMilestone, CustomField, CustomFieldChoice, CustomFieldSet, CustomFieldValue, Esti…
14 properties
Assignment
object
An Assignment represents the relationship of a resource to a task. It owns Story Allocation Days.
10 properties
BillingMilestone
object
Billing milestones allow you to set up billable items in a project that are separate from the Task Tracker work and have invoicing rules. A set of billing mile…
12 properties
TimeOffEntry
object
A Time Off Entry represents the number of hours a specific user has scheduled off for a requested date.
6 properties
ExpenseBudget
object
Expense budgets allow you to plan for non-labor expenses.
16 properties
Vendor
object
A Vendor is an entity to which an expense can be paid.
5 properties
User
object
Users represent the individuals that are participating in Kantata OX projects. User objects are often returned as nested JSON objects within other returned ite…
20 properties
WorkspaceGroup
object
Workspace Groups (also known as groups) allow for the categorization of Kantata OX Workspaces and Users. Workspace Groups are unique to each Kantata OX Account…
13 properties
Story
object
Stories (known as [tasks](https://knowledge.kantata.com/hc/en-us/articles/202806550-Tasks-Overview) in the UI) are the tasks, deliverables, issues, and milesto…
70 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mavenlink-external-references-api-openapi.yml Raw ↑

Other APIs Mavenlink publishes across the network.

Kantata OX MCP Server
Kantata OX Developer Documentation Agent
Mavenlink Access Group Memberships API
Mavenlink Account Colors API
Mavenlink Account Invitations API
Mavenlink Account Locations API
Mavenlink Account Memberships API
Mavenlink Activations API
Mavenlink Assignments API
Mavenlink Attachments API
Mavenlink Backup Approver Associations API
Mavenlink Billable Utilizations API
Where this information came from

This is an independent, third-party profile of Mavenlink External References API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.