Skip to main content

Minuet API endpoints required by FirstIgnite

FirstIgnite reaches your Minuet instance through an API client your Minuet administrator creates. That client can only call the endpoints in its Endpoint Access Group, so this page lists every endpoint FirstIgnite asks for, what it powers, and what stops working without it.

An endpoint is a single kind of request: "list technologies", "save a document". Your administrator grants them one at a time.

A PDF of this list for your IT team is attached at the bottom of this article. Same 42 endpoints in the same order. It uses older labels: Required there means critical here, and Recommended means important.

You don't have to do any of this by hand

The guided FirstIgnite connector grants the endpoints for you. Treat this page as a reference for what FirstIgnite reaches and why, not a list of 42 things to tick.

If you connected a while ago and a feature starts reporting missing permissions, that is the required set having grown since. Minuet shows "Required endpoints out of date" under Setup → System Settings → Third Party Services → FirstIgnite. Select Click to review & enable endpoints (on some Minuet builds, Review & enable required endpoints), check the list, then select Add. Only what's missing is added, with no reconnect. Minuet also nudges the people who can act on it when your instance falls behind. For the steps with screenshots, see Enable new FirstIgnite endpoints in Minuet.

How to read the priority column

  • Critical. A core capability stops working without it.

  • Important. One feature is lost or degraded, and the rest keeps running.

FirstIgnite's setup screen shows the same list against your instance, grouped by the Minuet controller each endpoint sits under, with a Copy endpoint list button and a count of what is still missing. When you are setting up, work from that screen.

Version requirements

The integration needs Minuet 20.0101 or newer. If you're on an older version, ask Inteum to upgrade you before you start. Two capabilities have their own floor on top of that:

  • Attaching recipients to a logged email needs 20.0203 or newer. Below that FirstIgnite writes the recipients into the body of the remark instead, so nothing is lost. They just don't appear on the Recipients tab.

  • Listing files attached to remarks, emails and activities in the document picker needs 20.1010 or newer. Below that, the picker lists files from the technology, its disclosures and its patents only.

Everything else works on any build that exposes the endpoint.

One endpoint FirstIgnite calls is deliberately not on this list: GET /api/getapiversion. Older builds don't expose it, and from 20.0501 it is always accessible with no checkbox at all, so there is nothing to grant. If FirstIgnite can't read it, no Minuet version is shown and any feature with a version floor falls back to its older behaviour. In practice that means recipients go into the body of a logged remark rather than onto the Recipients tab.

Portfolio, patents and documents

These 19 endpoints are the baseline. They cover browsing your technologies, opening a technology, reading its related records, and exchanging documents.

Method

Path

Find in Minuet

What it does

Priority

Without it

POST

/api/technologies

Technology

List technologies

Critical

The portfolio doesn't load

GET

/api/technology/{key}

Technology

Open one technology

Critical

Technology pages can't open

POST

/api/technology

Technology

Write a summary back

Critical

Summary sync is unavailable. Everything else works, so leave this one out if you don't want FirstIgnite writing to your technologies

GET

/api/technology/udf

Technology

Read custom-field labels

Important

Custom fields show generic labels

POST

/api/technology/{key}/categories

Technology

Read categories

Important

Categories are missing

POST

/api/technology/{key}/interests

Technology

Read keywords and interests

Important

Keyword information is missing

POST

/api/technology/{key}/owners

Technology

Read owners

Important

The owners card is empty

POST

/api/technology/{key}/inventors

Technology

Read and link inventors

Important

Inventor cards are missing or unlinked

POST

/api/contacts

Contact

Look up contacts

Important

Inventor links and contact matching don't work

POST

/api/technology/{key}/patents

Technology

Read the technology's patents

Important

The patents tab is empty

POST

/api/technology/{key}/grantsawards

Technology

Read grants and awards

Important

Grant details are missing, and so is the grant section of an AI summary

POST

/api/grantaward/{key}/technologies

GrantAward

Read award amounts

Important

Award amounts are missing

POST

/api/patents

Patent

List patents

Critical

Patent listing is unavailable

POST

/api/documents

Document

Search documents

Critical

Document search is unavailable

POST

/api/disclosures

Disclosure

Find a technology's disclosure identifier so its documents can be listed for selection

Important

The document picker's Disclosure tab can't list files

POST

/api/remarks

Remark

Read activity and remarks, and find remark and email attachments for the document picker

Important

The activity feed is empty, and remark and email attachments aren't listed in the picker

POST

/api/document

Document

Save a document

Important

Uploading files to Minuet is disabled

GET

/api/downloadfile/{actionID}

File

Download a document

Critical

Document download is disabled

POST

/api/getmanagedlistdata/{name}

Lists

Read managed lists

Important

Some statuses and labels don't resolve to names

Reading your CRM data

These endpoints power the Minuet panel: Marketing Projects and Targets, the activity feed, agreements, and the check that tells you whether a company or person is already in Minuet.

Prefer to watch? Here's a short video on enabling the Minuet CRM endpoints in FirstIgnite. It has no audio.

Method

Path

Find in Minuet

What it does

Priority

Without it

POST

/api/marketingprojects

MarketingProject

List Marketing Projects

Critical

The project list is empty

GET

/api/marketingproject/{key}

MarketingProject

Open a Marketing Project

Critical

Project details can't open

POST

/api/marketingproject/{key}/technologies

MarketingProject

Read a project's technologies

Important

Linked technologies aren't shown

POST

/api/technology/{key}/marketingprojects

Technology

Read a technology's projects

Important

Project links are missing, and email logging can't pick a Marketing Target automatically

POST

/api/marketingtargets

MarketingTarget

List Marketing Targets

Critical

The targets list is empty

GET

/api/marketingtarget/{key}

MarketingTarget

Open a Marketing Target

Important

Target details can't open

GET

/api/remark/{key}

Remark

Open one remark

Important

Full remark text is unavailable

POST

/api/remark/{key}/recipients

Remark

Read a remark's recipients

Critical

Recipient information is missing

POST

/api/companies

Company

Search companies

Critical

Company matching and sending companies to Minuet don't work

GET

/api/company/{key}

Company

Open a company

Important

Company details are missing

GET

/api/contact/{key}

Contact

Open a contact

Important

Contact details are missing

POST

/api/agreements

Agreement

Read agreements

Important

The agreements list is unavailable

POST

/api/company/{key}/agreements

Company

Read a company's agreements

Important

Company agreements aren't shown

POST

/api/contact/{key}/agreements

Contact

Read a contact's agreements

Important

Contact agreements aren't shown

Writing results back

Method

Path

Find in Minuet

What it does

Priority

Without it

POST

/api/marketingtarget

MarketingTarget

Create a Marketing Target

Critical

Targets can't be created from FirstIgnite

POST

/api/company

Company

Create or update a company

Critical

Creating companies, and syncing enrichment onto them, are disabled

POST

/api/contact

Contact

Create or update a contact

Critical

Creating contacts, and syncing enrichment onto them, are disabled

POST

/api/contact/saveconteml

Contact

Save a contact's email address

Important

New contacts are created without an email address

GET

/api/company/udf

Company

Read company custom fields

Important

Custom and image fields aren't written

GET

/api/contact/udf

Contact

Read contact custom fields

Important

Custom and image fields aren't written

POST

/api/remark

Remark

Log an email or activity

Critical

Activity logging is disabled

POST

/api/setentity

General

Attach recipients to a remark (needs Minuet 20.0203+)

Important

Recipients stay in the body of the remark

POST

/api/contact/{key}/emails

Contact

Find a recipient's email record

Important

Recipient attachment falls back to the body of the remark

The list grows

FirstIgnite publishes this set to Minuet, so a new connection picks up the current list automatically. It expands as FirstIgnite ships features, which means a connection set up a year ago will eventually be short a few grants.

The symptom is a feature reporting missing permissions while the connection is otherwise healthy. Minuet shows "Required endpoints out of date" under Setup → System Settings → Third Party Services → FirstIgnite. Select Click to review & enable endpoints (on some Minuet builds, Review & enable required endpoints), check the list, then select Add. For the steps with screenshots, see Enable new FirstIgnite endpoints in Minuet. You can also re-test the connection in FirstIgnite under Minuet Settings (depending on your location, app.firstignite.com/inteum/settings or eu.firstignite.com/inteum/settings), but you don't need to.

Inteum occasionally removes an endpoint from that screen because they have made it always available. If something on this page has no checkbox in your instance, it has almost certainly been granted automatically. There is nothing for you to do.

Ticking the box is not the same as having the permission

The Endpoint Access Group decides which calls the client may make. What those calls return is decided by the Minuet user the client runs as. The two are independent, and FirstIgnite's connection test only checks the first. It reads the list of endpoints Minuet reports as accessible and compares it against what it needs. It does not call them.

So a connection can report every endpoint verified and still come back empty, because the user behind the client can't see those records. It has happened at more than one institution, and in each case the fix was on the Minuet user's own permissions, not on the access group.

If a feature returns nothing while the connection looks healthy, have your Minuet administrator check the user's record permissions first. A missing permission on one column is enough to empty a whole list, because Minuet rejects the entire request rather than dropping the column. Troubleshooting the Minuet integration names the field to check first.

Did this answer your question?