Skip to main content
API docs by Redocly

server (4.66.0)

Download OpenAPI specification:Download

The new StartupFlow API

Applications

Endpoints to create a new application (startup, project, company, ...) to be processed in the Application Tracking System.

Get Reference Data Deprecated

Get reference data to creating a new application. List of all valid values for fundraising_stage, nb_employees and geographic_markets.

(Deprecated: Please use the ApplicationForms endpoints instead)

Scope

To use this endpoint ApiKey object must have this scope: public:applications

Authorizations:
api_key_applications

Responses

Response samples

Content type
{
  • "fundraising_stage": [
    ],
  • "nb_employees": [
    ],
  • "tags": [
    ],
  • "geographic_markets": [
    ]
}

Create Application Deprecated

Create a new application to be processed in the ATS.

(Deprecated: Please use the ApplicationForms endpoints instead)

Scope

To use this endpoint ApiKey object must have this scope: public:applications

Authorizations:
api_key_applications
Request Body schema:
required
name
required
string
website
string
logo_url
string
short_description
string
full_description
string
tags
Array of strings
creation_date
string
nb_employees
string
fundraising_stage
string
hq_address
string
Array of objects
documents
Array of strings
links
Array of strings
business_model
string
geographic_markets
Array of strings
competitors
string
killer_argument
string
corporate_collaborated
string
service
string
corporate_department
string
object
referal
string
is_corporate_client
string
team_argument
string
market
string
total_funding_usd
number <double>
notes
Array of strings

Responses

Request samples

Content type
{
  • "name": "Startup Flow",
  • "website": "https://startupflow.io",
  • "logo_url": "https://assets.startupflow.io/documents/sflow.png",
  • "short_description": "Startup Flow is a decision-support software for Open-Innovation",
  • "full_description": "A SaaS platform with 3 sides : an innovation CRM, a knowledge sharing system and a metrics dashboard. The product is build with a great UI & UX to drive usage by all people within the group.",
  • "tags": [
    ],
  • "creation_date": "December 2008",
  • "nb_employees": "1 - 10",
  • "fundraising_stage": "seed",
  • "hq_address": "2 rue de mulhouse 75002 Paris",
  • "contacts": [],
  • "documents": [],
  • "links": [],
  • "business_model": "A monthly license for an unlimited number of users",
  • "geographic_markets": [
    ],
  • "competitors": "Yoomap, Hype, Braineet",
  • "killer_argument": "Chouquettes management",
  • "corporate_collaborated": "Not yet",
  • "service": "We think our product can make you save money and optimize your deliveries",
  • "corporate_department": "We want to work with your Innovation department",
  • "corporate_contact": {
    },
  • "referal": "string",
  • "is_corporate_client": "Yes",
  • "team_argument": "Our team is brilliant \\o/",
  • "market": "string",
  • "total_funding_usd": "400000",
  • "notes": [
    ]
}

Response samples

Content type
{
  • "id": "5da97ee3d5d9fe6b42caebb1",
  • "status": "pendingATSValidation"
}

ApplicationForms

Endpoints to list ApplicationForms and create a new application to be processed in the Application Tracking System.

List ApplicationForms

Retrieve the list of all ApplicationForms. This endpoint is not paginated.

Scope

To use this endpoint ApiKey object must have this scope: public:applications

Authorizations:
api_key_applications

Responses

Response samples

Content type
[]

Get Reference Data

Get reference data to create a new application. List of all fields and value available.

Note: The first contact object in the contacts array will be the main contact, he will receive contact emails. You can setup the language of email by setting the activeLang attribute of the contact object with the value FR or EN. c.f. Create Application example.

Scope

To use this endpoint ApiKey object must have this scope: public:applications

Authorizations:
api_key_applications
path Parameters
applicationFormId
required
string

[required] ApplicationForm id

Responses

Response samples

Content type
{
  • "logo": {
    },
  • "name": {
    },
  • "website": {
    },
  • "pitch": {
    },
  • "description": {
    },
  • "year_founded": {
    },
  • "hq_city": {
    },
  • "hq_countryId": {
    },
  • "nb_employees": {
    },
  • "maturity": {
    },
  • "tagIds": {
    },
  • "contacts": {
    },
  • "video_urls": {
    },
  • "press": {
    },
  • "business_model": {
    },
  • "marketIds": {
    },
  • "competitors": {
    },
  • "note_collaboration": {
    },
  • "internal_contacts": {
    },
  • "note_service": {
    },
  • "note_department": {
    }
}

Create Application

Create a new application for the given ApplicationForm. Application will be available in the ATS (Application portal). Check the reference data endpoint to get the list of all fields and value available.

Note: The first contact object in the contacts array will be the main contact, he will receive contact emails. You can setup the language of email by setting the activeLang attribute of the contact object with the value FR or EN.

Scope

To use this endpoint ApiKey object must have this scope: public:applications

Authorizations:
api_key_applications
path Parameters
applicationFormId
required
string

[required] ApplicationForm id

Request Body schema:
required
logo
string
name
string
website
string
pitch
string
description
string
year_founded
string
hq_city
string
hq_countryId
string
nb_employees
string
maturity
string
Array of objects
Array of objects
documents
Array of strings
video_urls
Array of strings
press
Array of strings
business_model
string
marketIds
Array of strings
competitors
string
note_collaboration
string
Array of objects
note_service
string
note_department
string

Responses

Request samples

Content type
{}

Response samples

Content type
{
  • "id": "5da97ee3d5d9fe6b42caebb1",
  • "status": "submitted"
}

Items

Endpoints to search, retrieve, create and update items.

Get Reference Data

Get reference data to create an item. Containing all valid values for typology, fundraising_stage, nb_employees and geographic_markets.

Scope

To use this endpoint ApiKey object must have this scope: public:items

Authorizations:
api_key_items

Responses

Response samples

Content type
{
  • "typologies": [
    ],
  • "custom_fields": [
    ],
  • "fundraising_stage": [
    ],
  • "nb_employees": [
    ],
  • "tags": [
    ],
  • "geographic_markets": [
    ]
}

List Items

Retrieves a list of items. Result can be filtered by term, tags, labels, sources and by updated date.

Number of result returned can be handled by limit and offset parameters.

Results can be ordered thanks to the sort parameter.

Scope

To use this endpoint ApiKey object must have this scope: public:items:* (all typologies) or public:items:startup,events,typology_id (specific typologies) Note You can add the http verb "get" in front of the scope to limit access to readonly endpoints. get@public:item:*

Authorizations:
api_key_items
query Parameters
typology
required
string <JSON>

[required] The typology to search for. Could be either a string (e.g. startup) or a JSON array (e.g. ["startup", "event"])

term
string

[optional] Term filter

fields
string <JSON>

[optional] Fields to match term with (default: term match on name, tags, pitch and description fields) e.g: ["website","tags"]

tags
string <JSON>

[optional] Tag ids filter. Should be a JSON array. Check reference_data endpoint to list availabe tag ids

labels
string <JSON>

[optional] Labels filter. Should be a JSON array. Check reference_data endpoint to list availabe label ids

sources
string <JSON>

[optional] Sources filter. Should be a JSON array. Check reference_data endpoint to list availabe source ids

updated_at_gt
string <date-time>

[optional] Minimum date filter

updated_at_lt
string <date-time>

[optional] Maximum date filter

limit
number <double> <= 1000
Default: 20

[optional] The number of items to retrieve. (maximum limit 1000)

offset
number <double>
Default: 0

[optional] The offset of the first hit to return

sort
string
Default: "relevance"
Enum: "created_at_desc" "created_at_asc" "updated_at_desc" "updated_at_asc" "relevance"

[optional] Parameter to sort result

withProcesses
boolean
Default: false

The flag to enable processes in the result (default: false)

Responses

Response samples

Content type
{
  • "total": 32,
  • "results": [
    ]
}

Create Item

Create an item object.

CAUTION soft UPSERT behavior: If the item exists (matching existing item with exact name or exact website), it will update empty field of existing item with data.

Scope

To use this endpoint ApiKey object must have this scope: public:items:* (all typologies) or public:items:startup,events,typology_id (specific typologies) Note You can add the http verb "get" in front of the scope to limit access to readonly endpoints. get@public:item:*

Authorizations:
api_key_items
query Parameters
context
string

The context of the item (could be blank or 'sync')

Request Body schema:
required
typologyId
string
name
string
website
string
logo_url
string
short_description
string
full_description
string
object
object
object
year_founded
string
etablissement_year_founded
string
nb_employees
string
maturity
string
object
Array of objects
Array of objects
object
press_urls
Array of strings
video_urls
Array of strings
market_ids
string
total_funding_usd
string
business_model
string
painpoints
string
business_opportunity
string
sustainability
string
success_proofs
string
risks
string
key_differentiators
string
competitors
string
Array of objects

Responses

Request samples

Content type
{
  • "typologyId": "startup",
  • "name": "Microsoft",
  • "website": "http://www.microsoft.com",
  • "logo_url": "https://assets.startupflow.io/documents/sflow.png",
  • "short_description": "Microsoft is a software corporation that develops, manufactures, licenses, supports, and sells a range of software products and services.",
  • "full_description": "Microsoft is an American multinational corporation that develops, manufactures, licenses, supports, and sells a range of software products and services.",
  • "tags": [
    ],
  • "labels": [
    ],
  • "sources": [
    ],
  • "year_founded": "1975",
  • "etablissement_year_founded": "1975",
  • "nb_employees": "200 +",
  • "maturity": "ipo",
  • "hq": {
    },
  • "internal_contacts": [
    ],
  • "external_contacts": [
    ],
  • "links": {},
  • "press_urls": [],
  • "video_urls": [],
  • "market_ids": [
    ],
  • "total_funding_usd": "1000000",
  • "business_model": "Microsoft business model",
  • "painpoints": "My pain point",
  • "business_opportunity": "My business opportunity",
  • "sustainability": "Does Microsoft fit our criterias for sustainability",
  • "success_proofs": "Success proofs of my collaboration with Microsoft",
  • "risks": "What could go wrong with Microsoft",
  • "key_differentiators": "Microsoft key differentiators",
  • "competitors": "Microsoft main competitors",
  • "custom_fields": [
    ]
}

Response samples

Content type
{
  • "id": "62d943ee03b2e60013022971",
  • "name": "Microsoft",
  • "action": "create",
  • "created_at": "2022-07-21T12:17:50.942Z"
}

Get Item

Retrieve a specific item by id.

Scope

To use this endpoint ApiKey object must have this scope: public:items:* (all typologies) or public:items:startup,events,typology_id (specific typologies) Note You can add the http verb "get" in front of the scope to limit access to readonly endpoints. get@public:item:*

Authorizations:
api_key_items
path Parameters
itemId
required
string

[required] Item id

query Parameters
withProcesses
boolean
Default: false

The flag to enable processes in the result (default: false)

withSpecializedFinancialTable
boolean
Default: false

The flag to enable specialized financial table in the result (default: false)

Responses

Response samples

Content type
{
  • "id": "6308bdf9f541ef0013001f6e",
  • "name": "Microsoft",
  • "short_description": "Microsoft is a software corporation that develops, manufactures, licenses, supports, and sells a range of software products and services.",
  • "full_description": "Microsoft is an American multinational corporation that develops, manufactures, licenses, supports, and sells a range of software products and services.\n\nMicrosoft’s devices and consumer (D&C) licensing segment...",
  • "website": "http://www.microsoft.com",
  • "startupflow_url": "http://localhost:4200/company/6308bdf9f541ef0013001f6e",
  • "logo_url": "https://images.startupflow.io/smach.startupflow.smach.files/1664891669854ypg7mliwmzomf9fdrkvz.png",
  • "year_founded": "1975",
  • "nb_employees": "200 +",
  • "maturity": "ipo",
  • "hq": {
    },
  • "typology_id": "startup",
  • "folder_id": "startup",
  • "tags": [
    ],
  • "labels": [
    ],
  • "sources": [
    ],
  • "workflows": [
    ],
  • "business_model": "Microsoft business model",
  • "painpoints": "My pain point",
  • "business_opportunity": "My business opportunity",
  • "sustainability": "Does Microsoft fit our criterias for sustainability",
  • "success_proofs": "Success proofs of my collaboration with Microsoft",
  • "risks": "What could go wrong with Microsoft",
  • "key_differentiators": "Microsoft key differentiators",
  • "competitors": "Microsoft main competitors",
  • "market_ids": [
    ],
  • "scoring_value": 4,
  • "scoring_summary": "My evaluation",
  • "scoring_detail": null,
  • "links": {},
  • "press_urls": [],
  • "internal_contacts": [
    ],
  • "external_contacts": [
    ],
  • "related_items": [
    ],
  • "custom_fields": null,
  • "created_at": "2022-08-26T12:35:05.588Z",
  • "updated_at": "2022-10-04T13:58:44.043Z",
  • "fundings": [
    ]
}

Update an Item

Update an item object.

CAUTION:

  • Will replace all fields of the item with the data provided.
  • Data provided should provide all required fields.

Scope

To use this endpoint ApiKey object must have this scope: public:items:* (all typologies) or public:items:startup,events,typology_id (specific typologies) Note You can add the http verb "get" in front of the scope to limit access to readonly endpoints. get@public:item:*

Authorizations:
api_key_items
path Parameters
itemId
required
string

[required] Item id to update

query Parameters
context
string

The context of the item (could be blank or 'sync')

Request Body schema:
required
typologyId
string
name
string
website
string
logo_url
string
short_description
string
full_description
string
object
object
object
year_founded
string
etablissement_year_founded
string
nb_employees
string
maturity
string
object
Array of objects
Array of objects
object
press_urls
Array of strings
video_urls
Array of strings
market_ids
string
total_funding_usd
string
business_model
string
painpoints
string
business_opportunity
string
sustainability
string
success_proofs
string
risks
string
key_differentiators
string
competitors
string
Array of objects

Responses

Request samples

Content type
{
  • "typologyId": "startup",
  • "name": "Microsoft",
  • "website": "http://www.microsoft.com",
  • "logo_url": "https://assets.startupflow.io/documents/sflow.png",
  • "short_description": "Microsoft is a software corporation that develops, manufactures, licenses, supports, and sells a range of software products and services.",
  • "full_description": "Microsoft is an American multinational corporation that develops, manufactures, licenses, supports, and sells a range of software products and services.",
  • "tags": [
    ],
  • "labels": [
    ],
  • "sources": [
    ],
  • "year_founded": "1975",
  • "etablissement_year_founded": "1975",
  • "nb_employees": "200 +",
  • "maturity": "ipo",
  • "hq": {
    },
  • "internal_contacts": [
    ],
  • "external_contacts": [
    ],
  • "links": {},
  • "press_urls": [],
  • "video_urls": [],
  • "market_ids": [
    ],
  • "total_funding_usd": "1000000",
  • "business_model": "Microsoft business model",
  • "painpoints": "My pain point",
  • "business_opportunity": "My business opportunity",
  • "sustainability": "Does Microsoft fit our criterias for sustainability",
  • "success_proofs": "Success proofs of my collaboration with Microsoft",
  • "risks": "What could go wrong with Microsoft",
  • "key_differentiators": "Microsoft key differentiators",
  • "competitors": "Microsoft main competitors",
  • "custom_fields": [
    ]
}

Response samples

Content type
{
  • "id": "6308bdf9f541ef0013001f6e",
  • "name": "Microsoft",
  • "short_description": "Microsoft is a software corporation that develops, manufactures, licenses, supports, and sells a range of software products and services.",
  • "full_description": "Microsoft is an American multinational corporation that develops, manufactures, licenses, supports, and sells a range of software products and services.\n\nMicrosoft’s devices and consumer (D&C) licensing segment...",
  • "website": "http://www.microsoft.com",
  • "startupflow_url": "http://localhost:4200/company/6308bdf9f541ef0013001f6e",
  • "logo_url": "https://images.startupflow.io/smach.startupflow.smach.files/1664891669854ypg7mliwmzomf9fdrkvz.png",
  • "year_founded": "1975",
  • "nb_employees": "200 +",
  • "maturity": "ipo",
  • "hq": {
    },
  • "typology_id": "startup",
  • "folder_id": "startup",
  • "tags": [
    ],
  • "labels": [
    ],
  • "sources": [
    ],
  • "workflows": [
    ],
  • "business_model": "Microsoft business model",
  • "painpoints": "My pain point",
  • "business_opportunity": "My business opportunity",
  • "sustainability": "Does Microsoft fit our criterias for sustainability",
  • "success_proofs": "Success proofs of my collaboration with Microsoft",
  • "risks": "What could go wrong with Microsoft",
  • "key_differentiators": "Microsoft key differentiators",
  • "competitors": "Microsoft main competitors",
  • "market_ids": [
    ],
  • "scoring_value": 4,
  • "scoring_summary": "My evaluation",
  • "scoring_detail": null,
  • "links": {},
  • "press_urls": [],
  • "internal_contacts": [
    ],
  • "external_contacts": [
    ],
  • "related_items": [
    ],
  • "custom_fields": null,
  • "created_at": "2022-08-26T12:35:05.588Z",
  • "updated_at": "2022-10-04T13:58:44.043Z",
  • "fundings": [
    ]
}

Items > Workflows

Endpoints to handle item workflows.

Get Workflow Reference Data

Get reference data to create/update a workflow.

Scope

To use this endpoint ApiKey object must have this scope: public:items:* (all typologies) or public:items:startup,events,typology_id (specific typologies) Note You can add the http verb "get" in front of the scope to limit access to readonly endpoints. get@public:item:*

Authorizations:
api_key_items

Responses

Response samples

Content type
{
  • "states": [
    ],
  • "typologies": [
    ]
}

List Workflows

List all workflows of current item.

Scope

To use this endpoint ApiKey object must have this scope: public:items:* (all typologies) or public:items:startup,events,typology_id (specific typologies) Note You can add the http verb "get" in front of the scope to limit access to readonly endpoints. get@public:item:*

Authorizations:
api_key_items
path Parameters
itemId
required
string

[required] Item id

Responses

Response samples

Content type
[
  • {
    }
]

Get Workflow

Get a specific workflow.

Scope

To use this endpoint ApiKey object must have this scope: public:items:* (all typologies) or public:items:startup,events,typology_id (specific typologies) Note You can add the http verb "get" in front of the scope to limit access to readonly endpoints. get@public:item:*

Authorizations:
api_key_items
path Parameters
itemId
required
string

[required] Item id

workflowId
required
string

[required] Workflow id to get

Responses

Response samples

Content type
{
  • "id": "5f7b50dc7b8792030dd93a1a",
  • "date": "2023-06-15T14:46:46.000Z",
  • "current_status": {
    },
  • "current_state": {
    },
  • "states": [
    ],
  • "status": [
    ],
  • "groups": [
    ]
}

Create Workflow State

Add a state to a workflow.

Scope

To use this endpoint ApiKey object must have this scope: public:items:* (all typologies) or public:items:startup,events,typology_id (specific typologies) Note You can add the http verb "get" in front of the scope to limit access to readonly endpoints. get@public:item:*

Authorizations:
api_key_items
path Parameters
itemId
required
string

[required] Item id

workflowId
required
string

[required] Workflow id to get

Request Body schema:
required

[required] A workflow state object

id
string
reason
string

Responses

Request samples

Content type
{
  • "id": "in_progress",
  • "reason": "My reason"
}

Response samples

Content type
{
  • "id": "in_progress",
  • "name": "In progress",
  • "date": "2023-06-15T14:47:09.319Z"
}

Create Workflow Status

Add a status to a workflow.

Scope

To use this endpoint ApiKey object must have this scope: public:items:* (all typologies) or public:items:startup,events,typology_id (specific typologies) Note You can add the http verb "get" in front of the scope to limit access to readonly endpoints. get@public:item:*

Authorizations:
api_key_items
path Parameters
itemId
required
string

[required] Item id

workflowId
required
string

[required] Workflow id to get

Request Body schema:
required

[required] A workflow status object

id
string
comment
string
date
string

Responses

Request samples

Content type
{
  • "id": "5f7b50dc7b8792030dd93a1b",
  • "comment": "My comment",
  • "date": "2023-08-24T13:53:46.123Z"
}

Response samples

Content type
{
  • "id": "5f7b50dc7b8792030dd93a1b",
  • "name": "Identification",
  • "date": "2023-06-15T14:46:46.000Z",
  • "comment": "My comment",
  • "milestones": [
    ]
}

Get Workflow Status

Get a specific workflow status.

Scope

To use this endpoint ApiKey object must have this scope: public:items:* (all typologies) or public:items:startup,events,typology_id (specific typologies) Note You can add the http verb "get" in front of the scope to limit access to readonly endpoints. get@public:item:*

Authorizations:
api_key_items
path Parameters
itemId
required
string

[required] Item id

workflowId
required
string

[required] Workflow id to get

statusId
required
string

[required] Status id to get

Responses

Response samples

Content type
{
  • "id": "5f7b50dc7b8792030dd93a1b",
  • "name": "Identification",
  • "date": "2023-06-15T14:46:46.000Z",
  • "comment": "My comment",
  • "milestones": [
    ]
}

Update Workflow Status

UPdate a specific workflow status.

Scope

To use this endpoint ApiKey object must have this scope: public:items:* (all typologies) or public:items:startup,events,typology_id (specific typologies) Note You can add the http verb "get" in front of the scope to limit access to readonly endpoints. get@public:item:*

Authorizations:
api_key_items
path Parameters
itemId
required
string

[required] Item id

workflowId
required
string

[required] Workflow id to get

statusId
required
string

[required] Status id to get

Request Body schema:
required

[required] A workflow status object

comment
string
date
DateString
milestones
Array

Responses

Request samples

Content type
{
  • "comment": "My comment",
  • "date": "2023-08-24T13:53:46.123Z",
  • "milestones": [
    ]
}

Response samples

Content type
[
  • {
    }
]

Items > Ecosystem

Endpoints to handle item ecosystem.

Get Ecosystem Reference Data

Get reference data to create an ecosystem relation.

Scope

To use this endpoint ApiKey object must have this scope: public:items:* (all typologies) or public:items:startup,events,typology_id (specific typologies) Note You can add the http verb "get" in front of the scope to limit access to readonly endpoints. get@public:item:*

Authorizations:
api_key_items

Responses

Response samples

Content type
[
  • {
    }
]

Create Relation

Create a relation between two items.

Scope

To use this endpoint ApiKey object must have this scope: public:items:* (all typologies) or public:items:startup,events,typology_id (specific typologies) Note You can add the http verb "get" in front of the scope to limit access to readonly endpoints. get@public:item:*

Authorizations:
api_key_items
path Parameters
itemId
required
string

[required] Item id

Request Body schema:
required
targetId
string
relationTypeId
string
content
string

Responses

Request samples

Content type
{
  • "targetId": "62d943ee03b2e60013022971",
  • "relationTypeId": "62d943ee03b2e60013022973",
  • "content": "Lorem Ipsum Dolor sit amet"
}

Response samples

Content type
{
  • "id": "62d9705552a73e0013508e37",
  • "originId": "62d943ee03b2e60013022971",
  • "origin": {
    },
  • "targetId": "62d943ee03b2e60013022972",
  • "target": {
    },
  • "relationTypeId": "62d943ee03b2e60013022973",
  • "relationType": {
    },
  • "content": "Lorem Ipsum Dolor sit amet",
  • "created_by": "58b455c9bb409cd8419f48ad",
  • "updated_by": "58b455c9bb409cd8419f48ad",
  • "created_at": "2022-07-21T15:34:25.877Z",
  • "updated_at": "2022-07-21T15:34:25.877Z"
}

List Relations

List all relations of an item.

Scope

To use this endpoint ApiKey object must have this scope: public:items:* (all typologies) or public:items:startup,events,typology_id (specific typologies) Note You can add the http verb "get" in front of the scope to limit access to readonly endpoints. get@public:item:*

Authorizations:
api_key_items
path Parameters
itemId
required
string

[required] Item id

Responses

Response samples

Content type
[
  • {
    }
]

Get Relation

Get a specific relation between two items.

Scope

To use this endpoint ApiKey object must have this scope: public:items:* (all typologies) or public:items:startup,events,typology_id (specific typologies) Note You can add the http verb "get" in front of the scope to limit access to readonly endpoints. get@public:item:*

Authorizations:
api_key_items
path Parameters
itemId
required
string

[required] Item id

relationId
required
string

[required] Relation id to get

Responses

Response samples

Content type
[
  • {
    }
]

Delete Relation

Delete a specific relation between two items.

Scope

To use this endpoint ApiKey object must have this scope: public:items:* (all typologies) or public:items:startup,events,typology_id (specific typologies) Note You can add the http verb "get" in front of the scope to limit access to readonly endpoints. get@public:item:*

Authorizations:
api_key_items
path Parameters
itemId
required
string

[required] Item id

relationId
required
string

[required] Relation id to get

Responses

Response samples

Content type
[
  • {
    }
]

Items > Documents

Endpoints to list and create documents link to an item.

Create Document

Add a document to an item.

Two ways to add a document:

  • FILE MODE : Upload a file using multipart/form-data (header must be "Content-Type: multipart/form-data")
  • URL MODE : Provide an url to an external file

Check parameters to see how to use each mode.

Scope

To use this endpoint ApiKey object must have this scope: public:items:* (all typologies) or public:items:startup,events,typology_id (specific typologies) Note You can add the http verb "get" in front of the scope to limit access to readonly endpoints. get@public:item:*

Authorizations:
api_key_items
path Parameters
itemId
required
string

[required] Innovation provider id

query Parameters
url
string

[URL MODE] The url of the document

url_file_name
string

[URL MODE] The file name for the document

image
boolean
Default: false

[FILE MODE] Is file an image?

file_name
string

[FILE MODE] The file name ot the document to upload (if not set, will use the original file name)

Request Body schema: application/x-www-form-urlencoded
file
string <binary>

File to upload

Responses

Response samples

Content type
{
  • "id": "62d9705552a73e0013508e37",
  • "name": "financial-q1.ppt",
  • "url": "{{host}}/api/S3/documents/1658417236368-financial-q1.ppt?url_expires=1658503748&url_sig=264d499836bb65e24365afae1ae47bea2afeebe3e58a52c940ba4183ccb4a503",
  • "type": "company-document-file",
  • "size": 443589,
  • "pinned": false,
  • "isExternal": false,
  • "format": "application/vnd.ms-powerpoint",
  • "companyId": "62d943ee03b2e60013022971",
  • "created_by": "58b455c9bb409cd8419f48ad",
  • "updated_by": "58b455c9bb409cd8419f48ad",
  • "created_at": "2022-07-21T15:27:17.740Z",
  • "updated_at": "2022-07-21T15:27:17.740Z"
}

List Documents

List all documents linked to an item.

Scope

To use this endpoint ApiKey object must have this scope: public:items:* (all typologies) or public:items:startup,events,typology_id (specific typologies) Note You can add the http verb "get" in front of the scope to limit access to readonly endpoints. get@public:item:*

Authorizations:
api_key_items
path Parameters
itemId
required
string

[required] Item id

Responses

Response samples

Content type
[
  • {
    }
]

Items > Notes

Endpoints to list, create and update notes link to an item.

Create Note

Create a note linked to an item.

Scope

To use this endpoint ApiKey object must have this scope: public:items:* (all typologies) or public:items:startup,events,typology_id (specific typologies) Note You can add the http verb "get" in front of the scope to limit access to readonly endpoints. get@public:item:*

Authorizations:
api_key_items
path Parameters
itemId
required
string

[required] Item id

Request Body schema:
required
name
string
text
string
date
DateString

Responses

Request samples

Content type
{
  • "name": "My note",
  • "text": "Lorem Ipsum Dolor sit amet",
  • "date": "2022-07-18T00:00:00.000Z"
}

Response samples

Content type
{
  • "id": "62d9720152a73e0013508e3c",
  • "name": "My note",
  • "date": "2022-07-18T00:00:00.000Z",
  • "text": "Lorem Ipsum Dolor sit amet",
  • "typologyId": "startup",
  • "parentTypologyId": "startup",
  • "companyId": "62d943ee03b2e60013022971",
  • "confidential": false,
  • "userMentions": [ ],
  • "isAutomatic": true,
  • "created_by": "58b455c9bb409cd8419f48ad",
  • "updated_by": "58b455c9bb409cd8419f48ad",
  • "created_at": "2022-07-21T15:34:25.877Z",
  • "updated_at": "2022-07-21T15:34:25.877Z"
}

List Notes

List all notes linked to an item.

Scope

To use this endpoint ApiKey object must have this scope: public:items:* (all typologies) or public:items:startup,events,typology_id (specific typologies) Note You can add the http verb "get" in front of the scope to limit access to readonly endpoints. get@public:item:*

Authorizations:
api_key_items
path Parameters
itemId
required
string

[required] Item id

Responses

Response samples

Content type
[
  • {
    }
]

Get Note

Get a note linked to an item.

Scope

To use this endpoint ApiKey object must have this scope: public:items:* (all typologies) or public:items:startup,events,typology_id (specific typologies) Note You can add the http verb "get" in front of the scope to limit access to readonly endpoints. get@public:item:*

Authorizations:
api_key_items
path Parameters
itemId
required
string

[required] Item id refered by the note

noteId
required
string

[required] Note id to update

Responses

Response samples

Content type
[
  • {
    }
]

Update Note

Endpoint to update fields of a note.

Note

  • You can provide how many fields you need
  • Missing field won't be updated

Scope

To use this endpoint ApiKey object must have this scope:

public:items

Authorizations:
api_key_provisioning
path Parameters
itemId
required
string

[required] Item id refered by the note

noteId
required
string

[required] Note id to update

Request Body schema:
required

[required] A partial note object

name
string
text
string
date
DateString
userMentions
string

Responses

Request samples

Content type
{
  • "name": "My note",
  • "text": "Lorem Ipsum Dolor sit amet",
  • "date": "2022-07-18T00:00:00.000Z",
  • "userMentions": "string"
}

Response samples

Content type
{
  • "id": "62d9720152a73e0013508e3c",
  • "name": "My note",
  • "date": "2022-07-18T00:00:00.000Z",
  • "text": "Lorem Ipsum Dolor sit amet",
  • "typologyId": "startup",
  • "parentTypologyId": "startup",
  • "companyId": "62d943ee03b2e60013022971",
  • "confidential": false,
  • "userMentions": [ ],
  • "isAutomatic": true,
  • "created_by": "58b455c9bb409cd8419f48ad",
  • "updated_by": "58b455c9bb409cd8419f48ad",
  • "created_at": "2022-07-21T15:34:25.877Z",
  • "updated_at": "2022-07-21T15:34:25.877Z"
}

Partners

Endpoints dedicated to external partners like Early Metrics or partech so they can interact with your bloomflow platform. Note: The ApiKey must be linked to a SourcingPartner (BO) with the related scope.

Get Reference Data

Get reference data for partner endpoints. Containing all valid values for fundraising_stage, nb_employees and geographic_markets.

Scope

To use this endpoint ApiKey object must have this scope: public:partners-[PARTNER-ID]

Authorizations:
api_key_partners
path Parameters
partnerId
required
string

[required] The sourcing partner id

Responses

Response samples

Content type
{
  • "fundraising_stage": [
    ],
  • "nb_employees": [
    ],
  • "tags": [
    ],
  • "geographic_markets": [
    ]
}

Create Item

Create an item on behalf of a partner.

Note:

  • if an item with the same name or with the same website url exist, data will update existing object (only empty fields can be updated)
  • The created item will be linked to the SourcingPartner userGroup and source
  • TypologyId is also from the SourcingPartner
  • special partner_data object inside body contain
    • partner_url: This string will be stored in the custom field linked to SourcingPartner
    • corporate_contact_email: Used to define the owner of the new created item, owner userGroups will overide the sourcing partner userGroup when creating the workflow.

Check reference_data endpoint to get valid values for fundraising_stage, nb_employees and geographic_markets.

Scope

To use this endpoint ApiKey object must have this scope: public:partners-[PARTNER-ID]

Authorizations:
api_key_partners
path Parameters
partnerId
required
string
Request Body schema: application/x-www-form-urlencoded
required
withEnrichment
boolean
Default: false

The flag to enable item enrichment (default: false)

Responses

Response samples

Content type
{
  • "id": "5da97ee3d5d9fe6b42caebb1",
  • "action": "create",
  • "name": "Startup Flow",
  • "created_at": "2017-04-24T09:43:10.843Z"
}

Uploads

Endpoints for uploading content on your Bloomflow platform.

Upload File

Upload a file on bloomflow platform and return url.

Scope

To use this endpoint ApiKey object must have this scope: public:upload

Authorizations:
api_key_files
Request Body schema: application/x-www-form-urlencoded
image
boolean
Default: false

[required] Is it an image? Must be true if file is an image or a user avatar (e.g. "public" visual)

file
string <binary>

File to upload

Responses

Response samples

Content type
{}

Users

Endpoints to retrieve, create, modify and deactivate users from your account.

Get Reference Data

Get reference data to create a user. Containing all valid values for roles and user groups.

Scope

To use this endpoint ApiKey object must have this scope: public:provisioning-users

Authorizations:
api_key_items

Responses

Response samples

Content type
{
  • "roles": [
    ],
  • "userGroups": [
    ]
}

List Users

Retrieves a list of users. Result can be filtered by id (externalId), first name, last name, username, linkedIn url, default language, email address, localisation, phone number, job position and business unit. Number of results returned can be handled by limit and offset parameters.

Scope

To use this endpoint ApiKey object must have this scope: public:provisioning-users

Authorizations:
api_key_provisioning
query Parameters
provisionning_id
string

[optional] Provisioning id filter

id
string

[optional] User id filter

firstName
string

[optional] Fist name filter

lastName
string

[optional] Last name filter

username
string

[optional] Username filter

linkedin
string

[optional] LinkedIn filter

job
string

[optional] Job position filter

localisation
string

[optional] Localisation filter

phone
string

[optional] Phone number filter

business_unit
string

[optional] Business unit filter

default_language
string

[optional] Default language filter

email
string

[optional] Email filter

role
string

[optional] The role name to match

limit
string

[optional] The number of users to retrieve

offset
string

[optional] The offset of the first hit to return.

Responses

Response samples

Content type
[
  • {
    },
  • {
    },
  • {
    }
]

Create User

Create a User.

Note You can add a provisionning_id field to the object input containing a custom user id, other request with a user id parameter work with either the bloomflow id or your custom id.

Scope

To use this endpoint ApiKey object must have this scope:

public:provisioning-users

Authorizations:
api_key_provisioning
Request Body schema:
required
provisionning_id
string
firstName
string
lastName
string
linkedin
string
job
string
localisation
string
phone
string
business_unit
string
default_language
string
email
string
role
string
suspended
booolean
excluded
boolean

Responses

Request samples

Content type
{
  • "provisionning_id": "external-1",
  • "firstName": "Ted",
  • "lastName": "Hoover",
  • "linkedin": "https://www.linkedin.com/in/ted-hoover/",
  • "job": "Data Scientist Team Leader",
  • "localisation": "Paris",
  • "phone": "+1-202-555-0130",
  • "business_unit": "Research",
  • "default_language": "EN",
  • "email": "ted.hoover@allicata.com",
  • "role": "admin",
  • "suspended": true,
  • "excluded": true
}

Response samples

Content type
{
  • "provisionning_id": "external-1",
  • "id": "58b455c9bb409cd8419f48aa",
  • "firstName": "Ted",
  • "lastName": "Hoover",
  • "username": "Ted Hoover",
  • "linkedin": "https://www.linkedin.com/in/ted-hoover/",
  • "job": "Data Scientist Team Leader",
  • "localisation": "Paris",
  • "phone": "+1-202-555-0130",
  • "business_unit": "Research",
  • "default_language": "EN",
  • "email": "ted.hoover@allicata.com",
  • "role": "admin",
  • "suspended": true,
  • "excluded": true
}

Get User

Retrieve a specific user by ID.

Scope

To use this endpoint ApiKey object must have this scope:

public:provisioning-users

Authorizations:
api_key_provisioning
path Parameters
id
required
string

[required] Could be either the bloomflow user id or the externalId (set at user creation)

Responses

Response samples

Content type
{
  • "provisionning_id": "external-2",
  • "id": "58b455c9bb409cd8419f48ac",
  • "firstName": "Kerrie",
  • "lastName": "Randall",
  • "username": "Kerrie Randall",
  • "linkedin": "string",
  • "job": "International Brand Representative",
  • "localisation": "London",
  • "phone": "+1-202-555-0167",
  • "business_unit": "Solutions",
  • "default_language": "EN",
  • "email": "kerrie.randall@allicata.com",
  • "role": "contributor",
  • "suspended": true,
  • "excluded": true
}

Update User

Endpoint to update fields of a user (can be used to suspend a user).

Note

  • You can provide how many fields you need
  • Missing field won't be updated

Suspend a user

To suspend a user you need to provide input with an object containing the field suspended with the value true

Scope

To use this endpoint ApiKey object must have this scope:

public:provisioning-users

Authorizations:
api_key_provisioning
path Parameters
id
required
string

[required] Could be either the bloomflow user id or the externalId (set at user creation)

Request Body schema:
required

[required] A partial user object

suspended
booolean

Responses

Request samples

Content type
{
  • "suspended": true
}

Response samples

Content type
{
  • "provisionning_id": "external-2",
  • "id": "58b455c9bb409cd8419f48ac",
  • "firstName": "Kerrie",
  • "lastName": "Randall",
  • "username": "Kerrie Randall",
  • "linkedin": "string",
  • "job": "International Brand Representative",
  • "localisation": "London",
  • "phone": "+1-202-555-0167",
  • "business_unit": "Solutions",
  • "default_language": "EN",
  • "email": "kerrie.randall@allicata.com",
  • "role": "contributor",
  • "suspended": true,
  • "excluded": true
}

Delete User Deprecated

Delete a specific user.

Note Mark it as suspended. (Deprecated: Please use the Update user endpoint to suspend a user)

Scope

To use this endpoint ApiKey object must have this scope:

public:provisioning-users

Authorizations:
api_key_provisioning
path Parameters
id
required
string

[required] Could be either the bloomflow user id or the externalId (set at user creation)

Responses

Response samples

Content type
{
  • "count": 1
}

Webhooks

Endpoints to retrieve and configure Webhooks from your bloomflow platform.

Get Reference Data

Retrieve the list of webhook events you can subscribe to.

Webhook payload by event type

Here are listed the content of the payload response for each event type.

Note: For every payload, meta is the same object with the following properties:

  • object: The object type that triggered the webhook (item, workflow),
  • objectId: The id of the object that triggered the webhook,
  • action: The action that triggered the webhook (created, propertyChange, associationChange),
  • createdAt: The date when the webhook was triggered,
  • retry: The number of times the webhook was retried,
  • origin: The origin of the webhook (user, system),

item.created

{
    "event": "item.created",
    "meta": {
        "object": "item",
        "objectId": "648b246cc65c400013cae127",
        "objectLabel": "Microsoft",
        "action": "created",
        "createdAt": "2023-06-15T14:44:58.099Z",
        "retry": 0,
        "origin": "user",
        "fields": [
            "id",
            "typologyId",
            "name",
            "website",
            "short_description",
            "full_description",
            "year_founded",
            "nb_employees",
            "hq",
            "links"
        ]
    },
    "current": {
        "id": "648b246cc65c400013cae127",
        "typologyId": "startup",
        "name": "Microsoft",
        "website": "http://www.microsoft.com",
        "short_description": "Microsoft is a software corporation.",
        "full_description": "Microsoft is an American multinational corporation that develops, manufactures...",
        "year_founded": "1975",
        "nb_employees": "200+",
        "hq": {
            "hq_city": "Redmond",
            "hq_address": "1 Microsoft Way",
            "hq_countryId": "US"
        },
        "links": {
            "facebook_url": "https://www.facebook.com/Microsoft/",
            "twitter_url": "http://twitter.com/Microsoft",
            "linkedin_url": "http://www.linkedin.com/company/microsoft",
            "crunchbase_url": "https://www.crunchbase.com/organization/microsoft"
        }
    },
    "previous": {}
}

item.propertyChange

{
    "event": "item.propertyChange",
    "meta": {
        "object": "item",
        "objectId": "648af7bda4b1bf0014f736cd",
        "objectLabel": "Microsoft",
        "action": "propertyChange",
        "createdAt": "2023-06-15T14:44:58.098Z",
        "retry": 0,
        "origin": "user",
        "fields": [
            "id",
            "typologyId",
            "name",
            "success_proofs",
            "custom_fields"
        ]
    },
    "current": {
        "id": "648af7bda4b1bf0014f736cd",
        "typologyId": "startup",
        "name": "Microsoft 2",
        "success_proofs": "My success proofs field that wasn't existing before",
        "custom_fields": {
            "Turnover": "New value"
        }
    },
    "previous": {
        "id": "648af7bda4b1bf0014f736cd",
        "typologyId": "startup",
        "name": "Microsoft",
        "custom_fields": {
            "Turnover": "Old value"
        }
    }
}

item.associationChange

{
    "event": "item.associationChange",
    "meta": {
        "object": "item",
        "objectId": "648b26b2f884c2001357c48f",
        "objectLabel": "Microsoft",
        "processId": "648b26b2f884c2001357c48f",
        "processLabel": "Startup process",
        "action": "associationChange",
        "createdAt": "2023-06-15T14:44:58.097Z",
        "retry": 0,
        "origin": "user",
        "fields": [
            "id",
            "typologyId",
            "workflow"
        ]
    },
    "current": {
        "id": "648b26b2f884c2001357c48f",
        "typologyId": "startup",
        "workflow": {
            "id": "648b26b3f884c2001357c490",
            "step": "648b26d2f884c2001357c4a5",
            "label": "First contact"
        }
    },
    "previous": {
        "id": "648b26b2f884c2001357c48f",
        "typologyId": "startup",
        "workflow": {
            "id": "648b26b3f884c2001357c490",
            "step": "648b26b4f884c2001357c494",
            "label": "Identification"
        }
    }
}

workflow.propertyChange

{
    "event": "workflow.propertyChange",
    "meta": {
        "object": "workflow",
        "objectId": "648b26b3f884c2001357c490",
        "action": "propertyChange",
        "retry": 0,
        "origin": "user",
        "fields": [
            "id",
            "step",
            "label"
        ]
    },
    "current": {
        "id": "648b26b3f884c2001357c490",
        "step": "648b26d2f884c2001357c4a5",
        "label": "First contact"
    },
    "previous": {
        "id": "648b26b3f884c2001357c490",
        "step": "648b26b4f884c2001357c494",
        "label": "Identification"
    }
}

application.created

{
    "event": "application.created",
    "meta": {
        "object": "application",
        "objectId": "648b246cc65c400013cae127",
        "action": "created",
        "createdAt": "2023-06-15T14:44:58.099Z",
        "retry": 0,
        "origin": "user",
        "fields": [
            "id",
            "applicationFormId",
            "name",
            "pitch",
            "submitted_by_name",
            "submitted_by_email"
        ]
    },
    "current": {
        "id": "648b246cc65c400013cae127",
        "applicationFormId": "648b246cc65c400013cae128",
        "name": "Microsoft",
        "pitch": "Microsoft is a software corporation.",
        "submitted_by_name": "John Doe",
        "submitted_by_email": "john.doe@microsoft.com"
    },
    "previous": {}
}

Scope

To use this endpoint ApiKey object must have this scope: public:webhooks

Authorizations:
api_key_webhooks
query Parameters
withExamples
string

Return sample data

Responses

Response samples

Content type
{
  • "events": [
    ]
}

List Webhook subscriptions

Retrieve a list of webhook object.

Scope

To use this endpoint ApiKey object must have this scope: public:webhooks

Authorizations:
api_key_webhooks

Responses

Response samples

Content type
[
  • {
    },
  • {
    }
]

Create Webhook subscription

Create a Webhook subscription object.

Scope

To use this endpoint ApiKey object must have this scope: public:webhooks

Authorizations:
api_key_webhooks
Request Body schema:
required
events
Array of strings
webhookUrl
string
enabled
boolean

Responses

Request samples

Content type
{}

Response samples

Content type
{
  • "id": "6464ff0d8624c800135ad739",
  • "events": [
    ],
  • "webhookUrl": "https://hooks.zapier.com/hooks/catch/xxxxxx/yyyyyy/",
  • "enabled": true,
  • "created_by": "591aaf8292077d1e29c0b813",
  • "updated_by": "591aaf8292077d1e29c0b813",
  • "created_at": "2023-05-17T16:21:33.380+00:00",
  • "updated_at": "2023-05-17T16:21:33.380+00:00"
}

Get Webhook subscription

Retrieve a specific Webhook subscription object.

Scope

To use this endpoint ApiKey object must have this scope: public:webhooks

Authorizations:
api_key_webhooks
path Parameters
id
required
string

[required] WebhookSubscription id

Responses

Response samples

Content type
{
  • "id": "6464ff0d8624c800135ad739",
  • "events": [
    ],
  • "webhookUrl": "https://hooks.zapier.com/hooks/catch/xxxxxx/yyyyyy/",
  • "enabled": true,
  • "created_by": "2023-05-17T16:21:33.380+00:00",
  • "updated_by": "591aaf8292077d1e29c0b813",
  • "created_at": "2023-05-17T16:21:33.380+00:00",
  • "updated_at": "2023-05-17T16:21:33.380+00:00"
}

Delete Webhook subscription

Delete a Webhook subscription object.

Scope

To use this endpoint ApiKey object must have this scope: public:webhooks

Authorizations:
api_key_webhooks
path Parameters
id
required
string

[required] WebhookSubscription id

Responses

Response samples

Content type
{
  • "count": 1
}

IdeaManagement

Endpoints to list all Idea Management Challenges and add ideas to them

SCIM

Return ServiceProviderConfig.

Scope

To use this endpoint ApiKey object must have this scope: public:provisioning-users

Authorizations:
api_key_items

Responses

Response samples

Content type
{ }

Find SCIM Users

Scope

To use this endpoint ApiKey object must have this scope: public:provisioning-users

Point of attention

The filter parameter is required and should filter by userName with an email value for us to be able to match users that were created in Bloomflow manually.

Authorizations:
api_key_provisioning
query Parameters
filter
required
string
Example: filter=userName eq "john.doe@your_domain.com"

Filter expression to retrieve specific user(s)

startIndex
integer
Example: startIndex=0

The starting index for paginated results

count
integer
Example: count=100

The number of items returned per page

Responses

Response samples

Content type
{
  • "schemas": [
    ],
  • "totalResults": 1,
  • "Resources": [
    ],
  • "startIndex": 1,
  • "itemsPerPage": 20
}

Create SCIM User

Scope

To use this endpoint ApiKey object must have this scope: public:provisioning-users

Authorizations:
api_key_provisioning
Request Body schema:
required
schemas
required
Array of strings
externalId
string

External identifier for the user

userName
required
string

Username of the SCIM user

active
required
boolean
required
Array of objects
object
required
object

Responses

Request samples

Content type
{
  • "schemas": [
    ],
  • "externalId": "0a21f0f2-8d2a-4f8e-bf98-7363c4aed4ef",
  • "userName": "john.doe@domain.com",
  • "active": true,
  • "emails": [
    ],
  • "meta": {
    },
  • "name": {
    }
}

Response samples

Content type
{
  • "schemas": [
    ],
  • "id": "48af03ac28ad4fb88478",
  • "externalId": "0a21f0f2-8d2a-4f8e-bf98-7363c4aed4ef",
  • "meta": {
    },
  • "userName": "Test_User_00aa00aa-bb11-cc22-dd33-44ee44ee44ee",
  • "name": {
    },
  • "active": true,
  • "emails": [
    ]
}

Get SCIM User

Scope

To use this endpoint ApiKey object must have this scope: public:provisioning-users

Authorizations:
api_key_provisioning
path Parameters
id
required
string

Responses

Response samples

Content type
{
  • "schemas": [
    ],
  • "id": "5d48a0a8e9f04aa38008",
  • "externalId": "58342554-38d6-4ec8-948c-50044d0a33fd",
  • "meta": {
    },
  • "userName": "Test_User_00aa00aa-bb11-cc22-dd33-44ee44ee44ee",
  • "name": {
    },
  • "active": true,
  • "emails": [
    ]
}

Update SCIM User

Scope

To use this endpoint ApiKey object must have this scope: public:provisioning-users

Note

  • See our documentation to see which fields are supported for updating a user.

Suspend a user

To deprovision a user, you can set the "active" attribute to "false".

Authorizations:
api_key_provisioning
path Parameters
id
required
string
Request Body schema:
required
schemas
required
Array of strings
required
Array of objects

Responses

Request samples

Content type
{
  • "schemas": [
    ],
  • "Operations": [
    ]
}

Response samples

Content type
{
  • "schemas": [
    ],
  • "id": "6764549bef60420686bc",
  • "externalId": "6c75de36-30fa-4d2d-a196-6bdcdb6b6539",
  • "meta": {
    },
  • "userName": "Test_User_00aa00aa-bb11-cc22-dd33-44ee44ee44ee",
  • "name": {
    },
  • "active": true,
  • "emails": [
    ]
}

Delete SCIM User

Scope

To use this endpoint ApiKey object must have this scope: public:provisioning-users

Authorizations:
api_key_provisioning
path Parameters
id
required
string

Responses

Response samples

Content type
{
  • "count": 1
}