Jaa


Bloomflow (Preview)

Bloomflow is the innovation management platform empowering large enterprises to thrive in today’s rapidly changing business landscape. Leverage this connector to streamline collaboration and enhance productivity through efficient automated workflows.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name Bloomflow
URL https://www.bloomflow.com/contact-us
Email hello@bloomflow.com
Connector Metadata
Publisher Bloomflow
Website https://www.bloomflow.com/
Privacy policy https://www.bloomflow.com/legal/privacy-policy
Categories Productivity;Sales and CRM

Bloomflow is the innovation management platform empowering large enterprises to thrive in today’s rapidly changing business landscape. Leverage this connector to streamline collaboration and enhance productivity through efficient automated workflows. ​

Prerequisites

You need to be a Bloomflow eterprise user and your organization needs to have access to the Blooflow Public API package. To know more about Bloomflow and our services, get in touch with us at hello@bloomflow.com. ​

How to get credentials

Bloomflow APIs use API key authorization to ensure that client requests access data securely. With API key auth, you send a key-value pair to the API in the request headers for every call. Request header must have a x-bflow-api-key field containing the API key When you are ready to work with the public API ask your credentials by contacting us at customer@bloomflow.com. ​ ​

Known Issues and Limitations

  • Currently the Workflow property changed trigger only lets you track changes on Workflow Steps. This scope is likely to be expanded to cover changes in other workflow elements such as State, Groups and Tasks.
  • Currently the New Application created trigger gives access to limited information on incoming applications. ​

Common errors and remedies

Here are some issues you could face while using the connector:

  • Error 400: Appears when you make a bad request, it means that you wrongly enter the parameters. Check how to configure them correctly with our documentation.
  • Error 401: Appears when you are unautorized to access the requested information.
  • Error 403: Appears when you wrongly enter your API Key. ​ If you have any questions about our APIs, check our documentation or feel free to contact us.

Creating a connection

The connector supports the following authentication types:

Default Parameters for creating connection. All regions Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
API Key securestring The API Key for this api True

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

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

Create Document

Add a document to an item.

Scope

To use this endpoint ApiKey object must have those scopes: public:items 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

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:*

Create Note

Create a note linked to an item.

Scope

To use this endpoint ApiKey object must have those scopes: public:items 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

Create User

Create a User. Note: You can add a provisioning_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

Get item by ID

Retrieve a specific item by id.

Scope

To use this endpoint ApiKey object must have those scopes: public:items 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

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

Get User

Retrieve a specific user by ID.

Scope

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

Get users 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

List Documents

List all documents linked to an item.

Scope

To use this endpoint ApiKey object must have those scopes: public:items 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

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 those scopes: public:items 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

List Notes

List all notes linked to an item.

Scope

To use this endpoint ApiKey object must have those scopes: public:items 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

List Users

Retrieves a list of users. Result can be filtered by id (provisioning_id), 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

Update 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 those scopes:
public:items
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

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

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

Parameters

Name Key Required Type Description
Application Form Id
applicationFormId True string

[required] ApplicationForm id

logo
logo string
name
name string
website
website string
pitch
pitch string
description
description string
year_founded
year_founded string
hq_city
hq_city string
hq_countryId
hq_countryId string
nb_employees
nb_employees string
maturity
maturity string
label
label string
id
id string
first_name
first_name string

first_name

last_name
last_name string

last_name

email_address
email_address string

email_address

linkedin_url
linkedin_url string

linkedin_url

twitter_url
twitter_url string

twitter_url

phone_number
phone_number string

phone_number

position
position string

position

documents
documents array of string
video_urls
video_urls array of string
press
press array of string
business_model
business_model string
marketIds
marketIds array of string
competitors
competitors string
note_collaboration
note_collaboration string
firstName
firstName string
lastName
lastName string
email
email string
username
username string
note_service
note_service string
note_department
note_department string

Returns

Name Path Type Description
id
id string
status
status string

Create Document

Add a document to an item.

Scope

To use this endpoint ApiKey object must have those scopes: public:items 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

Parameters

Name Key Required Type Description
bloomflow public api url
bloomflow_api_url True string

bloomflow public api url

Id
id True string

Id of the object

Url
url string

Url of the external document to upload

Image
image boolean

Boolean to say if the document provided is an image

File
file file

File to upload

Returns

response
object

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:*

Parameters

Name Key Required Type Description
bloomflow public api url
bloomflow_api_url True string

bloomflow public api url

typology_id
typology_id string

typology_id

name
name string

name

website
website string

website

logo_url
logo_url string

logo_url

short_description
short_description string

short_description

full_description
full_description string

full_description

name
name string

tag

id
id string

label

name
name string

source

owner_email
owner_email string

owner_email

first_name
first_name string

first_name

last_name
last_name string

last_name

email_address
email_address string

email_address

type
type

position

first_name
first_name string

first_name

last_name
last_name string

last_name

email_address
email_address string

email_address

linkedin_url
linkedin_url string

linkedin_url

twitter_url
twitter_url string

twitter_url

phone_number
phone_number string

phone_number

position
position string

position

creation_date
creation_date string

creation_date

facebook_url
facebook_url string

facebook_url

twitter_url
twitter_url string

twitter_url

linkedin_url
linkedin_url string

linkedin_url

id
id string

market_ids

hq_address
hq_address string

hq_address

press_urls
press_urls array of string

press_urls

video_urls
video_urls array of string

video_urls

year_founded
year_founded string

year_founded

total_funding_usd
total_funding_usd string

total_funding_usd

fundraising_stage
fundraising_stage string

fundraising_stage

nb_employees
nb_employees string

nb_employees

business_model
business_model string

business_model

painpoints
painpoints string

painpoints

business_opportunity
business_opportunity string

business_opportunity

sustainability
sustainability string

sustainability

success_proofs
success_proofs string

success_proofs

risks
risks string

risks

key_differentiators
key_differentiators string

key_differentiators

competitors
competitors string

competitors

field_id
field_id string

field_id

value
value string

value

sync_origin_id
sync_origin_id string

sync_origin_id

sync_origin_url
sync_origin_url string

sync_origin_url

sync_origin_user_id
sync_origin_user_id string

sync_origin_user_id

sync_origin_user_first_name
sync_origin_user_first_name string

sync_origin_user_first_name

sync_origin_user_last_name
sync_origin_user_last_name string

sync_origin_user_last_name

sync_origin_user_email
sync_origin_user_email string

sync_origin_user_email

sync_mode
sync_mode string

sync_mode

Returns

Name Path Type Description
id
id string

id

name
name string

name

action
action string

action

created_at
created_at string

created_at

Create Note

Create a note linked to an item.

Scope

To use this endpoint ApiKey object must have those scopes: public:items 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

Parameters

Name Key Required Type Description
bloomflow public api url
bloomflow_api_url True string

bloomflow public api url

Id
id True string

Id of the object

name
name string

name

text
text string

text

date
date string

date

Returns

Name Path Type Description
date
date string

date

text
text string

text

confidential
confidential boolean

confidential

userMentions
userMentions array of

userMentions

isAutomatic
isAutomatic boolean

isAutomatic

typologyId
typologyId string

typologyId

parentTypologyId
parentTypologyId string

parentTypologyId

companyId
companyId string

companyId

id
id string

id

created_by
created_by string

created_by

updated_by
updated_by string

updated_by

created_at
created_at string

created_at

updated_at
updated_at string

updated_at

name
name string

name

Create User

Create a User. Note: You can add a provisioning_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

Parameters

Name Key Required Type Description
bloomflow public api url
bloomflow_api_url True string

bloomflow public api url

provisionning_id
provisionning_id string

provisionning_id

firstName
firstName string

firstName

lastName
lastName string

lastName

linkedin
linkedin string

linkedin

job
job string

job

localisation
localisation string

localisation

phone
phone string

phone

business_unit
business_unit string

business_unit

default_language
default_language string

default_language

email
email string

email

role
role string

role

suspended
suspended boolean

suspended

Returns

Name Path Type Description
provisionning_id
provisionning_id string
id
id string
firstName
firstName string
lastName
lastName string
username
username string
linkedin
linkedin string
job
job string
localisation
localisation string
phone
phone string
business_unit
business_unit string
default_language
default_language string
email
email string
role
role string
roles
roles array of object
id
roles.id string
name
roles.name string
groups
groups array of
suspended
suspended boolean

Get item by ID

Retrieve a specific item by id.

Scope

To use this endpoint ApiKey object must have those scopes: public:items 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

Parameters

Name Key Required Type Description
bloomflow public api url
bloomflow_api_url True string

bloomflow public api url

Id
id True string

Id of the object

Returns

Name Path Type Description
id
id string

id

name
name string

name

short_description
short_description string

short_description

full_description
full_description string

full_description

website
website string

website

logo_url
logo_url string

logo_url

year_founded
year_founded string

year_founded

maturity
maturity string

maturity

typologyId
typologyId string

typologyId

typology_id
typology_id string

typology_id

tags
tags array of object

tags

id
tags.id string

id

name
tags.name string

name

parent
tags.parent string

parent

category
tags.category string

category

labels
labels array of object

labels

id
labels.id string

id

name
labels.name string

name

business_model
business_model string

business_model

painpoints
painpoints string

painpoints

business_opportunity
business_opportunity string

business_opportunity

sustainability
sustainability string

sustainability

success_proofs
success_proofs string

success_proofs

risks
risks string

risks

key_differentiators
key_differentiators string

key_differentiators

competitors
competitors string

competitors

market_ids
market_ids array of string

market_ids

scoring_value
scoring_value integer

scoring_value

scoring_summary
scoring_summary string

scoring_summary

linkedin_url
links.linkedin_url string

linkedin_url

press_urls
press_urls array of string

press_urls

video_urls
video_urls array of string

video_urls

related_items
related_items array of object

related_items

id
related_items.id string

id

name
related_items.name string

name

internal_contacts
internal_contacts array of object

internal contacts

first_name
internal_contacts.first_name string

first_name

last_name
internal_contacts.last_name string

last_name

email_address
internal_contacts.email_address string

email_address

type
internal_contacts.type

position

external_contacts
external_contacts array of object

external contacts

first_name
external_contacts.first_name string

first_name

last_name
external_contacts.last_name string

last_name

email_address
external_contacts.email_address string

email_address

linkedin_url
external_contacts.linkedin_url string

linkedin_url

phone_number
external_contacts.phone_number string

phone_number

position
external_contacts.position string

position

creation_date
creation_date string

creation_date

hq_address
hq_address string

hq_address

nb_employees
nb_employees string

nb_employees

total_funding_usd
total_funding_usd string

total_funding_usd

fundraising_stage
fundraising_stage string

fundraising_stage

sourcing_partner_field
custom_fields.sourcing_partner_field string

sourcing_partner_field

fundings
fundings array of object

fundings

investors
fundings.investors string

investors

year
fundings.year string

year

amount
fundings.amount string

amount

currency_code
fundings.currency_code string

currency_code

transaction
fundings.transaction string

transaction

created_at
created_at string

created_at

updated_at
updated_at string

updated_at

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

Parameters

Name Key Required Type Description
bloomflow public api url
bloomflow_api_url True string

bloomflow public api url

Returns

Name Path Type Description
typologies
typologies array of object
id
typologies.id string

id

name
typologies.name string

name

parentTypologyId
typologies.parentTypologyId string
tags
typologies.tags array of object
id
typologies.tags.id string
name
typologies.tags.name string
labels
typologies.labels array of object
id
typologies.labels.id string
name
typologies.labels.name string
sources
typologies.sources array of object
id
typologies.sources.id string
name
typologies.sources.name string
custom_fields
custom_fields array of object
types
custom_fields.types array of string
field_id
custom_fields.field_id string
fundraising_stage
fundraising_stage array of string

Fundraising Stage

nb_employees
nb_employees array of string

Number of employees

tags
tags array of string

tags

market_ids
market_ids array of object

Geographic markets

id
market_ids.id string

id

label_FR
market_ids.label_FR string

label_FR

label_EN
market_ids.label_EN string

label_EN

Get User

Retrieve a specific user by ID.

Scope

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

Parameters

Name Key Required Type Description
bloomflow public api url
bloomflow_api_url True string

bloomflow public api url

Id
id True string

Id of the object

Returns

Name Path Type Description
provisionning_id
provisionning_id string
id
id string
firstName
firstName string
lastName
lastName string
username
username string
linkedin
linkedin string
job
job string
localisation
localisation string
phone
phone string
business_unit
business_unit string
default_language
default_language string
email
email string
role
role string
roles
roles array of object
id
roles.id string
name
roles.name string
groups
groups array of
suspended
suspended boolean

Get users 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

Parameters

Name Key Required Type Description
bloomflow public api url
bloomflow_api_url True string

bloomflow public api url

Returns

Name Path Type Description
roles
roles array of object
id
roles.id string
name
roles.name string
typologyId
roles.typologyId string
typologyFolderId
roles.typologyFolderId string
user_groups
user_groups array of object
id
user_groups.id string
name
user_groups.name string
roles
user_groups.roles array of object
id
user_groups.roles.id string
name
user_groups.roles.name string
typologyId
user_groups.roles.typologyId string
typologyFolderId
user_groups.roles.typologyFolderId string

List Documents

List all documents linked to an item.

Scope

To use this endpoint ApiKey object must have those scopes: public:items 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

Parameters

Name Key Required Type Description
bloomflow public api url
bloomflow_api_url True string

bloomflow public api url

Id
id True string

Id of the object

Returns

Name Path Type Description
array of object
name
name string

name

url
url string

url

type
type string

type

size
size integer

size

pinned
pinned boolean

pinned

isExternal
isExternal boolean

isExternal

id
id string

id

created_by
created_by string

created_by

companyId
companyId string

companyId

updated_by
updated_by string

updated_by

created_at
created_at string

created_at

updated_at
updated_at string

updated_at

format
format string

format

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 those scopes: public:items 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

Parameters

Name Key Required Type Description
bloomflow public api url
bloomflow_api_url True string

bloomflow public api url

Typology
typology True string

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

Term
term string

[optional] Term filter

Fields
fields string

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

Tags
tags string

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

Labels
labels string

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

Sources
sources string

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

Updated At Greater Than
updated_at_gt date

[optional] Minimum date filter

Updated At Lower Than
updated_at_lt date

[optional] Maximum date filter

Limit
limit number

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

Offset
offset number

[optional] The offset of the first hit to return

Sort
sort string

[optional] Parameter to sort result

Returns

Name Path Type Description
total
total integer

total

results
results array of object

results

typology_id
results.typology_id string

typology_id

id
results.id string

id

name
results.name string

name

website
results.website string

website

logo_url
results.logo_url string

logo_url

short_description
results.short_description string

short_description

full_description
results.full_description string

full_description

tags
results.tags array of object

tags

id
results.tags.id string

id

name
results.tags.name string

name

parent
results.tags.parent string

parent

category
results.tags.category string

category

labels
results.labels array of object

labels

id
results.labels.id string

id

name
results.labels.name string

name

sources
results.sources array of object
id
results.sources.id string
name
results.sources.name string
categoryId
results.sources.categoryId string
category
results.sources.category string
internal_contacts
results.internal_contacts array of object

internal contacts

first_name
results.internal_contacts.first_name string

first_name

last_name
results.internal_contacts.last_name string

last_name

email_address
results.internal_contacts.email_address string

email_address

type
results.internal_contacts.type

position

external_contacts
results.external_contacts array of object

external contacts

first_name
results.external_contacts.first_name string

first_name

last_name
results.external_contacts.last_name string

last_name

email_address
results.external_contacts.email_address string

email_address

linkedin_url
results.external_contacts.linkedin_url string

linkedin_url

phone_number
results.external_contacts.phone_number string

phone_number

position
results.external_contacts.position string

position

creation_date
results.creation_date string

creation_date

market_ids
results.market_ids array of string

market_ids

hq_address
results.hq_address string

hq_address

facebook_url
results.links.facebook_url string

facebook_url

twitter_url
results.links.twitter_url string

twitter_url

linkedin_url
results.links.linkedin_url string

linkedin_url

press_urls
results.press_urls array of string

press_urls

video_urls
results.video_urls array of string

video_urls

nb_employees
results.nb_employees string

nb_employees

year_founded
results.year_founded string

year_founded

total_funding_usd
results.total_funding_usd string

total_funding_usd

fundraising_stage
results.fundraising_stage string

fundraising_stage

business_model
results.business_model string

business_model

painpoints
results.painpoints string

painpoints

business_opportunity
results.business_opportunity string

business_opportunity

sustainability
results.sustainability string

sustainability

success_proofs
results.success_proofs string

success_proofs

risks
results.risks string

risks

key_differentiators
results.key_differentiators string

key_differentiators

competitors
results.competitors string

competitors

workflows
results.workflows array of object
id
results.workflows.current_status.id string
name
results.workflows.current_status.name string
date
results.workflows.current_status.date string
id
results.workflows.current_state.id string
name
results.workflows.current_state.name string
date
results.workflows.current_state.date string
states
results.workflows.states array of object
id
results.workflows.states.id string
name
results.workflows.states.name string
date
results.workflows.states.date string
status
results.workflows.status array of object
id
results.workflows.status.id string
name
results.workflows.status.name string
date
results.workflows.status.date string
groups
results.workflows.groups array of string

List Notes

List all notes linked to an item.

Scope

To use this endpoint ApiKey object must have those scopes: public:items 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

Parameters

Name Key Required Type Description
bloomflow public api url
bloomflow_api_url True string

bloomflow public api url

Id
id True string

Id of the object

Returns

Name Path Type Description
array of object
date
date string

date

text
text string

text

confidential
confidential boolean

confidential

userMentions
userMentions array of

userMentions

isAutomatic
isAutomatic boolean

isAutomatic

typologyId
typologyId string

typologyId

parentTypologyId
parentTypologyId string

parentTypologyId

companyId
companyId string

companyId

id
id string

id

created_by
created_by string

created_by

updated_by
updated_by string

updated_by

created_at
created_at string

created_at

updated_at
updated_at string

updated_at

name
name string

name

List Users

Retrieves a list of users. Result can be filtered by id (provisioning_id), 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

Parameters

Name Key Required Type Description
bloomflow public api url
bloomflow_api_url True string

bloomflow public api url

provisionning_id
provisionning_id string

[optional] Provisioning id filter

id
id string

[optional] User id filter

firstName
firstName string

[optional] Fist name filter

lastName
lastName string

[optional] Last name filter

username
username string

[optional] Username filter

linkedin
linkedin string

[optional] LinkedIn filter

job
job string

[optional] Job position filter

localisation
localisation string

[optional] Localisation filter

phone
phone string

[optional] Phone number filter

business_unit
business_unit string

[optional] Business unit filter

default_language
default_language string

[optional] Default language filter

email
email string

[optional] Email filter

role
role string

[optional] The role name to match

Limit
limit number

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

Offset
offset number

[optional] The offset of the first hit to return

Returns

Name Path Type Description
array of object
id
id string
firstName
firstName string
lastName
lastName string
username
username string
linkedin
linkedin string
job
job string
localisation
localisation string
phone
phone string
business_unit
business_unit string
default_language
default_language string
email
email string
role
role string
roles
roles array of object
id
roles.id string
name
roles.name string
typologyId
roles.typologyId string
typologyFolderId
roles.typologyFolderId string
groups
groups array of object
id
groups.id string
name
groups.name string
roles
groups.roles array of object
id
groups.roles.id string
name
groups.roles.name string
typologyId
groups.roles.typologyId string
typologyFolderId
groups.roles.typologyFolderId string
suspended
suspended boolean

Update 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 those scopes:
public:items
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

Parameters

Name Key Required Type Description
bloomflow public api url
bloomflow_api_url True string

bloomflow public api url

Id
id True string

Id of the object

typologyId
typologyId string

typologyId

name
name string

name

website
website string

website

logo_url
logo_url string

logo_url

short_description
short_description string

short_description

full_description
full_description string

full_description

name
name string

tag

id
id string

label

name
name string

source

owner_email
owner_email string

owner_email

first_name
first_name string

first_name

last_name
last_name string

last_name

email_address
email_address string

email_address

type
type

position

first_name
first_name string

first_name

last_name
last_name string

last_name

email_address
email_address string

email_address

linkedin_url
linkedin_url string

linkedin_url

twitter_url
twitter_url string

twitter_url

phone_number
phone_number string

phone_number

position
position string

position

creation_date
creation_date string

creation_date

facebook_url
facebook_url string

facebook_url

twitter_url
twitter_url string

twitter_url

linkedin_url
linkedin_url string

linkedin_url

id
id string

market_ids

hq_address
hq_address string

hq_address

press_urls
press_urls array of string

press_urls

video_urls
video_urls array of string

video_urls

year_founded
year_founded string

year_founded

total_funding_usd
total_funding_usd integer

total_funding_usd

fundraising_stage
fundraising_stage string

fundraising_stage

nb_employees
nb_employees string

nb_employees

business_model
business_model string

business_model

painpoints
painpoints string

painpoints

business_opportunity
business_opportunity string

business_opportunity

sustainability
sustainability string

sustainability

success_proofs
success_proofs string

success_proofs

risks
risks string

risks

key_differentiators
key_differentiators string

key_differentiators

competitors
competitors string

competitors

field_id
field_id string

field_id

value
value string

value

Returns

Name Path Type Description
typology_id
typology_id string

typology_id

id
id string

id

name
name string

name

website
website string

website

logo_url
logo_url string

logo_url

short_description
short_description string

short_description

full_description
full_description string

full_description

tags
tags array of object

tags

id
tags.id string

id

name
tags.name string

name

parent
tags.parent string

parent

category
tags.category string

category

labels
labels array of

labels

sources
sources array of object
id
sources.id string
name
sources.name string
internal_contacts
internal_contacts array of object

internal contacts

first_name
internal_contacts.first_name string

first_name

last_name
internal_contacts.last_name string

last_name

email_address
internal_contacts.email_address string

email_address

type
internal_contacts.type

position

external_contacts
external_contacts array of object

external contacts

first_name
external_contacts.first_name string

first_name

last_name
external_contacts.last_name string

last_name

email_address
external_contacts.email_address string

email_address

linkedin_url
external_contacts.linkedin_url string

linkedin_url

twitter_url
external_contacts.twitter_url string

twitter_url

phone_number
external_contacts.phone_number string

phone_number

position
external_contacts.position string

position

creation_date
creation_date string

creation_date

facebook_url
links.facebook_url string

facebook_url

twitter_url
links.twitter_url string

twitter_url

linkedin_url
links.linkedin_url string

linkedin_url

market_ids
market_ids array of string

geographic_markets

hq_address
hq_address string

hq_address

press_urls
press_urls array of string

press_urls

video_urls
video_urls array of string

video_urls

nb_employees
nb_employees string

nb_employees

year_founded
year_founded string

year_founded

total_funding_usd
total_funding_usd integer

total_funding_usd

fundraising_stage
fundraising_stage string

fundraising_stage

business_model
business_model string

business_model

painpoints
painpoints string

painpoints

business_opportunity
business_opportunity string

business_opportunity

sustainability
sustainability string

sustainability

success_proofs
success_proofs string

success_proofs

risks
risks string

risks

key_differentiators
key_differentiators string

key_differentiators

competitors
competitors string

competitors

typologyId
typologyId string

typologyId

related_items
related_items array of

related_items

sourcing_partner_field
custom_fields.sourcing_partner_field string

sourcing_partner_field

fundings
fundings array of

fundings

created_at
created_at string

created_at

updated_at
updated_at string

updated_at

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

Parameters

Name Key Required Type Description
bloomflow public api url
bloomflow_api_url True string

bloomflow public api url

Id
id True string

Id of the object

provisionning_id
provisionning_id string

provisionning_id

firstName
firstName string

firstName

lastName
lastName string

lastName

linkedin
linkedin string

linkedin

job
job string

job

localisation
localisation string

localisation

phone
phone string

phone

business_unit
business_unit string

business_unit

default_language
default_language string

default_language

email
email string

email

role
role string

role

suspended
suspended boolean

suspended

Returns

Name Path Type Description
provisionning_id
provisionning_id string
id
id string
firstName
firstName string
lastName
lastName string
username
username string
linkedin
linkedin string
job
job string
localisation
localisation string
phone
phone string
business_unit
business_unit string
default_language
default_language string
email
email string
role
role string
roles
roles array of object
id
roles.id string
name
roles.name string
groups
groups array of
suspended
suspended boolean

Triggers

Create Webhook subscription

Create a Webhook subscription object.

Scope

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

Create Webhook subscription

Create a Webhook subscription object.

Scope

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

Parameters

Name Key Required Type Description
bloomflow public api url
bloomflow_api_url True string

bloomflow public api url

events
events string

event

Returns

Name Path Type Description
object
meta.object string

object

objectId
meta.objectId string

objectId

action
meta.action string

action

createdAt
meta.createdAt string

createdAt

retry
meta.retry integer

retry

Definitions

object

This is the type 'object'.