API docs by Redocly

Hivebrite Admin API (3.0.0)

Download OpenAPI specification:

Here is all information you need to know to use our APIs

Rate limit and throttling

Default rate limit is 300 request per minute. However, max number of error, HTTP 500 and above, per minute is 15. Any calls after this will be throttled until the next minute. If no more errors (or less than 15) after the minute, the throttle is removed and default rate limit is back.

URI parameters general rules

The maximum value for our APIs per_page param is 100 and the recommended value is 25.

oauth

Operations about oauths

OAuth2 Authentication

Use grant_type password to get your access token, using params:

  • admin_email
  • password
  • client_id
  • client_secret

Or

Use grant_type refresh_token to get a new access token, using params:

  • refresh_token
  • client_id
  • client_secret
Request Body schema: application/x-www-form-urlencoded
required
grant_type
required
string
Enum: "password" "refresh_token"
scope
required
string
Value: "admin"
admin_email
string
password
string
client_id
string
client_secret
string
refresh_token
string
redirect_uri
string
Default: "urn:ietf:wg:oauth:2.0:oob"

Responses

donations

Operations about donations

List of Funds for Donations

Get a paginated list of Funds for Donations

Use the param updated_since to fetch all funds updated since this datetime (e.g. updated_since=2017-08-01T00:00:00) Datetime is considered UTC.

Use the param campaign_ids to fetch all funds linked to those particulars campaigns

Pagination information are stored in the response header as defined by RFC-5988 http://tools.ietf.org/html/rfc5988 Example:

{
"link": "<https://hivebrite.com/api/admin/v2/donations/funds?page=1&per_page=30>; rel=\"first\", <https://hivebrite.com/api/admin/v2/donations/funds?page=3&per_page=30>; rel=\"prev\", <https://hivebrite.com/api/admin/v2/donations/funds?page=2041&per_page=30>; rel=\"last\", <https://hivebrite.com/api/admin/v2/donations/funds?page=30&per_page=30>; rel=\"next\"",
"x-per-page": "30",
"x-total": "10201",
"x-page": "4"
}
query Parameters
updated_since
string <date-time>
campaign_ids[]
Array of integers <int32> [ items <int32 > ]

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "external_id": "string",
  • "title": "string",
  • "description": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "discarded_at": "2019-08-24T14:15:22Z",
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z",
  • "campaign_ids": 0,
  • "network_category_id": 0,
  • "payment_account_id": 0
}

Create a Donation fund

Create a Donation Fund

Required parameters are :

  • Title,
  • Description.

Donation Campaigns can be linked and may be retrieved from the /api/admin/v2/donations/campaigns endpoint. Network Categories can be linked and may be retrieved from the /api/admin/v2/categories/ endpoint. The Donation Fund can be limited in the time using the start_date and end_date attributes.

Request Body schema: application/x-www-form-urlencoded
fund[external_id]
string

Fund External ID

fund[title]
required
string

Title of the Donation Fund

fund[description]
required
string

Description of the Donation Fund

fund[start_date]
string <date-time>

Period of availability of the Fund (start) - iso8601

fund[end_date]
string <date-time>

Period of availability of the Fund (end) - iso8601

fund[campaign_ids][]
Array of integers <int32> [ items <int32 > ]

Donation Campaigns associated to this Donation Fund

fund[network_category_id]
integer <int32>

Network Category associated to this Donation Fund

fund[payment_account_id]
integer <int32>

Payment Account associated to this Donation Fund

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "external_id": "string",
  • "title": "string",
  • "description": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "discarded_at": "2019-08-24T14:15:22Z",
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z",
  • "campaign_ids": 0,
  • "network_category_id": 0,
  • "payment_account_id": 0
}

Get a Fund information

Get a Donation Fund

Donation Campaigns can be retrieved using their IDs in the /api/admin/v2/donations/campaigns/:id call. start_date and end_date are used to limit the possibility to make a donation to the fund between those dates.

path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "external_id": "string",
  • "title": "string",
  • "description": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "discarded_at": "2019-08-24T14:15:22Z",
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z",
  • "campaign_ids": 0,
  • "network_category_id": 0,
  • "payment_account_id": 0
}

Delete a donation fund

Delete a Donation Fund

Will delete the donation Fund. Will be removed from the Donation Campaigns associated.

path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "external_id": "string",
  • "title": "string",
  • "description": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "discarded_at": "2019-08-24T14:15:22Z",
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z",
  • "campaign_ids": 0,
  • "network_category_id": 0,
  • "payment_account_id": 0
}

Update an existing Donation fund

Update a Donation Campaign

Donation Campaigns can be linked and may be retrieved from the /api/admin/v2/donations/campaigns endpoint. Network Categories can be linked and may be retrieved from the /api/admin/v2/categories/ endpoint. The Donation Fund can be limited in the time using the start_date and end_date attributes.

path Parameters
id
required
integer <int32>

ID of the fund

Request Body schema: application/x-www-form-urlencoded
fund[external_id]
string

Fund External ID

fund[title]
string

Title of the Donation Fund

fund[description]
string

Description of the Donation Fund

fund[start_date]
string <date-time>

Period of availability of the Fund (start) - iso8601

fund[end_date]
string <date-time>

Period of availability of the Fund (end) - iso8601

fund[campaign_ids][]
Array of integers <int32> [ items <int32 > ]

Donation Campaigns associated to this Donation Fund

fund[network_category_id]
integer <int32>

Network Category associated to this Donation Fund

fund[payment_account_id]
integer <int32>

Payment Account associated to this Donation Fund

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "external_id": "string",
  • "title": "string",
  • "description": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "discarded_at": "2019-08-24T14:15:22Z",
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z",
  • "campaign_ids": 0,
  • "network_category_id": 0,
  • "payment_account_id": 0
}

Customizable Attribute Creation

Customizable Attribute creation for Donation Campaign

Required params are :

  • a Type,
  • a Display name
Request Body schema: application/x-www-form-urlencoded
required
customizable_attribute[type]
required
string
Enum: "CustomizableAttribute::Boolean" "CustomizableAttribute::Date" "CustomizableAttribute::Number" "CustomizableAttribute::Text"
customizable_attribute[display_name]
required
string
customizable_attribute[text_size]
integer <int32>
customizable_attribute[tooltip]
string

Customizable Attribute tooltip

customizable_attribute[placeholder]
string

Customizable Attribute placeholder

customizable_attribute[visibility]
string

Customizable Attribute visibility

customizable_attribute[required]
boolean

Customizable Attribute required ?

customizable_attribute[selected_value]
string

Customizable Attribute selected value

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "customizable_id": 0,
  • "type": "CustomizableAttribute::Boolean",
  • "customizable_type": "bizopp",
  • "name": "string",
  • "display_name": "string",
  • "tooltip": "string",
  • "placeholder": "string",
  • "multi": true,
  • "text_size": 0,
  • "visibility": "admin_only",
  • "user_editable": true,
  • "required": true,
  • "options": [
    ],
  • "json_options": { },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "selected_value": "string"
}

Customizable Attribute Update

Update a customizable attribute

The customizable attribute can be retrieved on the /api/admin/v1/settings/customizable_attributes endpoint.

path Parameters
id
required
string
Request Body schema: application/x-www-form-urlencoded
customizable_attribute[display_name]
string

Customizable Attribute displayed name

customizable_attribute[tooltip]
string

Customizable Attribute tooltip

customizable_attribute[placeholder]
string

Customizable Attribute placeholder

customizable_attribute[multi]
boolean

Customizable Attribute multi activated ?

customizable_attribute[text_size]
integer <int32>

Customizable Attribute text_size

customizable_attribute[visibility]
string

Customizable Attribute visibility

customizable_attribute[required]
boolean

Customizable Attribute required ?

customizable_attribute[selected_value]
string

Customizable Attribute selected value

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "customizable_id": 0,
  • "type": "CustomizableAttribute::Boolean",
  • "customizable_type": "bizopp",
  • "name": "string",
  • "display_name": "string",
  • "tooltip": "string",
  • "placeholder": "string",
  • "multi": true,
  • "text_size": 0,
  • "visibility": "admin_only",
  • "user_editable": true,
  • "required": true,
  • "options": [
    ],
  • "json_options": { },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "selected_value": "string"
}

Customizable Attribute Deletion

Destroy a Customizable Attribute

The customizable attributes of the feature Donation Campaign can be retrieved on the /api/admin/v1/settings/customizable_attributes endpoint. BEWARE: This will delete the Donor's answer to this customizable attribute as well as the customizable attributes linked to the Donation Campaigns.

path Parameters
id
required
string

Responses

List of Donations Campaigns

Get a paginated list of Campaigns for Donations

Use the param updated_since to fetch all campaigns updated since this datetime (e.g. updated_since=2017-08-01T00:00:00); Datetime is considered UTC.

Pagination information are stored in the response header as defined by RFC-5988 http://tools.ietf.org/html/rfc5988 Example:

{
"link": "<https://hivebrite.com/api/admin/v2/donations/campaigns?page=1&per_page=30>; rel=\"first\", <https://hivebrite.com/api/admin/v2/donations/campaigns?page=3&per_page=30>; rel=\"prev\", <https://hivebrite.com/api/admin/v2/donations/campaigns?page=2041&per_page=30>; rel=\"last\", <https://hivebrite.com/api/admin/v2/donations/campaigns?page=30&per_page=30>; rel=\"next\"",
"x-per-page": "30",
"x-total": "10201",
"x-page": "4"
}
query Parameters
updated_since
string <date-time>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "title": "string",
  • "description": "string",
  • "slug": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "discarded_at": "2019-08-24T14:15:22Z",
  • "background_image": "string",
  • "card_image": "string",
  • "currency": "string",
  • "goal_amount": 0.1,
  • "minimum_amount": 0.1,
  • "amounts": 0.1,
  • "enable_dedication": true,
  • "recurring_mode": "no_recurring",
  • "public": true,
  • "ask_for_tax_number": true,
  • "status": "string",
  • "fund_ids": 0,
  • "network_category_ids": 0,
  • "customizable_attribute_ids": 0
}

Create a Donation Campaign

Create a Donation Campaign

Required parameters are :

  • Title,
  • Description,
  • Currency (list is available at /api/admin/v1/settings/currencies, the code is to be used) The Slug is the keyword to access the Donation Campaign via the URL. A Slug with value: 'my-donation-campaign' will permit to access the Donation Campaign at the path my-community.hivebrite.com/donations/my-donation-campaign. Background Image must be sent as file (URL to file won't work) The Amounts array must have at least two values if the Other Amount is set to true. If the Recurring Payment Enabled boolean is set to true, Donations by users / visitors will be recurring.
Request Body schema: application/x-www-form-urlencoded
required
campaign[title]
required
string

Title of the Campaign

campaign[description]
required
string

Description of the Campaign

campaign[slug]
string

Slug to access this Campaign

campaign[background_image]
string <binary>

URL of the background image of the Campaign

campaign[card_image]
string <binary>

URL of the card image of the Campaign

campaign[currency]
required
string

ISO code of the Currency of this Campaign

campaign[goal_amount]
number <float>

Goal amount for this Campaign

campaign[minimum_amount]
number <float>

Minimum amount allowed for this Campaign

campaign[amounts][]
Array of numbers <float> [ items <float > ]

Pre defined amounts defined for this Campaign (must be more than two elements)

campaign[enable_dedication]
boolean

Donors to this campaign can dedicate their Donation?

campaign[recurring_mode]
string
Enum: "no_recurring" "simple_recurring" "advanced_recurring"

Donations to this Campaign are recurrent?

campaign[public]
boolean

Is this Donation Campaign public?

campaign[ask_for_tax_number]
boolean

Donors are asked for their tax number for this Donation Campaign?

campaign[status]
string

Status of this Donation Campaign

campaign[fund_ids][]
Array of integers <int32> [ items <int32 > ]

Donation Funds associated to this Donation Campaign

campaign[network_category_ids][]
Array of integers <int32> [ items <int32 > ]

Network Categories linked to this Donation Campaign

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "title": "string",
  • "description": "string",
  • "slug": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "discarded_at": "2019-08-24T14:15:22Z",
  • "background_image": "string",
  • "card_image": "string",
  • "currency": "string",
  • "goal_amount": 0.1,
  • "minimum_amount": 0.1,
  • "amounts": 0.1,
  • "enable_dedication": true,
  • "recurring_mode": "no_recurring",
  • "public": true,
  • "ask_for_tax_number": true,
  • "status": "string",
  • "fund_ids": 0,
  • "network_category_ids": 0,
  • "customizable_attribute_ids": 0
}

Get a Donation Campaign information

Get a Donation Campaign

The Slug is the keyword to access the Donation Campaign via the URL. A Slug with value: 'my-donation-campaign' will permit to access the Donation Campaign at the path my-community.hivebrite.com/donations/my-donation-campaign. Donation Funds can be retrieved using their IDs in the /api/admin/v2/donations/funds/:id call. Network Categories can be retrieved using their IDs in the /api/admin/v2/categories.

path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "title": "string",
  • "description": "string",
  • "slug": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "discarded_at": "2019-08-24T14:15:22Z",
  • "background_image": "string",
  • "card_image": "string",
  • "currency": "string",
  • "goal_amount": 0.1,
  • "minimum_amount": 0.1,
  • "amounts": 0.1,
  • "enable_dedication": true,
  • "recurring_mode": "no_recurring",
  • "public": true,
  • "ask_for_tax_number": true,
  • "status": "string",
  • "fund_ids": 0,
  • "network_category_ids": 0,
  • "customizable_attribute_ids": 0
}

Delete a Donation Campaign

Delete a Donation Campaign

Will delete the donation campaign. Will be removed from the Donation Funds associated.

path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "title": "string",
  • "description": "string",
  • "slug": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "discarded_at": "2019-08-24T14:15:22Z",
  • "background_image": "string",
  • "card_image": "string",
  • "currency": "string",
  • "goal_amount": 0.1,
  • "minimum_amount": 0.1,
  • "amounts": 0.1,
  • "enable_dedication": true,
  • "recurring_mode": "no_recurring",
  • "public": true,
  • "ask_for_tax_number": true,
  • "status": "string",
  • "fund_ids": 0,
  • "network_category_ids": 0,
  • "customizable_attribute_ids": 0
}

Update an existing Donation Campaign

Update a Donation Campaign

Currency parameter must be an ISO code (list is available at /api/admin/v1/settings/currencies). The Slug is the keyword to access the Donation Campaign via the URL. A Slug with value: 'my-donation-campaign' will permit to access the Donation Campaign at the path my-community.hivebrite.com/donations/my-donation-campaign. Background Image must be sent as file (URL to file won't work) The Amounts array must have at least two values if the Other Amount is set to true. If the Recurring Payment Enabled boolean is set to true, Donations by users / visitors will be recurring.

path Parameters
id
required
integer <int32>

ID of the Donation Campaign

Request Body schema: application/x-www-form-urlencoded
campaign[title]
string

Title of the Campaign

campaign[description]
string

Description of the Campaign

campaign[slug]
string

Slug to access this Campaign

campaign[background_image]
string <binary>

URL of the background image of the Campaign

campaign[card_image]
string <binary>

URL of the card image of the Campaign

campaign[currency]
string

ISO code of the Currency of this Campaign

campaign[goal_amount]
number <float>

Goal amount for this Campaign

campaign[minimum_amount]
number <float>

Minimum amount allowed for this Campaign

campaign[amounts][]
Array of numbers <float> [ items <float > ]

Pre defined amounts defined for this Campaign (must be more than two elements)

campaign[enable_dedication]
boolean

Donors to this campaign can dedicate their Donation?

campaign[recurring_mode]
string
Enum: "no_recurring" "simple_recurring" "advanced_recurring"

Donations to this Campaign are recurrent?

campaign[public]
boolean

Is this Donation Campaign public?

campaign[ask_for_tax_number]
boolean

Donors are asked for their tax number for this Donation Campaign?

campaign[status]
string

Status of this Donation Campaign

campaign[fund_ids][]
Array of integers <int32> [ items <int32 > ]

Donation Funds associated to this Donation Campaign

campaign[network_category_ids][]
Array of integers <int32> [ items <int32 > ]

Network Categories linked to this Donation Campaign

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "title": "string",
  • "description": "string",
  • "slug": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "discarded_at": "2019-08-24T14:15:22Z",
  • "background_image": "string",
  • "card_image": "string",
  • "currency": "string",
  • "goal_amount": 0.1,
  • "minimum_amount": 0.1,
  • "amounts": 0.1,
  • "enable_dedication": true,
  • "recurring_mode": "no_recurring",
  • "public": true,
  • "ask_for_tax_number": true,
  • "status": "string",
  • "fund_ids": 0,
  • "network_category_ids": 0,
  • "customizable_attribute_ids": 0
}

Duplicate a Donation Campaign

Duplicate a Donation Campaign

Duplicated parameters are :

  • Background Image
  • Description (and attachments associated if written in the webapp)
  • Network Categories
  • Funds associated
  • Customizable Attributes of type 'donation_campaign' linked Duplicated campaign is set to 'draft'.
path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "title": "string",
  • "description": "string",
  • "slug": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "discarded_at": "2019-08-24T14:15:22Z",
  • "background_image": "string",
  • "card_image": "string",
  • "currency": "string",
  • "goal_amount": 0.1,
  • "minimum_amount": 0.1,
  • "amounts": 0.1,
  • "enable_dedication": true,
  • "recurring_mode": "no_recurring",
  • "public": true,
  • "ask_for_tax_number": true,
  • "status": "string",
  • "fund_ids": 0,
  • "network_category_ids": 0,
  • "customizable_attribute_ids": 0
}

Customizable Attribute Unlink

The customizable attributes of a donation campaign can be retrieved on the /api/admin/v1/settings/customizable_attributes endpoint. The ID of a Customizable Attribute of a Donation Campaign is not the same as the one that will be linked to the said Donation Campaign. BEWARE: This will delete the Donor's answer to this customizable attribute.

path Parameters
campaign_id
required
string
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "customizable_id": 0,
  • "type": "CustomizableAttribute::Boolean",
  • "customizable_type": "bizopp",
  • "name": "string",
  • "display_name": "string",
  • "tooltip": "string",
  • "placeholder": "string",
  • "multi": true,
  • "text_size": 0,
  • "visibility": "admin_only",
  • "user_editable": true,
  • "required": true,
  • "options": [
    ],
  • "json_options": { },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "selected_value": "string"
}

List of Donations made

Get a paginated list of Donations made

Use the param updated_since to fetch all orders updated since this datetime (e.g. updated_since=2017-08-01T00:00:00) Datetime is considered UTC.

Pagination information are stored in the response header as defined by RFC-5988 http://tools.ietf.org/html/rfc5988 Example:

{
"link": "<https://hivebrite.com/api/admin/v2/donations/orders?page=1&per_page=30>; rel=\"first\", <https://hivebrite.com/api/admin/v2/donations/orders?page=3&per_page=30>; rel=\"prev\", <https://hivebrite.com/api/admin/v2/donations/orders?page=2041&per_page=30>; rel=\"last\", <https://hivebrite.com/api/admin/v2/donations/orders?page=30&per_page=30>; rel=\"next\"",
"x-per-page": "30",
"x-total": "10201",
"x-page": "4"
}
query Parameters
campaign_ids[]
Array of integers <int32> [ items <int32 > ]
user_ids[]
Array of integers <int32> [ items <int32 > ]
updated_since
string <date-time>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "external_id": "string",
  • "user_id": 0,
  • "campaign_id": 0,
  • "receipt_id": 0,
  • "gift_ids": 0,
  • "parent_id": 0,
  • "promotion_code": "string",
  • "tax_number": "string",
  • "billing_address": {
    },
  • "firstname": "string",
  • "lastname": "string",
  • "maidenname": "string",
  • "prefix_name": "string",
  • "mobile_pro": "string",
  • "mobile_perso": "string",
  • "email": "string",
  • "in_memory_of": true,
  • "on_behalf_of": true,
  • "in_honor_of": true,
  • "dedication_title": "string",
  • "dedication_description": "string",
  • "amount": 0.1,
  • "currency": "string",
  • "recurring_payment_enabled": true,
  • "lifelong_payment_enabled": true,
  • "recurring_payments_left": 0,
  • "periodicity": "week",
  • "send_confirmation_email": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "discarded_at": "2019-08-24T14:15:22Z",
  • "customizable_attributes": [
    ],
  • "hep_information": { },
  • "payment_status": "string",
  • "submitted_by": {
    }
}

Create a Donation

Create a Donation Order

Required parameters are :

  • Firstname (if the user_id is not given),
  • Lastname (if the user_id is not given),
  • Email (if the user_id is not given),
  • Campaign ID
  • Fund ID
  • Periodicity (if recurring_mode is set to advanced or simple for the campaign linked)
  • Amount (must be greater than the minimum amount of the campaign linked)

If both user_id and firstname/lastname/email are given, the firstname/lastname/email will override the user according value in this donation. If Periodicity and Recurring payment enabled are set, then the donor will be charged again one day before (created_at + periodicity)

The customizable attributes of a donation campaign can be retrieved on the /api/admin/v2/donations/campaigns/:campaign_id and /api/admin/v1/settings/customizable_attributes endpoint. To fill the order's customizable attributes values, you can set the customizable attributes value that way :

"order": [
  {
    "campaign_id": the_campaign_id,
    "customizable_attributes": [
      "_is_this_your_first_donation": true,
      "_to_how_many_associations_do_you_give": 3
    ]
  }
]

Creating an order via the API does not create a Receipt.

Request Body schema: application/x-www-form-urlencoded
order[external_id]
string

Donation Order external ID (for external systems)

order[user_id]
integer <int32>

User ID linked to this Donation Order

order[campaign_id]
required
integer <int32>

Donation Campaign ID linked to this Donation Order

order[parent_id]
integer <int32>

In case of a recurring donation, this is the ID of the previous Donation Order ID

order[promotion_code]
string

Promotion code linked to the Donation Order (permit to link to the order which marketing campaign led to the Donation)

order[tax_number]
string

Tax number linked to this Order

order[billing_address][address_1]
string

Address line 1

order[billing_address][address_2]
string

Address line 2

order[billing_address][address_3]
string

Address line 3

order[billing_address][city]
string

City

order[billing_address][state]
string

State

order[billing_address][postal_code]
string

Zip code

order[billing_address][country]
string
Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW" "XK"

Country

order[maidenname]
string

Maindenname of the Donor

order[prefix_name]
string

Prefix name of the Donor

order[mobile_pro]
string

Professionel mobile phone number of the Donor

order[mobile_perso]
string

Personal mobile phone number of the Donor

order[in_memory_of]
boolean

is the Donation in memory of someone/something ?

order[on_behalf_of]
boolean

is the Donation on behalf of someone/something ?

order[in_honor_of]
boolean

is the Donation in honor of someone/something ?

order[dedication_title]
string

To whom (or what) the Donation is dedicated

order[dedication_description]
string

A description of why/contact information for the Dedication

order[recurring_payment_enabled]
boolean

Is the Donation recurrent ?

order[lifelong_payment_enabled]
boolean

Is the Donation a lifelong recurring payment ?

order[recurring_payments_left]
integer <int32>

How many times it has to be charged again ?

order[periodicity]
string
Enum: "week" "two_weeks" "month" "three_months" "six_months" "year"

Periodicity of the Donation

order[send_confirmation_email]
boolean

Is the confirmation email to be send to the user ?

order[payment_status]
string

Status of the payment (not applicable if recurring)

order[firstname]
required
string
order[lastname]
required
string
order[email]
required
string
order[customizable_attributes][]
Array of objects
order[gifts][][fund_id]
required
Array of integers <int32> [ items <int32 > ]

Donation Fund ID linked to this Donation Gift

order[gifts][][amount]
required
Array of numbers <float> [ items <float > ]

Amount of the Donation

order[gifts][][custom_fund]
Array of strings

Name of the "other" fund chosen

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "external_id": "string",
  • "user_id": 0,
  • "campaign_id": 0,
  • "receipt_id": 0,
  • "gift_ids": 0,
  • "parent_id": 0,
  • "promotion_code": "string",
  • "tax_number": "string",
  • "billing_address": {
    },
  • "firstname": "string",
  • "lastname": "string",
  • "maidenname": "string",
  • "prefix_name": "string",
  • "mobile_pro": "string",
  • "mobile_perso": "string",
  • "email": "string",
  • "in_memory_of": true,
  • "on_behalf_of": true,
  • "in_honor_of": true,
  • "dedication_title": "string",
  • "dedication_description": "string",
  • "amount": 0.1,
  • "currency": "string",
  • "recurring_payment_enabled": true,
  • "lifelong_payment_enabled": true,
  • "recurring_payments_left": 0,
  • "periodicity": "week",
  • "send_confirmation_email": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "discarded_at": "2019-08-24T14:15:22Z",
  • "customizable_attributes": [
    ],
  • "hep_information": { },
  • "payment_status": "string",
  • "submitted_by": {
    }
}

Get a Donation Order

Get a Donation Order

  • user_id reflects the user linked to the donation (/api/admin/v1/users/:user_id)
  • campaign_id reflects the donation campaign linked to the donation (/api/admin/v2/donations/campaigns/:campaign_id)
  • fund_id reflects the donation fund linked to the donation (/api/admin/v2/donations/funds/:fund_id)
  • receipt_id reflects the receipt linked to the donation (/api/admin/v1/receipts/:receipt_id)
  • recurring_payment_enabled enhances the fact this donation will occur several time (if the linked campaign is also recurring)
  • the next payment will happen one day before the created_at of the donation + the periodicity time is over.
path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "external_id": "string",
  • "user_id": 0,
  • "campaign_id": 0,
  • "receipt_id": 0,
  • "gift_ids": 0,
  • "parent_id": 0,
  • "promotion_code": "string",
  • "tax_number": "string",
  • "billing_address": {
    },
  • "firstname": "string",
  • "lastname": "string",
  • "maidenname": "string",
  • "prefix_name": "string",
  • "mobile_pro": "string",
  • "mobile_perso": "string",
  • "email": "string",
  • "in_memory_of": true,
  • "on_behalf_of": true,
  • "in_honor_of": true,
  • "dedication_title": "string",
  • "dedication_description": "string",
  • "amount": 0.1,
  • "currency": "string",
  • "recurring_payment_enabled": true,
  • "lifelong_payment_enabled": true,
  • "recurring_payments_left": 0,
  • "periodicity": "week",
  • "send_confirmation_email": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "discarded_at": "2019-08-24T14:15:22Z",
  • "customizable_attributes": [
    ],
  • "hep_information": { },
  • "payment_status": "string",
  • "submitted_by": {
    }
}

Delete a Donation order

Deletes a Donation Order and the gifts linked.

path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "external_id": "string",
  • "user_id": 0,
  • "campaign_id": 0,
  • "receipt_id": 0,
  • "gift_ids": 0,
  • "parent_id": 0,
  • "promotion_code": "string",
  • "tax_number": "string",
  • "billing_address": {
    },
  • "firstname": "string",
  • "lastname": "string",
  • "maidenname": "string",
  • "prefix_name": "string",
  • "mobile_pro": "string",
  • "mobile_perso": "string",
  • "email": "string",
  • "in_memory_of": true,
  • "on_behalf_of": true,
  • "in_honor_of": true,
  • "dedication_title": "string",
  • "dedication_description": "string",
  • "amount": 0.1,
  • "currency": "string",
  • "recurring_payment_enabled": true,
  • "lifelong_payment_enabled": true,
  • "recurring_payments_left": 0,
  • "periodicity": "week",
  • "send_confirmation_email": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "discarded_at": "2019-08-24T14:15:22Z",
  • "customizable_attributes": [
    ],
  • "hep_information": { },
  • "payment_status": "string",
  • "submitted_by": {
    }
}

Update an existing Donation

Update a Donation Order

Amount cannot be updated. Recurring can be set on/off using the recurring_payment_enabled toggle. Campaign ID can be retrieve from the /api/admin/v2/donations/campaigns call

If both user_id and firstname/lastname/email are given, the firstname/lastname/email will override the user according value in this donation. If Periodicity and Recurring payment enabled are set, then the donor will be charged again one day before (created_at + periodicity)

The customizable attributes of a donation campaign can be retrieved on the /api/admin/v2/donations/campaigns/:campaign_id and /api/admin/v1/settings/customizable_attributes endpoint. To fill the order's customizable attributes values, you can set the customizable attributes value that way :

"order": [
  {
    "campaign_id": the_campaign_id,
    "customizable_attributes": [
      "_is_this_your_first_donation": true,
      "_to_how_many_associations_do_you_give": 3
    ]
  }
]
path Parameters
id
required
integer <int32>

ID of the donation order

Request Body schema: application/x-www-form-urlencoded
order[external_id]
string

Donation Order external ID (for external systems)

order[user_id]
integer <int32>

User ID linked to this Donation Order

order[campaign_id]
integer <int32>

Donation Campaign ID linked to this Donation Order

order[parent_id]
integer <int32>

In case of a recurring donation, this is the ID of the previous Donation Order ID

order[promotion_code]
string

Promotion code linked to the Donation Order (permit to link to the order which marketing campaign led to the Donation)

order[tax_number]
string

Tax number linked to this Order

order[billing_address][address_1]
string

Address line 1

order[billing_address][address_2]
string

Address line 2

order[billing_address][address_3]
string

Address line 3

order[billing_address][city]
string

City

order[billing_address][state]
string

State

order[billing_address][postal_code]
string

Zip code

order[billing_address][country]
string
Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW" "XK"

Country

order[firstname]
string

Firstname of the Donor

order[lastname]
string

Lastname of the Donor

order[maidenname]
string

Maindenname of the Donor

order[prefix_name]
string

Prefix name of the Donor

order[mobile_pro]
string

Professionel mobile phone number of the Donor

order[mobile_perso]
string

Personal mobile phone number of the Donor

order[email]
string

Email of the Donor

order[in_memory_of]
boolean

is the Donation in memory of someone/something ?

order[on_behalf_of]
boolean

is the Donation on behalf of someone/something ?

order[in_honor_of]
boolean

is the Donation in honor of someone/something ?

order[dedication_title]
string

To whom (or what) the Donation is dedicated

order[dedication_description]
string

A description of why/contact information for the Dedication

order[amount]
number <float>

Amount of the Donation

order[recurring_payment_enabled]
boolean

Is the Donation recurrent ?

order[lifelong_payment_enabled]
boolean

Is the Donation a lifelong recurring payment ?

order[recurring_payments_left]
integer <int32>

How many times it has to be charged again ?

order[periodicity]
string
Enum: "week" "two_weeks" "month" "three_months" "six_months" "year"

Periodicity of the Donation

order[send_confirmation_email]
boolean

Is the confirmation email to be send to the user ?

order[payment_status]
string

Status of the payment (not applicable if recurring)

order[customizable_attributes][]
Array of objects
order[gifts][][id]
Array of integers <int32> [ items <int32 > ]
order[gifts][][fund_id]
Array of integers <int32> [ items <int32 > ]
order[gifts][][custom_fund]
Array of strings

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "external_id": "string",
  • "user_id": 0,
  • "campaign_id": 0,
  • "receipt_id": 0,
  • "gift_ids": 0,
  • "parent_id": 0,
  • "promotion_code": "string",
  • "tax_number": "string",
  • "billing_address": {
    },
  • "firstname": "string",
  • "lastname": "string",
  • "maidenname": "string",
  • "prefix_name": "string",
  • "mobile_pro": "string",
  • "mobile_perso": "string",
  • "email": "string",
  • "in_memory_of": true,
  • "on_behalf_of": true,
  • "in_honor_of": true,
  • "dedication_title": "string",
  • "dedication_description": "string",
  • "amount": 0.1,
  • "currency": "string",
  • "recurring_payment_enabled": true,
  • "lifelong_payment_enabled": true,
  • "recurring_payments_left": 0,
  • "periodicity": "week",
  • "send_confirmation_email": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "discarded_at": "2019-08-24T14:15:22Z",
  • "customizable_attributes": [
    ],
  • "hep_information": { },
  • "payment_status": "string",
  • "submitted_by": {
    }
}

List of Donation Gifts made

Get a paginated list of Donations Gift made

Use the param updated_since to fetch all gifts updated since this datetime (e.g. updated_since=2017-08-01T00:00:00) Datetime is considered UTC.

Use the param campaign_ids to fetch all gifts linked to those particulars campaigns Use the param user_ids to fetch all gifts linked to those particulars users Use the param order_ids to fetch all gifts linked to those particulars orders Use the param fund_ids to fetch all gifts linked to those particulars funds

Pagination information are stored in the response header as defined by RFC-5988 http://tools.ietf.org/html/rfc5988 Example:

{
"link": "<https://hivebrite.com/api/admin/v2/donations/orders?page=1&per_page=30>; rel=\"first\", <https://hivebrite.com/api/admin/v2/donations/orders?page=3&per_page=30>; rel=\"prev\", <https://hivebrite.com/api/admin/v2/donations/orders?page=2041&per_page=30>; rel=\"last\", <https://hivebrite.com/api/admin/v2/donations/orders?page=30&per_page=30>; rel=\"next\"",
"x-per-page": "30",
"x-total": "10201",
"x-page": "4"
}
query Parameters
order_ids[]
Array of integers <int32> [ items <int32 > ]
fund_ids[]
Array of integers <int32> [ items <int32 > ]
user_ids[]
Array of integers <int32> [ items <int32 > ]
campaign_ids[]
Array of integers <int32> [ items <int32 > ]
updated_since
string <date-time>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "external_id": "string",
  • "user_id": 0,
  • "campaign_id": 0,
  • "receipt_id": 0,
  • "gift_ids": 0,
  • "parent_id": 0,
  • "promotion_code": "string",
  • "tax_number": "string",
  • "billing_address": {
    },
  • "firstname": "string",
  • "lastname": "string",
  • "maidenname": "string",
  • "prefix_name": "string",
  • "mobile_pro": "string",
  • "mobile_perso": "string",
  • "email": "string",
  • "in_memory_of": true,
  • "on_behalf_of": true,
  • "in_honor_of": true,
  • "dedication_title": "string",
  • "dedication_description": "string",
  • "amount": 0.1,
  • "currency": "string",
  • "recurring_payment_enabled": true,
  • "lifelong_payment_enabled": true,
  • "recurring_payments_left": 0,
  • "periodicity": "week",
  • "send_confirmation_email": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "discarded_at": "2019-08-24T14:15:22Z",
  • "customizable_attributes": [
    ],
  • "hep_information": { },
  • "payment_status": "string",
  • "submitted_by": {
    }
}

Get a Donation Gift

Get a Donation Gift

  • user_id reflects the user linked to the donation (/api/admin/v1/users/:user_id)
  • fund_id reflects the donation fund linked to the donation (/api/admin/v2/donations/funds/:fund_id)
  • order_id reflects the donation order linked to the donation (/api/admin/v2/donations/orders/:order_id)
path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "fund_id": 0,
  • "order_id": 0,
  • "user_id": 0,
  • "campaign_id": 0,
  • "amount": 0.1,
  • "custom_fund": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "discarded_at": "2019-08-24T14:15:22Z"
}

Update Fund Configuration for a Campaign

Get a Donation Fund Configuration

Donation Campaigns can be linked and may be retrieved from the /api/admin/v2/donations/campaigns endpoint. Donation Funds can be linked and may be retrieved from the /api/admin/v2/donations/funds endpoint. visible permits to display on the Front Office the given fund pinned permits to pin at the top of the page the given fund in the Front Office

path Parameters
campaign_id
required
integer <int32>
fund_id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "campaign_id": 0,
  • "fund_id": 0,
  • "visible": true,
  • "pinned": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update Fund Configuration for a Campaign

Update a Donation Fund Configuration

Donation Campaigns can be linked and may be retrieved from the /api/admin/v2/donations/campaigns endpoint. Donation Funds can be linked and may be retrieved from the /api/admin/v2/donations/funds endpoint. visible permits to display on the Front Office the given fund pinned permits to pin at the top of the page the given fund in the Front Office

path Parameters
campaign_id
required
integer <int32>
fund_id
required
integer <int32>
Request Body schema: application/x-www-form-urlencoded
fund_configuration[visible]
boolean

Donation fund will be visible in the list for the given Campaign

fund_configuration[pinned]
boolean

Donation fund will be highlighted in the list for the given Campaign

Responses

Response samples

Content type
application/json
{
  • "campaign_id": 0,
  • "fund_id": 0,
  • "visible": true,
  • "pinned": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

me

Operations about mes

Get information about the current admin

Current admin is the owner of the access_token used in the request.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "email": "string",
  • "name": "string",
  • "admin_type": "global",
  • "created_at": "2019-08-24T14:15:22Z"
}

settings

Operations about settings

Get all customizable attributes

Return this network customizable attributes.

query Parameters
customized_type
string
Enum: "bizopp" "bizopp_kind_config" "donation" "donation_campaign" "donation_user" "education" "event_addon" "experience" "memberships_topic" "memberships_user" "mentoring_program_mentee" "mentoring_program_mentor" "ne_event" "ne_ticket" "topic_approval" "user" "ventures_venture"
customizable_id
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "customizable_id": 0,
  • "type": "CustomizableAttribute::Boolean",
  • "customizable_type": "bizopp",
  • "name": "string",
  • "display_name": "string",
  • "tooltip": "string",
  • "placeholder": "string",
  • "multi": true,
  • "text_size": 0,
  • "visibility": "admin_only",
  • "user_editable": true,
  • "required": true,
  • "options": [
    ],
  • "json_options": { },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "selected_value": "string"
}

Get all field of studies

Return this network field of studies.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string"
}

Create a field of study

Return the created field of study if none with the same name exists. Returns the existing field of study otherwise

Request Body schema: application/x-www-form-urlencoded
required
field_of_study[name]
required
string

Name of the field of study

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string"
}

Get all industries

Return this network industries.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string"
}

Get all job functions

Return this network job functions.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "identifier": "string"
}

Get Network Currencies

Return this network enabled currencies.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "code": "string",
  • "symbol": "string"
}

network

Operations about networks

Get network information

Return this network information.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "title": "string",
  • "sub_networks": {
    },
  • "user_lists": {
    }
}

Add a new sub network

Return the created sub network

Request Body schema: application/x-www-form-urlencoded
required
title
required
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "title": "string"
}

Update a sub network

Return the updated sub network

path Parameters
id
required
string
Request Body schema: application/x-www-form-urlencoded
sub_network[title]
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "title": "string"
}

Delete a new sub network

Delete a sub network

path Parameters
id
required
string

Responses

List all citizenships

Return all citizenships

Responses

Response samples

Content type
application/json
{
  • "citizenships": [
    ]
}

users

Operations about users

Activate user account

Activate a user account

Use external_id or previous_id as the key parameter to identify the user on one of these identifiers instead of default user ID.

To activate a user account the user must have

  • an SSO identifier
  • a valid live location
  • all required user fields
path Parameters
user_id
required
integer <int32>
Request Body schema: application/x-www-form-urlencoded
key
string
Enum: "external_id" "previous_id"

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "external_id": "string",
  • "previous_id": "string",
  • "sso_identifier": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "confirmed_at": "2019-08-24T14:15:22Z",
  • "terms_accepted_at": "2019-08-24T14:15:22Z",
  • "terms_accepted": true,
  • "policies_accepted_at": "2019-08-24T14:15:22Z",
  • "policies_accepted": true
}

Get all user experiences

Return an array of experiences with basic information matching the associated user ID

Use external_id or previous_id as the key parameter to identify the user on one of these identifier instead of default user ID.

Pagination information are stored in the response header as defined by RFC-5988 http://tools.ietf.org/html/rfc5988

Example:

{
"link": "<https://hivebrite.com/api/admin/v1/users/:user_id/experiences?page=1&per_page=30>; rel=\"first\", <https://hivebrite.com/api/admin/v1/users/:user_id/experiences?page=3&per_page=30>; rel=\"prev\", <https://hivebrite.com/api/admin/v1/users/:user_id/experiences?page=2041&per_page=30>; rel=\"last\", <https://hivebrite.com/api/admin/v1/users/:user_id/experiences?page=30&per_page=30>; rel=\"next\"",
"x-per-page": "30",
"x-total": "10201",
"x-page": "4"
}
path Parameters
user_id
required
integer <int32>
query Parameters
key
string
Enum: "external_id" "previous_id"
filter[id]
integer <int32>

Unique ID

filter[position]
string

Experience position

filter[from]
string <date>

Experience started at

filter[to]
string <date>

Experience ended at

filter[companies_company_id]
string

ID of company linked

filter[industry_id]
integer <int32>

Industry ID matching the experience

filter[job_function_id]
integer <int32>

Job Function ID matching the experience

filter[external_id]
string

Experience ID in your database

filter[created_at]
string <date-time>

Experience creation date

filter[updated_at]
string <date-time>

Experience last update date time - iso8601

page
integer <int32>
Default: 1

Page of results to fetch.

per_page
integer <int32>
Default: null

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "experiences": [
    ]
}

Add a new experience

Return the created experience.

path Parameters
user_id
required
integer <int32>
Request Body schema: application/x-www-form-urlencoded
key
string
Enum: "external_id" "previous_id"
experience[position]
required
string

User position

experience[companies_company_id]
required
string

Company linked to experience

experience[companies_company_key]
string
Value: "external_id"
experience[from]
string <date>

Experience started at

experience[to]
string <date>

Experience ended at

experience[custom_attributes][]
Array of objects

Array of customizable attributes with name, value and type

experience[industry_id]
integer <int32>

Industry ID matching the experience

experience[job_function_id]
integer <int32>

Job Function ID matching the experience

experience[external_id]
string

Experience ID in your database

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "position": "string",
  • "from": "2019-08-24",
  • "to": "2019-08-24",
  • "companies_company_id": "string",
  • "custom_attributes": [
    ],
  • "industry_id": 0,
  • "job_function_id": 0,
  • "external_id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Get user experience

Return the user experience based on its ID and associated user ID

Find the user experience matching its ID and associated user ID, or use external_id or previous_id as the key parameter to identify the user on one of these identifier instead of default user ID.

path Parameters
user_id
required
integer <int32>
id
required
integer <int32>
query Parameters
key
string
Enum: "external_id" "previous_id"
experience_key
string
Value: "external_id"

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "position": "string",
  • "from": "2019-08-24",
  • "to": "2019-08-24",
  • "companies_company_id": "string",
  • "custom_attributes": [
    ],
  • "industry_id": 0,
  • "job_function_id": 0,
  • "external_id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update existing user experience

Update a user experience

Find the user experience matching its ID and associated user ID, or use external_id or previous_id as the key parameter to identify the user on one of these identifier instead of default user ID.

path Parameters
user_id
required
integer <int32>
id
required
string

Experience ID

Request Body schema: application/x-www-form-urlencoded
key
string
Enum: "external_id" "previous_id"
experience_key
string
Value: "external_id"
experience[companies_company_key]
string
Value: "external_id"
experience[position]
string

Experience position

experience[from]
string <date>

Experience started at

experience[to]
string <date>

Experience ended at

experience[companies_company_id]
string

ID of company linked

experience[custom_attributes][]
Array of objects

Array of customizable attributes with name, value and type

experience[industry_id]
integer <int32>

Industry ID matching the experience

experience[job_function_id]
integer <int32>

Job Function ID matching the experience

experience[external_id]
string

Experience ID in your database

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "position": "string",
  • "from": "2019-08-24",
  • "to": "2019-08-24",
  • "companies_company_id": "string",
  • "custom_attributes": [
    ],
  • "industry_id": 0,
  • "job_function_id": 0,
  • "external_id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Delete User experience

Delete the user experience based on its ID and the associated user ID

Use external_id or previous_id as the key parameter to identify the user on one of these identifier instead of default user ID.

path Parameters
user_id
required
integer <int32>
id
required
string
query Parameters
key
string
Enum: "external_id" "previous_id"
experience_key
string
Value: "external_id"

Responses

Bulk add experiences

Batch creation of user experiences

WARNING: Swagger generated example of the parameters is false! You should use an array of user experiences data

{
  "experiences": [
    // experience 1
    {
      "position": "string",
      "companies_company_id": 0
      ...
    },
    // experience 2
    {
      "position": "string",
      "companies_company_id": 0
      ...
    },
  ]
}

Errors

If any user experience failed to save, the whole transaction is rollbacked

path Parameters
user_id
required
integer <int32>
Request Body schema: application/x-www-form-urlencoded
key
string
Enum: "external_id" "previous_id"
experiences[][position]
required
Array of strings

User position

experiences[][companies_company_id]
required
Array of strings

Company linked to experience

experiences[][companies_company_key]
Array of strings
Items Value: "external_id"
experiences[][from]
Array of strings <date> [ items <date > ]

Experience started at

experiences[][to]
Array of strings <date> [ items <date > ]

Experience ended at

experiences[][custom_attributes][]
Array of strings

Array of customizable attributes with name, value and type

experiences[][industry_id]
Array of integers <int32> [ items <int32 > ]

Industry ID matching the experience

experiences[][job_function_id]
Array of integers <int32> [ items <int32 > ]

Job Function ID matching the experience

experiences[][external_id]
Array of strings

Experience ID in your database

Responses

Response samples

Content type
application/json
{
  • "experiences": [
    ]
}

Bulk update of existing user experiences

Batch update of user experiences

Find user experiences using the ID setted in the experiences hash, linked to the user set with the user ID or set external_id or previous_id as the key parameter to fetch user on this identifier instead of default ID, and set the correct value for the ID params in users.

WARNING: Swagger generated example of the parameters is false! You should use an array of user experiences data

{
  "experiences": [
    // experience 1
    {
      "id": 1,
      "position": "string",
      "companies_company_id": 0
      ...
    },
    // experience 2
    {
      "id": 2,
      "position": "string",
      "companies_company_id": 0
      ...
    },
  ]
}

Errors

If any user experiences failed to update, the whole transaction is rollbacked

path Parameters
user_id
required
integer <int32>
Request Body schema: application/x-www-form-urlencoded
key
string
Enum: "external_id" "previous_id"
experiences[][id]
required
Array of strings

Experience ID

experiences[][experience_key]
Array of strings
Items Value: "external_id"
experiences[][companies_company_key]
Array of strings
Items Value: "external_id"
experiences[][position]
Array of strings

Experience position

experiences[][from]
Array of strings <date> [ items <date > ]

Experience started at

experiences[][to]
Array of strings <date> [ items <date > ]

Experience ended at

experiences[][companies_company_id]
Array of strings

ID of company linked

experiences[][custom_attributes][]
Array of strings

Array of customizable attributes with name, value and type

experiences[][industry_id]
Array of integers <int32> [ items <int32 > ]

Industry ID matching the experience

experiences[][job_function_id]
Array of integers <int32> [ items <int32 > ]

Job Function ID matching the experience

experiences[][external_id]
Array of strings

Experience ID in your database

Responses

Response samples

Content type
application/json
{
  • "experiences": [
    ]
}

Get all user educations

Return an array of educations with basic information matching the associated user ID

Use external_id or previous_id as the key parameter to identify the user on one of these identifier instead of default user ID.

Pagination information are stored in the response header as defined by RFC-5988 http://tools.ietf.org/html/rfc5988

Example:

{
"link": "<https://hivebrite.com/api/admin/v1/users/:id/educations?page=1&per_page=30>; rel=\"first\", <https://hivebrite.com/api/admin/v1/users/:id/educations?page=3&per_page=30>; rel=\"prev\", <https://hivebrite.com/api/admin/v1/users/:id/educations?page=2041&per_page=30>; rel=\"last\", <https://hivebrite.com/api/admin/v1/users/:id/educations?page=30&per_page=30>; rel=\"next\"",
"x-per-page": "30",
"x-total": "10201",
"x-page": "4"
}
path Parameters
user_id
required
integer <int32>
query Parameters
key
string
Enum: "external_id" "previous_id"
page
integer <int32>
Default: 1

Page of results to fetch.

per_page
integer <int32>
Default: null

Number of results to return per page.

filter[id]
integer <int32>

Unique ID

filter[school_name]
string

Education school

filter[degree]
string

Education degree

filter[from]
string <date>

Education started at

filter[to]
string <date>

Education ended at

filter[field_of_study_id]
integer <int32>

Field of study ID matching the education

filter[field_of_study_name]
string

Field of study name (from Field of study Object linked)

filter[external_id]
string

Education ID in your database

filter[user_can_edit]
boolean

Is this education editable by the user

filter[created_at]
string <date-time>

Education creation date

filter[updated_at]
string <date-time>

Education last update date time - iso8601

Responses

Response samples

Content type
application/json
{
  • "educations": [
    ]
}

Add a new education

Return the created education.

path Parameters
user_id
required
integer <int32>
Request Body schema: application/x-www-form-urlencoded
key
string
Enum: "external_id" "previous_id"
education[school_name]
required
string

School name

education[degree]
string

Education degree

education[from]
string <date>

Education started at

education[to]
string <date>

Education ended at

education[custom_attributes][]
Array of objects

Array of customizable attributes with name, value and type

education[field_of_study_id]
integer <int32>

Field of study ID matching the education

education[field_of_study_name]
string

Field of study name (from Field of study Object linked)

education[external_id]
string

Education ID in your database

education[user_can_edit]
boolean

Is this education editable by the user

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "school_name": "string",
  • "degree": "string",
  • "from": "2019-08-24",
  • "to": "2019-08-24",
  • "custom_attributes": [
    ],
  • "field_of_study_id": 0,
  • "field_of_study_name": "string",
  • "external_id": "string",
  • "user_can_edit": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Get user education

Return the user education based on its ID and associated user ID

Find the user education matching its ID and associated user ID, or use external_id or previous_id as the key parameter to identify the user on one of these identifier instead of default user ID.

path Parameters
user_id
required
integer <int32>
id
required
integer <int32>
query Parameters
key
string
Enum: "external_id" "previous_id"
education_key
string
Value: "external_id"

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "school_name": "string",
  • "degree": "string",
  • "from": "2019-08-24",
  • "to": "2019-08-24",
  • "custom_attributes": [
    ],
  • "field_of_study_id": 0,
  • "field_of_study_name": "string",
  • "external_id": "string",
  • "user_can_edit": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update existing user education

Update a user education

Find the user education matching its ID and associated user ID, or use external_id or previous_id as the key parameter to identify the user on one of these identifier instead of default user ID.

path Parameters
user_id
required
integer <int32>
id
required
string

Education ID

Request Body schema: application/x-www-form-urlencoded
key
string
Enum: "external_id" "previous_id"
education_key
string
Value: "external_id"
education[degree]
string

Education degree

education[from]
string <date>

Education started at

education[to]
string <date>

Education ended at

education[custom_attributes][]
Array of objects

Array of customizable attributes with name, value and type

education[field_of_study_id]
integer <int32>

Field of study ID matching the education

education[field_of_study_name]
string

Field of study name (from Field of study Object linked)

education[external_id]
string

Education ID in your database

education[user_can_edit]
boolean

Is this education editable by the user

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "school_name": "string",
  • "degree": "string",
  • "from": "2019-08-24",
  • "to": "2019-08-24",
  • "custom_attributes": [
    ],
  • "field_of_study_id": 0,
  • "field_of_study_name": "string",
  • "external_id": "string",
  • "user_can_edit": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Delete User education 

            ## Delete the user education based on its ID and the associated user ID
            Use `external_id` or `previous_id` as the **key** parameter to identify the user on one of these identifier instead of default user ID.
path Parameters
user_id
required
integer <int32>
id
required
string
query Parameters
key
string
Enum: "external_id" "previous_id"
education_key
string
Value: "external_id"

Responses

Bulk add educations

Batch creation of user educations

WARNING: Swagger generated example of the parameters is false! You should use an array of user educations data

{
  "educations": [
    // education 1
    {
      "school_name": "string",
      ...
    },
    // education 2
    {
      "school_name": "string",
      ...
    },
  ]
}

Errors

If any user education failed to save, the whole transaction is rollbacked

path Parameters
user_id
required
integer <int32>
Request Body schema: application/x-www-form-urlencoded
key
string
Enum: "external_id" "previous_id"
educations[][school_name]
required
Array of strings

School name

educations[][degree]
Array of strings

Education degree

educations[][from]
Array of strings <date> [ items <date > ]

Education started at

educations[][to]
Array of strings <date> [ items <date > ]

Education ended at

educations[][custom_attributes][]
Array of strings

Array of customizable attributes with name, value and type

educations[][field_of_study_id]
Array of integers <int32> [ items <int32 > ]

Field of study ID matching the education

educations[][field_of_study_name]
Array of strings

Field of study name (from Field of study Object linked)

educations[][external_id]
Array of strings

Education ID in your database

educations[][user_can_edit]
Array of booleans

Is this education editable by the user

Responses

Response samples

Content type
application/json
{
  • "educations": [
    ]
}

Bulk update of existing user educations

Batch update of user educations

Find user educations using the ID setted in the educations hash, linked to the user set with the user ID or set external_id or previous_id as the key parameter to fetch user on this identifier instead of default ID, and set the correct value for the ID params in users.

WARNING: Swagger generated example of the parameters is false! You should use an array of user educations data

{
  "educations": [
    // education 1
    {
      "id": 1,
      "school_name": "string",
      ...
    },
    // education 2
    {
      "id": 2,
      "school_name": "string",
      ...
    },
  ]
}

Errors

If any user educations failed to update, the whole transaction is rollbacked

path Parameters
user_id
required
integer <int32>
Request Body schema: application/x-www-form-urlencoded
key
string
Enum: "external_id" "previous_id"
educations[][education_key]
Array of strings
Items Value: "external_id"
educations[][id]
required
Array of strings

Education ID

educations[][degree]
Array of strings

Education degree

educations[][from]
Array of strings <date> [ items <date > ]

Education started at

educations[][to]
Array of strings <date> [ items <date > ]

Education ended at

educations[][custom_attributes][]
Array of strings

Array of customizable attributes with name, value and type

educations[][field_of_study_id]
Array of integers <int32> [ items <int32 > ]

Field of study ID matching the education

educations[][field_of_study_name]
Array of strings

Field of study name (from Field of study Object linked)

educations[][external_id]
Array of strings

Education ID in your database

educations[][user_can_edit]
Array of booleans

Is this education editable by the user

Responses

Response samples

Content type
application/json
{
  • "educations": [
    ]
}

Return all notification settings for this user

Return this user notification settings

path Parameters
user_id
required
integer <int32>
query Parameters
key
string
Enum: "external_id" "previous_id"

Responses

Response samples

Content type
application/json
{
  • "post_email": true,
  • "trip_email": true,
  • "event_email": true,
  • "digest_email": true,
  • "comment_email": true,
  • "ventures_comment_email": true,
  • "businessopportunities_request": true,
  • "current_location_email": true,
  • "emailing_communication_email": true,
  • "forum_post_email": true,
  • "contact_by_phone": true,
  • "contact_by_sms": true,
  • "contact_by_post": true,
  • "emailing_categories_subscribed": [
    ],
  • "groups_notifications": [
    ]
}

Update this user notification settings

Update this user notification settings

path Parameters
user_id
required
integer <int32>
Request Body schema: application/x-www-form-urlencoded
key
string
Enum: "external_id" "previous_id"
notification_settings[emailing_categories_subscribed_ids][]
Array of integers <int32> [ items <int32 > ]

Emailing category ids subscribed

notification_settings[post_email]
boolean

Receive notifications for new posts

notification_settings[trip_email]
boolean

Receive notifications for new trips

notification_settings[event_email]
boolean

Receive notifications for new user events

notification_settings[digest_email]
boolean

Receive notifications for new digests

notification_settings[comment_email]
boolean

Receive notifications for new comments

notification_settings[ventures_comment_email]
boolean

Receive notifications for new ventures comments

notification_settings[businessopportunities_request]
boolean

Receive notifications for new business opportunities

notification_settings[current_location_email]
boolean

Receive notifications for new checkins

notification_settings[emailing_communication_email]
boolean

Consent to receive campaigns via email

notification_settings[forum_post_email]
boolean

Receive notifications for new forum posts

notification_settings[contact_by_phone]
boolean

Consent to receive campaigns via phone

notification_settings[contact_by_sms]
boolean

Consent to receive campaigns via SMS

notification_settings[contact_by_post]
boolean

Consent to receive campaigns via post

notification_settings[groups_notifications][][topic_id]
required
Array of integers <int32> [ items <int32 > ]
notification_settings[groups_notifications][][group_activity_frequency]
Array of strings
Items Enum: "none" "instant" "daily" "weekly"
notification_settings[groups_notifications][][emailing_campaign_enabled]
Array of booleans
notification_settings[groups_notifications][][category_subscribed_ids][]
Array of integers <int32> [ items <int32 > ]

Group category ids subscribed

Responses

Response samples

Content type
application/json
{
  • "post_email": true,
  • "trip_email": true,
  • "event_email": true,
  • "digest_email": true,
  • "comment_email": true,
  • "ventures_comment_email": true,
  • "businessopportunities_request": true,
  • "current_location_email": true,
  • "emailing_communication_email": true,
  • "forum_post_email": true,
  • "contact_by_phone": true,
  • "contact_by_sms": true,
  • "contact_by_post": true,
  • "emailing_categories_subscribed": [
    ],
  • "groups_notifications": [
    ]
}

Get all users postal addresses

Return an array of postal addresses

Use the param updated_since to fetch all postal addresses updated since this datetime (e.g. updated_since=2017-08-01T00:00:00)

Use the param order to choose on which criterias the results should be ordered (e.g. order=updated_at to order by updated_at descending, use the minus operator to order by ascending value e.g. order=-updated_at).

Pagination information are stored in the response header as defined by RFC-5988 http://tools.ietf.org/html/rfc5988

Example:

{
"link": "<https://hivebrite.com/api/admin/v1/postal_addresses?page=1&per_page=30>; rel=\"first\", <https://hivebrite.com/api/admin/v1/postal_addresses?page=3&per_page=30>; rel=\"prev\", <https://hivebrite.com/api/admin/v1//postal_addresses?page=2041&per_page=30>; rel=\"last\", <https://hivebrite.com/api/admin/v1/postal_addresses?page=30&per_page=30>; rel=\"next\"",
"x-per-page": "30",
"x-total": "10201",
"x-page": "4"
}
query Parameters
page
integer <int32>
Default: 1

Page of results to fetch.

per_page
integer <int32>
Default: null

Number of results to return per page.

order
string
Enum: "id" "-id" "address_1" "-address_1" "address_2" "-address_2" "address_3" "-address_3" "city" "-city" "state" "-state" "postal_code" "-postal_code" "country" "-country" "full_name" "-full_name" "default_billing_address" "-default_billing_address" "created_at" "-created_at" "updated_at" "-updated_at" "addressable_id" "-addressable_id"
updated_since
string <date-time>

Responses

Response samples

Content type
application/json
{
  • "postal_addresses": [
    ]
}

Get postal address

Return the postal address based on its ID

path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "address_1": "string",
  • "address_2": "string",
  • "address_3": "string",
  • "city": "string",
  • "state": "string",
  • "full_name": "string",
  • "postal_code": "string",
  • "country": "AD",
  • "default_billing_address": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "user_id": 0
}

Update existing postal address

Update a postal address

path Parameters
id
required
string

Education ID

Request Body schema: application/x-www-form-urlencoded
postal_address[address_1]
string

Address line 1

postal_address[address_2]
string

Address line 2

postal_address[address_3]
string

Address line 3

postal_address[city]
string

City

postal_address[state]
string

State

postal_address[full_name]
string

Full name

postal_address[postal_code]
string

Zip code

postal_address[country]
string
Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW" "XK"

Country

postal_address[default_billing_address]
boolean

is the default billing address for the user ?

postal_address[created_at]
string <date-time>

Postal address creation date time - iso8601

postal_address[updated_at]
string <date-time>

Postal address last update date time - iso8601

postal_address[user_id]
integer <int32>

User ID linked to postal address

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "address_1": "string",
  • "address_2": "string",
  • "address_3": "string",
  • "city": "string",
  • "state": "string",
  • "full_name": "string",
  • "postal_code": "string",
  • "country": "AD",
  • "default_billing_address": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "user_id": 0
}

Return groups belonging of the user

Return groups linked to the user

path Parameters
user_id
required
integer <int32>
query Parameters
key
string
Enum: "external_id" "previous_id"
status
string
Enum: "following" "prospect"

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "email": "string",
  • "name": "string",
  • "sub_network_ids": [
    ],
  • "extended_updated_at": "2019-08-24T14:15:22Z",
  • "joined_at": "2019-08-24T14:15:22Z"
}

Get all users

Return an array of users with basic information

Use the param updated_since to fetch all users profile updated since this datetime (e.g. updated_since=2017-08-01T00:00:00)

Use the param confirmed_since to fetch all users profile confirmed since this datetime (e.g. confirmed_since=2017-08-01T00:00:00)

Use the param order to choose on which criterias the results should be ordered (e.g. order=updated_at to order by updated_at descending, use the minus operator to order by ascending value e.g. order=-updated_at).

Use the boolean full_profile to display the full profile of all users (e.g. full_profile=true). Maximum number of results per page with full_profile: 30.

Use the param user_ids to fetch only users with the specified IDs

Use the param sub_network_ids to fetch only users that are part of the specified sub networks (clusters).

Pagination information are stored in the response header as defined by RFC-5988 http://tools.ietf.org/html/rfc5988

Example:

{
"link": "<https://hivebrite.com/api/admin/v1/users?page=1&per_page=30>; rel=\"first\", <https://hivebrite.com/api/admin/v1/users?page=3&per_page=30>; rel=\"prev\", <https://hivebrite.com/api/admin/v1/users?page=2041&per_page=30>; rel=\"last\", <https://hivebrite.com/api/admin/v1/users?page=30&per_page=30>; rel=\"next\"",
"x-per-page": "30",
"x-total": "10201",
"x-page": "4"
}
query Parameters
page
integer <int32>
Default: 1

Page of results to fetch.

per_page
integer <int32>
Default: null

Number of results to return per page.

updated_since
string <date-time>
confirmed_since
string <date-time>
order
string
Enum: "id" "-id" "email" "-email" "extended_updated_at" "-extended_updated_at" "updated_at" "-updated_at" "firstname" "-firstname" "lastname" "-lastname" "maidenname" "-maidenname" "email2" "-email2" "email3" "-email3" "external_id" "-external_id" "sso_identifier" "-sso_identifier" "school_user_identifier" "-school_user_identifier" "is_active" "-is_active" "created_at" "-created_at" "deceased" "-deceased" "do_not_contact" "-do_not_contact"
full_profile
boolean
user_ids[]
Array of integers <int32> [ items <int32 > ]
sub_network_ids[]
Array of integers <int32> [ items <int32 > ]

Responses

Response samples

Content type
application/json
{
  • "users": [
    ]
}

Add a new user

Add a new user

Photo and resume must be sent as files (URL to files won't work)

Send invitation mail to the user

Set the params notify_after_create if you wish to automatically send an invitation to the user. Availables values to select on which email it should be sent are :

  • primary_email
  • email
  • email2
  • email3
  • email1then2
  • email1then2then3
  • email2then1
  • email3then2then1
  • email1and2
  • email1and2and3
Request Body schema: application/x-www-form-urlencoded
required
user[email]
required
string

User email

user[sub_network_ids][]
required
Array of integers <int32> [ items <int32 > ]

User sub networks ids

user[postal_personal][address_1]
string

Address line 1

user[postal_personal][address_2]
string

Address line 2

user[postal_personal][address_3]
string

Address line 3

user[postal_personal][city]
string

City

user[postal_personal][state]
string

State

user[postal_personal][full_name]
string

Full name

user[postal_personal][postal_code]
string

Zip code

user[postal_personal][country]
string
Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW" "XK"

Country

user[postal_personal][default_billing_address]
boolean

is the default billing address for the user ?

user[postal_personal][created_at]
string <date-time>

Postal address creation date time - iso8601

user[postal_personal][updated_at]
string <date-time>

Postal address last update date time - iso8601

user[postal_work][address_1]
string

Address line 1

user[postal_work][address_2]
string

Address line 2

user[postal_work][address_3]
string

Address line 3

user[postal_work][city]
string

City

user[postal_work][state]
string

State

user[postal_work][full_name]
string

Full name

user[postal_work][postal_code]
string

Zip code

user[postal_work][country]
string
Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW" "XK"

Country

user[postal_work][default_billing_address]
boolean

is the default billing address for the user ?

user[postal_work][created_at]
string <date-time>

Postal address creation date time - iso8601

user[postal_work][updated_at]
string <date-time>

Postal address last update date time - iso8601

user[live_location][city]
string

City

user[live_location][country]
string

Country

user[live_location][country_code]
string

ISO3166-2 Country code

user[live_location][address]
string

Address

user[live_location][lat]
number <float>

Latitude

user[live_location][lng]
number <float>

Longitude

user[config][private_profile]
boolean

Unique ID

user[config][opt_out_of_directory]
boolean

Unique ID

user[config][opt_out_of_group_directories][]
Array of objects

Unique ID

user[config][opt_out_of_messaging]
boolean

Opt out of messaging

user[config][share_gender]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of gender

user[config][share_prefix_firstname]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of prefix_firstname

user[config][share_honorary_title]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of honorary_title

user[config][share_prefix_name]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of prefix_name

user[config][share_suffix_name]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of suffix_name

user[config][share_maidenname]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of maidenname

user[config][share_birthday]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of birthday

user[config][share_birthplace]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of birthplace

user[config][share_headline]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of headline

user[config][share_live_location]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of live_location

user[config][share_sub_networks]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of sub_networks

user[config][share_nationalities]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of nationalities

user[config][share_resume]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of resume

user[config][share_summary]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of summary

user[config][share_industries]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of industries

user[config][share_skills]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of skills

user[config][share_facebook_profile_url]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of facebook_profile_url

user[config][share_instagram_profile_url]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of instagram_profile_url

user[config][share_twitter]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of twitter

user[config][share_skype]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of skype

user[config][share_linkedin_profile_url]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of linkedin_profile_url

user[config][share_website]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of website

user[config][share_bbm]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of bbm

user[config][share_email]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of email

user[config][share_email2]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of email2

user[config][share_email3]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of email3

user[config][share_mobile_perso]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of mobile_perso

user[config][share_landline_perso]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of landline_perso

user[config][share_mobile_pro]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of mobile_pro

user[config][share_landline_pro]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of landline_pro

user[config][share_postal_personal]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of postal_personal

user[config][share_postal_work]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of postal_work

user[config][share_memberships]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of memberships

user[config][share_educations]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of educations

user[config][share_experiences]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of experiences

user[extended_updated_at]
string <date-time>

User full profile ( with experiences, educations, customs) last update date time - iso8601

user[likes_count]
integer <int32>

Total count of likes on this Likeable

user[comments_count]
string

Total count of comment for this Commentable

user[email2]
string

User secondary email

user[email3]
string

User complementary email

user[primary_email_choice]
string
Enum: "email" "email2" "email3"

User primary email choice

user[firstname]
string

User first name

user[lastname]
string

User last name

user[maidenname]
string

User maiden name

user[prefix_firstname]
string

User prefix firstname

user[prefix_name]
string

User prefix name

user[suffix_name]
string

User suffix name

user[external_id]
string

User ID in your database

user[sso_identifier]
string

User identifier for SSO

user[previous_id]
string

User ID in your community system

user[last_visited_at]
string <date-time>

Date of last visit - iso8601. READ only, can't be updated

user[sign_in_count]
string

Number of platform visits. READ only, can't be updated

user[is_active]
boolean

User account enabled ?

user[gender]
string
Enum: "male" "female" "other"

User gender (male/female/other)

user[birthday]
string <date>

User birth date

user[birthplace]
string

User birth place

user[headline]
string

User headline

user[summary]
string

User summary

user[created_at]
string <date-time>

User creation date time - iso8601. READ only, can't be updated

user[updated_at]
string <date-time>

User last update date time - iso8601. READ only, can't be updated

user[citizenship_ids][]
Array of integers <int32> [ items <int32 > ]

List of citizenship IDs

user[citizenship_country_codes][]
Array of strings

List of ISO-3166-2 citizenship country codes

user[deceased]
boolean

User deceased ?

user[deceased_at]
string <date-time>

User decease date time - iso8601.

user[do_not_contact]
boolean

User can be contacted ?

user[mobile_perso]
string

User mobile perso number

user[mobile_pro]
string

User mobile pro number

user[landline_perso]
string

User landline perso number

user[landline_pro]
string

User landline pro number

user[preferred_phone_number]
string
Enum: "mobile_pro" "mobile_perso" "landline_pro" "landline_perso" "none"

User preferred phone number

user[preferred_postal_address]
string
Enum: "postal_personal" "postal_work"

User preferred postal address

user[role_id]
integer <int32>

User role ID

user[awards]
string

User awards

user[linkedin_profile_url]
string

User linkedin profile URL

user[website]
string

User Website URL

user[skype]
string

User skype profile

user[bbm]
string

User BlackBerry Messenger profile

user[twitter]
string

User twitter profile

user[timezone]
string
Enum: "Africa/Abidjan" "Africa/Algiers" "Africa/Bissau" "Africa/Cairo" "Africa/Casablanca" "Africa/Ceuta" "Africa/El_Aaiun" "Africa/Johannesburg" "Africa/Juba" "Africa/Khartoum" "Africa/Lagos" "Africa/Maputo" "Africa/Monrovia" "Africa/Nairobi" "Africa/Ndjamena" "Africa/Sao_Tome" "Africa/Tripoli" "Africa/Tunis" "Africa/Windhoek" "America/Adak" "America/Anchorage" "America/Araguaina" "America/Asuncion" "America/Bahia" "America/Bahia_Banderas" "America/Barbados" "America/Belem" "America/Belize" "America/North_Dakota/Beulah" "America/Boa_Vista" "America/Bogota" "America/Boise" "America/Argentina/Buenos_Aires" "America/Cambridge_Bay" "America/Campo_Grande" "America/Cancun" "America/Caracas" "America/Argentina/Catamarca" "America/Cayenne" "America/North_Dakota/Center" "America/Chicago" "America/Chihuahua" "America/Ciudad_Juarez" "America/Argentina/Cordoba" "America/Costa_Rica" "America/Cuiaba" "America/Danmarkshavn" "America/Dawson" "America/Dawson_Creek" "America/Denver" "America/Detroit" "America/Edmonton" "America/Eirunepe" "America/El_Salvador" "America/Fort_Nelson" "America/Fortaleza" "America/Glace_Bay" "America/Goose_Bay" "America/Grand_Turk" "America/Guatemala" "America/Guayaquil" "America/Guyana" "America/Halifax" "America/Havana" "America/Hermosillo" "America/Indiana/Indianapolis" "America/Inuvik" "America/Iqaluit" "America/Jamaica" "America/Argentina/Jujuy" "America/Juneau" "America/Indiana/Knox" "America/La_Paz" "America/Argentina/La_Rioja" "America/Lima" "America/Los_Angeles" "America/Kentucky/Louisville" "America/Maceio" "America/Managua" "America/Manaus" "America/Indiana/Marengo" "America/Martinique" "America/Matamoros" "America/Mazatlan" "America/Argentina/Mendoza" "America/Menominee" "America/Merida" "America/Metlakatla" "America/Mexico_City" "America/Miquelon" "America/Moncton" "America/Monterrey" "America/Montevideo" "America/Kentucky/Monticello" "America/North_Dakota/New_Salem" "America/New_York" "America/Nome" "America/Noronha" "America/Nuuk" "America/Ojinaga" "America/Panama" "America/Paramaribo" "America/Indiana/Petersburg" "America/Phoenix" "America/Port-au-Prince" "America/Porto_Velho" "America/Puerto_Rico" "America/Punta_Arenas" "America/Rankin_Inlet" "America/Recife" "America/Regina" "America/Resolute" "America/Rio_Branco" "America/Argentina/Rio_Gallegos" "America/Argentina/Salta" "America/Argentina/San_Juan" "America/Argentina/San_Luis" "America/Santarem" "America/Santiago" "America/Santo_Domingo" "America/Sao_Paulo" "America/Scoresbysund" "America/Sitka" "America/St_Johns" "America/Swift_Current" "America/Tegucigalpa" "America/Indiana/Tell_City" "America/Thule" "America/Tijuana" "America/Toronto" "America/Argentina/Tucuman" "America/Argentina/Ushuaia" "America/Vancouver" "America/Indiana/Vevay" "America/Indiana/Vincennes" "America/Whitehorse" "America/Indiana/Winamac" "America/Winnipeg" "America/Yakutat" "Antarctica/Casey" "Antarctica/Davis" "Antarctica/Macquarie" "Antarctica/Mawson" "Antarctica/Palmer" "Antarctica/Rothera" "Antarctica/Troll" "Antarctica/Vostok" "Asia/Almaty" "Asia/Amman" "Asia/Anadyr" "Asia/Aqtau" "Asia/Aqtobe" "Asia/Ashgabat" "Asia/Atyrau" "Asia/Baghdad" "Asia/Baku" "Asia/Bangkok" "Asia/Barnaul" "Asia/Beirut" "Asia/Bishkek" "Asia/Chita" "Asia/Colombo" "Asia/Damascus" "Asia/Dhaka" "Asia/Dili" "Asia/Dubai" "Asia/Dushanbe" "Asia/Famagusta" "Asia/Gaza" "Asia/Hebron" "Asia/Ho_Chi_Minh" "Asia/Hong_Kong" "Asia/Hovd" "Asia/Irkutsk" "Asia/Jakarta" "Asia/Jayapura" "Asia/Jerusalem" "Asia/Kabul" "Asia/Kamchatka" "Asia/Karachi" "Asia/Kathmandu" "Asia/Khandyga" "Asia/Kolkata" "Asia/Krasnoyarsk" "Asia/Kuching" "Asia/Macau" "Asia/Magadan" "Asia/Makassar" "Asia/Manila" "Asia/Nicosia" "Asia/Novokuznetsk" "Asia/Novosibirsk" "Asia/Omsk" "Asia/Oral" "Asia/Pontianak" "Asia/Pyongyang" "Asia/Qatar" "Asia/Qostanay" "Asia/Qyzylorda" "Asia/Riyadh" "Asia/Sakhalin" "Asia/Samarkand" "Asia/Seoul" "Asia/Shanghai" "Asia/Singapore" "Asia/Srednekolymsk" "Asia/Taipei" "Asia/Tashkent" "Asia/Tbilisi" "Asia/Tehran" "Asia/Thimphu" "Asia/Tokyo" "Asia/Tomsk" "Asia/Ulaanbaatar" "Asia/Urumqi" "Asia/Ust-Nera" "Asia/Vladivostok" "Asia/Yakutsk" "Asia/Yangon" "Asia/Yekaterinburg" "Asia/Yerevan" "Atlantic/Azores" "Atlantic/Bermuda" "Atlantic/Canary" "Atlantic/Cape_Verde" "Atlantic/Faroe" "Atlantic/Madeira" "Atlantic/South_Georgia" "Atlantic/Stanley" "Australia/Adelaide" "Australia/Brisbane" "Australia/Broken_Hill" "Australia/Darwin" "Australia/Eucla" "Australia/Hobart" "Australia/Lindeman" "Australia/Lord_Howe" "Australia/Melbourne" "Australia/Perth" "Australia/Sydney" "Etc/UTC" "Europe/Andorra" "Europe/Astrakhan" "Europe/Athens" "Europe/Belgrade" "Europe/Berlin" "Europe/Brussels" "Europe/Bucharest" "Europe/Budapest" "Europe/Chisinau" "Europe/Dublin" "Europe/Gibraltar" "Europe/Helsinki" "Europe/Istanbul" "Europe/Kaliningrad" "Europe/Kirov" "Europe/Kyiv" "Europe/Lisbon" "Europe/London" "Europe/Madrid" "Europe/Malta" "Europe/Minsk" "Europe/Moscow" "Europe/Paris" "Europe/Prague" "Europe/Riga" "Europe/Rome" "Europe/Samara" "Europe/Saratov" "Europe/Simferopol" "Europe/Sofia" "Europe/Tallinn" "Europe/Tirane" "Europe/Ulyanovsk" "Europe/Vienna" "Europe/Vilnius" "Europe/Volgograd" "Europe/Warsaw" "Europe/Zurich" "Indian/Chagos" "Indian/Maldives" "Indian/Mauritius" "Pacific/Apia" "Pacific/Auckland" "Pacific/Bougainville" "Pacific/Chatham" "Pacific/Easter" "Pacific/Efate" "Pacific/Fakaofo" "Pacific/Fiji" "Pacific/Galapagos" "Pacific/Gambier" "Pacific/Guadalcanal" "Pacific/Guam" "Pacific/Honolulu" "Pacific/Kanton" "Pacific/Kiritimati" "Pacific/Kosrae" "Pacific/Kwajalein" "Pacific/Marquesas" "Pacific/Nauru" "Pacific/Niue" "Pacific/Norfolk" "Pacific/Noumea" "Pacific/Pago_Pago" "Pacific/Palau" "Pacific/Pitcairn" "Pacific/Port_Moresby" "Pacific/Rarotonga" "Pacific/Tahiti" "Pacific/Tarawa" "Pacific/Tongatapu"

User timezone

user[facebook_profile_url]
string

User facebook profile URL

user[instagram_profile_url]
string

User instagram profile URL

user[honorary_title]
string
Enum: "mr" "mrs" "ms" "dr" "prof"

User's honorary title

user[locale]
string
Enum: "en" "en-GB" "fr" "he" "de" "es" "it" "da" "nl" "pt" "ru" "deepbloo" "zh-Hans" "zh-Hant" "af" "pl" "fi" "nl-BE" "nb" "ja" "lt" "hu" "vi" "sv" "ko" "pt-BR" "el" "cy" "hi" "id"

User Locale

user[share_email]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

User's visibility information regarding email

user[share_email2]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

User's visibility information regarding secondary email

user[share_email3]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

User's visibility information regarding complementary email

user[share_postal_address_personal]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

User's visibility information regarding postal home location

user[share_postal_address_work]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

User's visibility information regarding postal work location

user[share_nationalities]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

User's visibility information regarding nationalities

user[share_resume]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

User's visibility information regarding resume

user[share_mobile_pro]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

User's visibility information regarding work mobile phone

user[share_mobile_perso]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

User's visibility information regarding personal mobile phone

user[share_landline_pro]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

User's visibility information regarding professional landline phone

user[share_landline_perso]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

User's visibility information regarding personal landline phone

user[skills][]
Array of objects

READ ONLY, list of user skills

user[custom_attributes][]
Array of objects

Array of customizable attributes with name, value and type

user[photo]
string <binary>

User profile picture

user[resume]
string <binary>

Resume of the user

user[notify_after_create]
string
Enum: "primary_email" "email" "email2" "email3" "email1then2" "email1then2then3" "email2then1" "email3then2then1" "email1and2" "email1and2and3"

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "email": "string",
  • "name": "string",
  • "sub_network_ids": [
    ],
  • "extended_updated_at": "2019-08-24T14:15:22Z",
  • "likeable_type": "string",
  • "current_user_like_id": "string",
  • "likes_count": 0,
  • "commentable_type": "string",
  • "comments_count": "string",
  • "email2": "string",
  • "email3": "string",
  • "primary_email_choice": "email",
  • "firstname": "string",
  • "lastname": "string",
  • "maidenname": "string",
  • "prefix_firstname": "string",
  • "prefix_name": "string",
  • "suffix_name": "string",
  • "external_id": "string",
  • "sso_identifier": "string",
  • "previous_id": "string",
  • "last_visited_at": "2019-08-24T14:15:22Z",
  • "sign_in_count": "string",
  • "is_active": true,
  • "gender": "male",
  • "birthday": "2019-08-24",
  • "birthplace": "string",
  • "headline": "string",
  • "summary": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "confirmed_at": "2019-08-24T14:15:22Z",
  • "citizenship_ids": [
    ],
  • "citizenship_country_codes": [
    ],
  • "deceased": true,
  • "deceased_at": "2019-08-24T14:15:22Z",
  • "photo": {
    },
  • "do_not_contact": true,
  • "mobile_perso": "string",
  • "mobile_pro": "string",
  • "landline_perso": "string",
  • "landline_pro": "string",
  • "preferred_phone_number": "mobile_pro",
  • "postal_personal": {
    },
  • "postal_work": {
    },
  • "preferred_postal_address": "postal_personal",
  • "config": {
    },
  • "role_id": 0,
  • "awards": "string",
  • "linkedin_profile_url": "string",
  • "website": "string",
  • "skype": "string",
  • "bbm": "string",
  • "twitter": "string",
  • "timezone": "Africa/Abidjan",
  • "facebook_profile_url": "string",
  • "instagram_profile_url": "string",
  • "honorary_title": "mr",
  • "live_location": {
    },
  • "resume": "string",
  • "locale": "en",
  • "share_email": "with_admin",
  • "share_email2": "with_admin",
  • "share_email3": "with_admin",
  • "share_postal_address_personal": "with_admin",
  • "share_postal_address_work": "with_admin",
  • "share_nationalities": "with_admin",
  • "share_resume": "with_admin",
  • "share_mobile_pro": "with_admin",
  • "share_mobile_perso": "with_admin",
  • "share_landline_pro": "with_admin",
  • "share_landline_perso": "with_admin",
  • "skills": [
    ],
  • "custom_attributes": [
    ]
}

Get user profile

Return the user profile based on it's ID

Find the user matching this ID, or use external_id or previous_id as the key parameter to fetch the user on one of these identifier instead of default ID.

path Parameters
id
required
string
query Parameters
key
string
Enum: "external_id" "previous_id"

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "email": "string",
  • "name": "string",
  • "sub_network_ids": [
    ],
  • "extended_updated_at": "2019-08-24T14:15:22Z",
  • "likeable_type": "string",
  • "current_user_like_id": "string",
  • "likes_count": 0,
  • "commentable_type": "string",
  • "comments_count": "string",
  • "email2": "string",
  • "email3": "string",
  • "primary_email_choice": "email",
  • "firstname": "string",
  • "lastname": "string",
  • "maidenname": "string",
  • "prefix_firstname": "string",
  • "prefix_name": "string",
  • "suffix_name": "string",
  • "external_id": "string",
  • "sso_identifier": "string",
  • "previous_id": "string",
  • "last_visited_at": "2019-08-24T14:15:22Z",
  • "sign_in_count": "string",
  • "is_active": true,
  • "gender": "male",
  • "birthday": "2019-08-24",
  • "birthplace": "string",
  • "headline": "string",
  • "summary": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "confirmed_at": "2019-08-24T14:15:22Z",
  • "citizenship_ids": [
    ],
  • "citizenship_country_codes": [
    ],
  • "deceased": true,
  • "deceased_at": "2019-08-24T14:15:22Z",
  • "photo": {
    },
  • "do_not_contact": true,
  • "mobile_perso": "string",
  • "mobile_pro": "string",
  • "landline_perso": "string",
  • "landline_pro": "string",
  • "preferred_phone_number": "mobile_pro",
  • "postal_personal": {
    },
  • "postal_work": {
    },
  • "preferred_postal_address": "postal_personal",
  • "config": {
    },
  • "role_id": 0,
  • "awards": "string",
  • "linkedin_profile_url": "string",
  • "website": "string",
  • "skype": "string",
  • "bbm": "string",
  • "twitter": "string",
  • "timezone": "Africa/Abidjan",
  • "facebook_profile_url": "string",
  • "instagram_profile_url": "string",
  • "honorary_title": "mr",
  • "live_location": {
    },
  • "resume": "string",
  • "locale": "en",
  • "share_email": "with_admin",
  • "share_email2": "with_admin",
  • "share_email3": "with_admin",
  • "share_postal_address_personal": "with_admin",
  • "share_postal_address_work": "with_admin",
  • "share_nationalities": "with_admin",
  • "share_resume": "with_admin",
  • "share_mobile_pro": "with_admin",
  • "share_mobile_perso": "with_admin",
  • "share_landline_pro": "with_admin",
  • "share_landline_perso": "with_admin",
  • "skills": [
    ],
  • "custom_attributes": [
    ]
}

Update existing user

Update the user profile

Find the user matching this ID, or use external_id or previous_id as the key parameter to fetch the user on one of these identifier instead of default ID. Photo and resume must be sent as files (URL to files won't work)

path Parameters
id
required
string

User ID

Request Body schema: application/x-www-form-urlencoded
key
string
Enum: "external_id" "previous_id"
user[postal_personal][address_1]
string

Address line 1

user[postal_personal][address_2]
string

Address line 2

user[postal_personal][address_3]
string

Address line 3

user[postal_personal][city]
string

City

user[postal_personal][state]
string

State

user[postal_personal][full_name]
string

Full name

user[postal_personal][postal_code]
string

Zip code

user[postal_personal][country]
string
Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW" "XK"

Country

user[postal_personal][default_billing_address]
boolean

is the default billing address for the user ?

user[postal_personal][created_at]
string <date-time>

Postal address creation date time - iso8601

user[postal_personal][updated_at]
string <date-time>

Postal address last update date time - iso8601

user[postal_work][address_1]
string

Address line 1

user[postal_work][address_2]
string

Address line 2

user[postal_work][address_3]
string

Address line 3

user[postal_work][city]
string

City

user[postal_work][state]
string

State

user[postal_work][full_name]
string

Full name

user[postal_work][postal_code]
string

Zip code

user[postal_work][country]
string
Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW" "XK"

Country

user[postal_work][default_billing_address]
boolean

is the default billing address for the user ?

user[postal_work][created_at]
string <date-time>

Postal address creation date time - iso8601

user[postal_work][updated_at]
string <date-time>

Postal address last update date time - iso8601

user[live_location][city]
string

City

user[live_location][country]
string

Country

user[live_location][country_code]
string

ISO3166-2 Country code

user[live_location][address]
string

Address

user[live_location][lat]
number <float>

Latitude

user[live_location][lng]
number <float>

Longitude

user[config][private_profile]
boolean

Unique ID

user[config][opt_out_of_directory]
boolean

Unique ID

user[config][opt_out_of_group_directories][]
Array of objects

Unique ID

user[config][opt_out_of_messaging]
boolean

Opt out of messaging

user[config][share_gender]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of gender

user[config][share_prefix_firstname]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of prefix_firstname

user[config][share_honorary_title]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of honorary_title

user[config][share_prefix_name]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of prefix_name

user[config][share_suffix_name]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of suffix_name

user[config][share_maidenname]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of maidenname

user[config][share_birthday]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of birthday

user[config][share_birthplace]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of birthplace

user[config][share_headline]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of headline

user[config][share_live_location]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of live_location

user[config][share_sub_networks]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of sub_networks

user[config][share_nationalities]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of nationalities

user[config][share_resume]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of resume

user[config][share_summary]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of summary

user[config][share_industries]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of industries

user[config][share_skills]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of skills

user[config][share_facebook_profile_url]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of facebook_profile_url

user[config][share_instagram_profile_url]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of instagram_profile_url

user[config][share_twitter]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of twitter

user[config][share_skype]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of skype

user[config][share_linkedin_profile_url]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of linkedin_profile_url

user[config][share_website]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of website

user[config][share_bbm]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of bbm

user[config][share_email]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of email

user[config][share_email2]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of email2

user[config][share_email3]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of email3

user[config][share_mobile_perso]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of mobile_perso

user[config][share_landline_perso]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of landline_perso

user[config][share_mobile_pro]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of mobile_pro

user[config][share_landline_pro]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of landline_pro

user[config][share_postal_personal]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of postal_personal

user[config][share_postal_work]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of postal_work

user[config][share_memberships]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of memberships

user[config][share_educations]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of educations

user[config][share_experiences]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of experiences

user[email]
string

User email

user[sub_network_ids][]
Array of integers <int32> [ items <int32 > ]

IDs list of user sub networks

user[extended_updated_at]
string <date-time>

User full profile ( with experiences, educations, customs) last update date time - iso8601

user[likes_count]
integer <int32>

Total count of likes on this Likeable

user[comments_count]
string

Total count of comment for this Commentable

user[email2]
string

User secondary email

user[email3]
string

User complementary email

user[primary_email_choice]
string
Enum: "email" "email2" "email3"

User primary email choice

user[firstname]
string

User first name

user[lastname]
string

User last name

user[maidenname]
string

User maiden name

user[prefix_firstname]
string

User prefix firstname

user[prefix_name]
string

User prefix name

user[suffix_name]
string

User suffix name

user[external_id]
string

User ID in your database

user[sso_identifier]
string

User identifier for SSO

user[previous_id]
string

User ID in your community system

user[last_visited_at]
string <date-time>

Date of last visit - iso8601. READ only, can't be updated

user[sign_in_count]
string

Number of platform visits. READ only, can't be updated

user[is_active]
boolean

User account enabled ?

user[gender]
string
Enum: "male" "female" "other"

User gender (male/female/other)

user[birthday]
string <date>

User birth date

user[birthplace]
string

User birth place

user[headline]
string

User headline

user[summary]
string

User summary

user[created_at]
string <date-time>

User creation date time - iso8601. READ only, can't be updated

user[updated_at]
string <date-time>

User last update date time - iso8601. READ only, can't be updated

user[citizenship_ids][]
Array of integers <int32> [ items <int32 > ]

List of citizenship IDs

user[citizenship_country_codes][]
Array of strings

List of ISO-3166-2 citizenship country codes

user[deceased]
boolean

User deceased ?

user[deceased_at]
string <date-time>

User decease date time - iso8601.

user[do_not_contact]
boolean

User can be contacted ?

user[mobile_perso]
string

User mobile perso number

user[mobile_pro]
string

User mobile pro number

user[landline_perso]
string

User landline perso number

user[landline_pro]
string

User landline pro number

user[preferred_phone_number]
string
Enum: "mobile_pro" "mobile_perso" "landline_pro" "landline_perso" "none"

User preferred phone number

user[preferred_postal_address]
string
Enum: "postal_personal" "postal_work"

User preferred postal address

user[role_id]
integer <int32>

User role ID

user[awards]
string

User awards

user[linkedin_profile_url]
string

User linkedin profile URL

user[website]
string

User Website URL

user[skype]
string

User skype profile

user[bbm]
string

User BlackBerry Messenger profile

user[twitter]
string

User twitter profile

user[timezone]
string
Enum: "Africa/Abidjan" "Africa/Algiers" "Africa/Bissau" "Africa/Cairo" "Africa/Casablanca" "Africa/Ceuta" "Africa/El_Aaiun" "Africa/Johannesburg" "Africa/Juba" "Africa/Khartoum" "Africa/Lagos" "Africa/Maputo" "Africa/Monrovia" "Africa/Nairobi" "Africa/Ndjamena" "Africa/Sao_Tome" "Africa/Tripoli" "Africa/Tunis" "Africa/Windhoek" "America/Adak" "America/Anchorage" "America/Araguaina" "America/Asuncion" "America/Bahia" "America/Bahia_Banderas" "America/Barbados" "America/Belem" "America/Belize" "America/North_Dakota/Beulah" "America/Boa_Vista" "America/Bogota" "America/Boise" "America/Argentina/Buenos_Aires" "America/Cambridge_Bay" "America/Campo_Grande" "America/Cancun" "America/Caracas" "America/Argentina/Catamarca" "America/Cayenne" "America/North_Dakota/Center" "America/Chicago" "America/Chihuahua" "America/Ciudad_Juarez" "America/Argentina/Cordoba" "America/Costa_Rica" "America/Cuiaba" "America/Danmarkshavn" "America/Dawson" "America/Dawson_Creek" "America/Denver" "America/Detroit" "America/Edmonton" "America/Eirunepe" "America/El_Salvador" "America/Fort_Nelson" "America/Fortaleza" "America/Glace_Bay" "America/Goose_Bay" "America/Grand_Turk" "America/Guatemala" "America/Guayaquil" "America/Guyana" "America/Halifax" "America/Havana" "America/Hermosillo" "America/Indiana/Indianapolis" "America/Inuvik" "America/Iqaluit" "America/Jamaica" "America/Argentina/Jujuy" "America/Juneau" "America/Indiana/Knox" "America/La_Paz" "America/Argentina/La_Rioja" "America/Lima" "America/Los_Angeles" "America/Kentucky/Louisville" "America/Maceio" "America/Managua" "America/Manaus" "America/Indiana/Marengo" "America/Martinique" "America/Matamoros" "America/Mazatlan" "America/Argentina/Mendoza" "America/Menominee" "America/Merida" "America/Metlakatla" "America/Mexico_City" "America/Miquelon" "America/Moncton" "America/Monterrey" "America/Montevideo" "America/Kentucky/Monticello" "America/North_Dakota/New_Salem" "America/New_York" "America/Nome" "America/Noronha" "America/Nuuk" "America/Ojinaga" "America/Panama" "America/Paramaribo" "America/Indiana/Petersburg" "America/Phoenix" "America/Port-au-Prince" "America/Porto_Velho" "America/Puerto_Rico" "America/Punta_Arenas" "America/Rankin_Inlet" "America/Recife" "America/Regina" "America/Resolute" "America/Rio_Branco" "America/Argentina/Rio_Gallegos" "America/Argentina/Salta" "America/Argentina/San_Juan" "America/Argentina/San_Luis" "America/Santarem" "America/Santiago" "America/Santo_Domingo" "America/Sao_Paulo" "America/Scoresbysund" "America/Sitka" "America/St_Johns" "America/Swift_Current" "America/Tegucigalpa" "America/Indiana/Tell_City" "America/Thule" "America/Tijuana" "America/Toronto" "America/Argentina/Tucuman" "America/Argentina/Ushuaia" "America/Vancouver" "America/Indiana/Vevay" "America/Indiana/Vincennes" "America/Whitehorse" "America/Indiana/Winamac" "America/Winnipeg" "America/Yakutat" "Antarctica/Casey" "Antarctica/Davis" "Antarctica/Macquarie" "Antarctica/Mawson" "Antarctica/Palmer" "Antarctica/Rothera" "Antarctica/Troll" "Antarctica/Vostok" "Asia/Almaty" "Asia/Amman" "Asia/Anadyr" "Asia/Aqtau" "Asia/Aqtobe" "Asia/Ashgabat" "Asia/Atyrau" "Asia/Baghdad" "Asia/Baku" "Asia/Bangkok" "Asia/Barnaul" "Asia/Beirut" "Asia/Bishkek" "Asia/Chita" "Asia/Colombo" "Asia/Damascus" "Asia/Dhaka" "Asia/Dili" "Asia/Dubai" "Asia/Dushanbe" "Asia/Famagusta" "Asia/Gaza" "Asia/Hebron" "Asia/Ho_Chi_Minh" "Asia/Hong_Kong" "Asia/Hovd" "Asia/Irkutsk" "Asia/Jakarta" "Asia/Jayapura" "Asia/Jerusalem" "Asia/Kabul" "Asia/Kamchatka" "Asia/Karachi" "Asia/Kathmandu" "Asia/Khandyga" "Asia/Kolkata" "Asia/Krasnoyarsk" "Asia/Kuching" "Asia/Macau" "Asia/Magadan" "Asia/Makassar" "Asia/Manila" "Asia/Nicosia" "Asia/Novokuznetsk" "Asia/Novosibirsk" "Asia/Omsk" "Asia/Oral" "Asia/Pontianak" "Asia/Pyongyang" "Asia/Qatar" "Asia/Qostanay" "Asia/Qyzylorda" "Asia/Riyadh" "Asia/Sakhalin" "Asia/Samarkand" "Asia/Seoul" "Asia/Shanghai" "Asia/Singapore" "Asia/Srednekolymsk" "Asia/Taipei" "Asia/Tashkent" "Asia/Tbilisi" "Asia/Tehran" "Asia/Thimphu" "Asia/Tokyo" "Asia/Tomsk" "Asia/Ulaanbaatar" "Asia/Urumqi" "Asia/Ust-Nera" "Asia/Vladivostok" "Asia/Yakutsk" "Asia/Yangon" "Asia/Yekaterinburg" "Asia/Yerevan" "Atlantic/Azores" "Atlantic/Bermuda" "Atlantic/Canary" "Atlantic/Cape_Verde" "Atlantic/Faroe" "Atlantic/Madeira" "Atlantic/South_Georgia" "Atlantic/Stanley" "Australia/Adelaide" "Australia/Brisbane" "Australia/Broken_Hill" "Australia/Darwin" "Australia/Eucla" "Australia/Hobart" "Australia/Lindeman" "Australia/Lord_Howe" "Australia/Melbourne" "Australia/Perth" "Australia/Sydney" "Etc/UTC" "Europe/Andorra" "Europe/Astrakhan" "Europe/Athens" "Europe/Belgrade" "Europe/Berlin" "Europe/Brussels" "Europe/Bucharest" "Europe/Budapest" "Europe/Chisinau" "Europe/Dublin" "Europe/Gibraltar" "Europe/Helsinki" "Europe/Istanbul" "Europe/Kaliningrad" "Europe/Kirov" "Europe/Kyiv" "Europe/Lisbon" "Europe/London" "Europe/Madrid" "Europe/Malta" "Europe/Minsk" "Europe/Moscow" "Europe/Paris" "Europe/Prague" "Europe/Riga" "Europe/Rome" "Europe/Samara" "Europe/Saratov" "Europe/Simferopol" "Europe/Sofia" "Europe/Tallinn" "Europe/Tirane" "Europe/Ulyanovsk" "Europe/Vienna" "Europe/Vilnius" "Europe/Volgograd" "Europe/Warsaw" "Europe/Zurich" "Indian/Chagos" "Indian/Maldives" "Indian/Mauritius" "Pacific/Apia" "Pacific/Auckland" "Pacific/Bougainville" "Pacific/Chatham" "Pacific/Easter" "Pacific/Efate" "Pacific/Fakaofo" "Pacific/Fiji" "Pacific/Galapagos" "Pacific/Gambier" "Pacific/Guadalcanal" "Pacific/Guam" "Pacific/Honolulu" "Pacific/Kanton" "Pacific/Kiritimati" "Pacific/Kosrae" "Pacific/Kwajalein" "Pacific/Marquesas" "Pacific/Nauru" "Pacific/Niue" "Pacific/Norfolk" "Pacific/Noumea" "Pacific/Pago_Pago" "Pacific/Palau" "Pacific/Pitcairn" "Pacific/Port_Moresby" "Pacific/Rarotonga" "Pacific/Tahiti" "Pacific/Tarawa" "Pacific/Tongatapu"

User timezone

user[facebook_profile_url]
string

User facebook profile URL

user[instagram_profile_url]
string

User instagram profile URL

user[honorary_title]
string
Enum: "mr" "mrs" "ms" "dr" "prof"

User's honorary title

user[locale]
string
Enum: "en" "en-GB" "fr" "he" "de" "es" "it" "da" "nl" "pt" "ru" "deepbloo" "zh-Hans" "zh-Hant" "af" "pl" "fi" "nl-BE" "nb" "ja" "lt" "hu" "vi" "sv" "ko" "pt-BR" "el" "cy" "hi" "id"

User Locale

user[share_email]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

User's visibility information regarding email

user[share_email2]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

User's visibility information regarding secondary email

user[share_email3]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

User's visibility information regarding complementary email

user[share_postal_address_personal]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

User's visibility information regarding postal home location

user[share_postal_address_work]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

User's visibility information regarding postal work location

user[share_nationalities]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

User's visibility information regarding nationalities

user[share_resume]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

User's visibility information regarding resume

user[share_mobile_pro]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

User's visibility information regarding work mobile phone

user[share_mobile_perso]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

User's visibility information regarding personal mobile phone

user[share_landline_pro]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

User's visibility information regarding professional landline phone

user[share_landline_perso]
string
Enum: "with_admin" "with_all" "with_bookmarked_users"

User's visibility information regarding personal landline phone

user[skills][]
Array of objects

READ ONLY, list of user skills

user[custom_attributes][]
Array of objects

Array of customizable attributes with name, value and type

user[photo]
string <binary>

Profile picture of the user

user[resume]
string <binary>

Resume of the user

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "email": "string",
  • "name": "string",
  • "sub_network_ids": [
    ],
  • "extended_updated_at": "2019-08-24T14:15:22Z",
  • "likeable_type": "string",
  • "current_user_like_id": "string",
  • "likes_count": 0,
  • "commentable_type": "string",
  • "comments_count": "string",
  • "email2": "string",
  • "email3": "string",
  • "primary_email_choice": "email",
  • "firstname": "string",
  • "lastname": "string",
  • "maidenname": "string",
  • "prefix_firstname": "string",
  • "prefix_name": "string",
  • "suffix_name": "string",
  • "external_id": "string",
  • "sso_identifier": "string",
  • "previous_id": "string",
  • "last_visited_at": "2019-08-24T14:15:22Z",
  • "sign_in_count": "string",
  • "is_active": true,
  • "gender": "male",
  • "birthday": "2019-08-24",
  • "birthplace": "string",
  • "headline": "string",
  • "summary": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "confirmed_at": "2019-08-24T14:15:22Z",
  • "citizenship_ids": [
    ],
  • "citizenship_country_codes": [
    ],
  • "deceased": true,
  • "deceased_at": "2019-08-24T14:15:22Z",
  • "photo": {
    },
  • "do_not_contact": true,
  • "mobile_perso": "string",
  • "mobile_pro": "string",
  • "landline_perso": "string",
  • "landline_pro": "string",
  • "preferred_phone_number": "mobile_pro",
  • "postal_personal": {
    },
  • "postal_work": {
    },
  • "preferred_postal_address": "postal_personal",
  • "config": {
    },
  • "role_id": 0,
  • "awards": "string",
  • "linkedin_profile_url": "string",
  • "website": "string",
  • "skype": "string",
  • "bbm": "string",
  • "twitter": "string",
  • "timezone": "Africa/Abidjan",
  • "facebook_profile_url": "string",
  • "instagram_profile_url": "string",
  • "honorary_title": "mr",
  • "live_location": {
    },
  • "resume": "string",
  • "locale": "en",
  • "share_email": "with_admin",
  • "share_email2": "with_admin",
  • "share_email3": "with_admin",
  • "share_postal_address_personal": "with_admin",
  • "share_postal_address_work": "with_admin",
  • "share_nationalities": "with_admin",
  • "share_resume": "with_admin",
  • "share_mobile_pro": "with_admin",
  • "share_mobile_perso": "with_admin",
  • "share_landline_pro": "with_admin",
  • "share_landline_perso": "with_admin",
  • "skills": [
    ],
  • "custom_attributes": [
    ]
}

Delete User

Delete the user based on it's ID

path Parameters
id
required
string
query Parameters
key
string
Enum: "external_id" "previous_id"

Responses

Find a user by a specific field

Find a user by a specific field

Find a user by a specific field. Supported fields are external_id, previous_id, or email.

Request Body schema: application/x-www-form-urlencoded
required
field
required
string
Enum: "external_id" "previous_id" "email"
value
required
string

Responses

Bulk add users

Batch creation of users

Photo and resume must be sent as files (URL to files won't work)

Send invitation mail to the user

Set the params notify_after_create if you wish to automatically send an invitation to the user. Availables values to select on which email it should be sent are :

  • primary_email
  • email
  • email2
  • email3
  • email1then2
  • email1then2then3
  • email2then1
  • email3then2then1
  • email1and2
  • email1and2and3

WARNING: Swagger generated example of the parameters is false! You should use an array of users data

{
  "users": [
    // User 1
    {
      "email": "string",
      "sub_network_ids": [
        0
      ],
      ...
    },
    // User 2
    {
      "email": "string",
      "sub_network_ids": [
        0
      ],
      ...
    }
  ]
}

Errors

If any users failed to save, the whole transaction is rollbacked

Request Body schema: application/x-www-form-urlencoded
required
users[][email]
required
Array of strings

User email

users[][sub_network_ids][]
required
Array of integers <int32> [ items <int32 > ]

User sub networks ids

users[][postal_personal][address_1]
Array of strings

Address line 1

users[][postal_personal][address_2]
Array of strings

Address line 2

users[][postal_personal][address_3]
Array of strings

Address line 3

users[][postal_personal][city]
Array of strings

City

users[][postal_personal][state]
Array of strings

State

users[][postal_personal][full_name]
Array of strings

Full name

users[][postal_personal][postal_code]
Array of strings

Zip code

users[][postal_personal][country]
Array of strings
Items Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW" "XK"

Country

users[][postal_personal][default_billing_address]
Array of booleans

is the default billing address for the user ?

users[][postal_personal][created_at]
Array of strings <date-time> [ items <date-time > ]

Postal address creation date time - iso8601

users[][postal_personal][updated_at]
Array of strings <date-time> [ items <date-time > ]

Postal address last update date time - iso8601

users[][postal_work][address_1]
Array of strings

Address line 1

users[][postal_work][address_2]
Array of strings

Address line 2

users[][postal_work][address_3]
Array of strings

Address line 3

users[][postal_work][city]
Array of strings

City

users[][postal_work][state]
Array of strings

State

users[][postal_work][full_name]
Array of strings

Full name

users[][postal_work][postal_code]
Array of strings

Zip code

users[][postal_work][country]
Array of strings
Items Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW" "XK"

Country

users[][postal_work][default_billing_address]
Array of booleans

is the default billing address for the user ?

users[][postal_work][created_at]
Array of strings <date-time> [ items <date-time > ]

Postal address creation date time - iso8601

users[][postal_work][updated_at]
Array of strings <date-time> [ items <date-time > ]

Postal address last update date time - iso8601

users[][live_location][city]
Array of strings

City

users[][live_location][country]
Array of strings

Country

users[][live_location][country_code]
Array of strings

ISO3166-2 Country code

users[][live_location][address]
Array of strings

Address

users[][live_location][lat]
Array of numbers <float> [ items <float > ]

Latitude

users[][live_location][lng]
Array of numbers <float> [ items <float > ]

Longitude

users[][config][private_profile]
Array of booleans

Unique ID

users[][config][opt_out_of_directory]
Array of booleans

Unique ID

users[][config][opt_out_of_group_directories][]
Array of objects

Unique ID

users[][config][opt_out_of_messaging]
Array of booleans

Opt out of messaging

users[][config][share_gender]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of gender

users[][config][share_prefix_firstname]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of prefix_firstname

users[][config][share_honorary_title]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of honorary_title

users[][config][share_prefix_name]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of prefix_name

users[][config][share_suffix_name]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of suffix_name

users[][config][share_maidenname]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of maidenname

users[][config][share_birthday]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of birthday

users[][config][share_birthplace]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of birthplace

users[][config][share_headline]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of headline

users[][config][share_live_location]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of live_location

users[][config][share_sub_networks]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of sub_networks

users[][config][share_nationalities]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of nationalities

users[][config][share_resume]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of resume

users[][config][share_summary]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of summary

users[][config][share_industries]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of industries

users[][config][share_skills]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of skills

users[][config][share_facebook_profile_url]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of facebook_profile_url

users[][config][share_instagram_profile_url]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of instagram_profile_url

users[][config][share_twitter]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of twitter

users[][config][share_skype]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of skype

users[][config][share_linkedin_profile_url]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of linkedin_profile_url

users[][config][share_website]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of website

users[][config][share_bbm]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of bbm

users[][config][share_email]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of email

users[][config][share_email2]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of email2

users[][config][share_email3]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of email3

users[][config][share_mobile_perso]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of mobile_perso

users[][config][share_landline_perso]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of landline_perso

users[][config][share_mobile_pro]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of mobile_pro

users[][config][share_landline_pro]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of landline_pro

users[][config][share_postal_personal]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of postal_personal

users[][config][share_postal_work]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of postal_work

users[][config][share_memberships]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of memberships

users[][config][share_educations]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of educations

users[][config][share_experiences]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of experiences

users[][extended_updated_at]
Array of strings <date-time> [ items <date-time > ]

User full profile ( with experiences, educations, customs) last update date time - iso8601

users[][likes_count]
Array of integers <int32> [ items <int32 > ]

Total count of likes on this Likeable

users[][comments_count]
Array of strings

Total count of comment for this Commentable

users[][email2]
Array of strings

User secondary email

users[][email3]
Array of strings

User complementary email

users[][primary_email_choice]
Array of strings
Items Enum: "email" "email2" "email3"

User primary email choice

users[][firstname]
Array of strings

User first name

users[][lastname]
Array of strings

User last name

users[][maidenname]
Array of strings

User maiden name

users[][prefix_firstname]
Array of strings

User prefix firstname

users[][prefix_name]
Array of strings

User prefix name

users[][suffix_name]
Array of strings

User suffix name

users[][external_id]
Array of strings

User ID in your database

users[][sso_identifier]
Array of strings

User identifier for SSO

users[][previous_id]
Array of strings

User ID in your community system

users[][last_visited_at]
Array of strings <date-time> [ items <date-time > ]

Date of last visit - iso8601. READ only, can't be updated

users[][sign_in_count]
Array of strings

Number of platform visits. READ only, can't be updated

users[][is_active]
Array of booleans

User account enabled ?

users[][gender]
Array of strings
Items Enum: "male" "female" "other"

User gender (male/female/other)

users[][birthday]
Array of strings <date> [ items <date > ]

User birth date

users[][birthplace]
Array of strings

User birth place

users[][headline]
Array of strings

User headline

users[][summary]
Array of strings

User summary

users[][created_at]
Array of strings <date-time> [ items <date-time > ]

User creation date time - iso8601. READ only, can't be updated

users[][updated_at]
Array of strings <date-time> [ items <date-time > ]

User last update date time - iso8601. READ only, can't be updated

users[][citizenship_ids][]
Array of strings <int32> [ items <int32 > ]

List of citizenship IDs

users[][citizenship_country_codes][]
Array of strings

List of ISO-3166-2 citizenship country codes

users[][deceased]
Array of booleans

User deceased ?

users[][deceased_at]
Array of strings <date-time> [ items <date-time > ]

User decease date time - iso8601.

users[][do_not_contact]
Array of booleans

User can be contacted ?

users[][mobile_perso]
Array of strings

User mobile perso number

users[][mobile_pro]
Array of strings

User mobile pro number

users[][landline_perso]
Array of strings

User landline perso number

users[][landline_pro]
Array of strings

User landline pro number

users[][preferred_phone_number]
Array of strings
Items Enum: "mobile_pro" "mobile_perso" "landline_pro" "landline_perso" "none"

User preferred phone number

users[][preferred_postal_address]
Array of strings
Items Enum: "postal_personal" "postal_work"

User preferred postal address

users[][role_id]
Array of integers <int32> [ items <int32 > ]

User role ID

users[][awards]
Array of strings

User awards

users[][linkedin_profile_url]
Array of strings

User linkedin profile URL

users[][website]
Array of strings

User Website URL

users[][skype]
Array of strings

User skype profile

users[][bbm]
Array of strings

User BlackBerry Messenger profile

users[][twitter]
Array of strings

User twitter profile

users[][timezone]
Array of strings
Items Enum: "Africa/Abidjan" "Africa/Algiers" "Africa/Bissau" "Africa/Cairo" "Africa/Casablanca" "Africa/Ceuta" "Africa/El_Aaiun" "Africa/Johannesburg" "Africa/Juba" "Africa/Khartoum" "Africa/Lagos" "Africa/Maputo" "Africa/Monrovia" "Africa/Nairobi" "Africa/Ndjamena" "Africa/Sao_Tome" "Africa/Tripoli" "Africa/Tunis" "Africa/Windhoek" "America/Adak" "America/Anchorage" "America/Araguaina" "America/Asuncion" "America/Bahia" "America/Bahia_Banderas" "America/Barbados" "America/Belem" "America/Belize" "America/North_Dakota/Beulah" "America/Boa_Vista" "America/Bogota" "America/Boise" "America/Argentina/Buenos_Aires" "America/Cambridge_Bay" "America/Campo_Grande" "America/Cancun" "America/Caracas" "America/Argentina/Catamarca" "America/Cayenne" "America/North_Dakota/Center" "America/Chicago" "America/Chihuahua" "America/Ciudad_Juarez" "America/Argentina/Cordoba" "America/Costa_Rica" "America/Cuiaba" "America/Danmarkshavn" "America/Dawson" "America/Dawson_Creek" "America/Denver" "America/Detroit" "America/Edmonton" "America/Eirunepe" "America/El_Salvador" "America/Fort_Nelson" "America/Fortaleza" "America/Glace_Bay" "America/Goose_Bay" "America/Grand_Turk" "America/Guatemala" "America/Guayaquil" "America/Guyana" "America/Halifax" "America/Havana" "America/Hermosillo" "America/Indiana/Indianapolis" "America/Inuvik" "America/Iqaluit" "America/Jamaica" "America/Argentina/Jujuy" "America/Juneau" "America/Indiana/Knox" "America/La_Paz" "America/Argentina/La_Rioja" "America/Lima" "America/Los_Angeles" "America/Kentucky/Louisville" "America/Maceio" "America/Managua" "America/Manaus" "America/Indiana/Marengo" "America/Martinique" "America/Matamoros" "America/Mazatlan" "America/Argentina/Mendoza" "America/Menominee" "America/Merida" "America/Metlakatla" "America/Mexico_City" "America/Miquelon" "America/Moncton" "America/Monterrey" "America/Montevideo" "America/Kentucky/Monticello" "America/North_Dakota/New_Salem" "America/New_York" "America/Nome" "America/Noronha" "America/Nuuk" "America/Ojinaga" "America/Panama" "America/Paramaribo" "America/Indiana/Petersburg" "America/Phoenix" "America/Port-au-Prince" "America/Porto_Velho" "America/Puerto_Rico" "America/Punta_Arenas" "America/Rankin_Inlet" "America/Recife" "America/Regina" "America/Resolute" "America/Rio_Branco" "America/Argentina/Rio_Gallegos" "America/Argentina/Salta" "America/Argentina/San_Juan" "America/Argentina/San_Luis" "America/Santarem" "America/Santiago" "America/Santo_Domingo" "America/Sao_Paulo" "America/Scoresbysund" "America/Sitka" "America/St_Johns" "America/Swift_Current" "America/Tegucigalpa" "America/Indiana/Tell_City" "America/Thule" "America/Tijuana" "America/Toronto" "America/Argentina/Tucuman" "America/Argentina/Ushuaia" "America/Vancouver" "America/Indiana/Vevay" "America/Indiana/Vincennes" "America/Whitehorse" "America/Indiana/Winamac" "America/Winnipeg" "America/Yakutat" "Antarctica/Casey" "Antarctica/Davis" "Antarctica/Macquarie" "Antarctica/Mawson" "Antarctica/Palmer" "Antarctica/Rothera" "Antarctica/Troll" "Antarctica/Vostok" "Asia/Almaty" "Asia/Amman" "Asia/Anadyr" "Asia/Aqtau" "Asia/Aqtobe" "Asia/Ashgabat" "Asia/Atyrau" "Asia/Baghdad" "Asia/Baku" "Asia/Bangkok" "Asia/Barnaul" "Asia/Beirut" "Asia/Bishkek" "Asia/Chita" "Asia/Colombo" "Asia/Damascus" "Asia/Dhaka" "Asia/Dili" "Asia/Dubai" "Asia/Dushanbe" "Asia/Famagusta" "Asia/Gaza" "Asia/Hebron" "Asia/Ho_Chi_Minh" "Asia/Hong_Kong" "Asia/Hovd" "Asia/Irkutsk" "Asia/Jakarta" "Asia/Jayapura" "Asia/Jerusalem" "Asia/Kabul" "Asia/Kamchatka" "Asia/Karachi" "Asia/Kathmandu" "Asia/Khandyga" "Asia/Kolkata" "Asia/Krasnoyarsk" "Asia/Kuching" "Asia/Macau" "Asia/Magadan" "Asia/Makassar" "Asia/Manila" "Asia/Nicosia" "Asia/Novokuznetsk" "Asia/Novosibirsk" "Asia/Omsk" "Asia/Oral" "Asia/Pontianak" "Asia/Pyongyang" "Asia/Qatar" "Asia/Qostanay" "Asia/Qyzylorda" "Asia/Riyadh" "Asia/Sakhalin" "Asia/Samarkand" "Asia/Seoul" "Asia/Shanghai" "Asia/Singapore" "Asia/Srednekolymsk" "Asia/Taipei" "Asia/Tashkent" "Asia/Tbilisi" "Asia/Tehran" "Asia/Thimphu" "Asia/Tokyo" "Asia/Tomsk" "Asia/Ulaanbaatar" "Asia/Urumqi" "Asia/Ust-Nera" "Asia/Vladivostok" "Asia/Yakutsk" "Asia/Yangon" "Asia/Yekaterinburg" "Asia/Yerevan" "Atlantic/Azores" "Atlantic/Bermuda" "Atlantic/Canary" "Atlantic/Cape_Verde" "Atlantic/Faroe" "Atlantic/Madeira" "Atlantic/South_Georgia" "Atlantic/Stanley" "Australia/Adelaide" "Australia/Brisbane" "Australia/Broken_Hill" "Australia/Darwin" "Australia/Eucla" "Australia/Hobart" "Australia/Lindeman" "Australia/Lord_Howe" "Australia/Melbourne" "Australia/Perth" "Australia/Sydney" "Etc/UTC" "Europe/Andorra" "Europe/Astrakhan" "Europe/Athens" "Europe/Belgrade" "Europe/Berlin" "Europe/Brussels" "Europe/Bucharest" "Europe/Budapest" "Europe/Chisinau" "Europe/Dublin" "Europe/Gibraltar" "Europe/Helsinki" "Europe/Istanbul" "Europe/Kaliningrad" "Europe/Kirov" "Europe/Kyiv" "Europe/Lisbon" "Europe/London" "Europe/Madrid" "Europe/Malta" "Europe/Minsk" "Europe/Moscow" "Europe/Paris" "Europe/Prague" "Europe/Riga" "Europe/Rome" "Europe/Samara" "Europe/Saratov" "Europe/Simferopol" "Europe/Sofia" "Europe/Tallinn" "Europe/Tirane" "Europe/Ulyanovsk" "Europe/Vienna" "Europe/Vilnius" "Europe/Volgograd" "Europe/Warsaw" "Europe/Zurich" "Indian/Chagos" "Indian/Maldives" "Indian/Mauritius" "Pacific/Apia" "Pacific/Auckland" "Pacific/Bougainville" "Pacific/Chatham" "Pacific/Easter" "Pacific/Efate" "Pacific/Fakaofo" "Pacific/Fiji" "Pacific/Galapagos" "Pacific/Gambier" "Pacific/Guadalcanal" "Pacific/Guam" "Pacific/Honolulu" "Pacific/Kanton" "Pacific/Kiritimati" "Pacific/Kosrae" "Pacific/Kwajalein" "Pacific/Marquesas" "Pacific/Nauru" "Pacific/Niue" "Pacific/Norfolk" "Pacific/Noumea" "Pacific/Pago_Pago" "Pacific/Palau" "Pacific/Pitcairn" "Pacific/Port_Moresby" "Pacific/Rarotonga" "Pacific/Tahiti" "Pacific/Tarawa" "Pacific/Tongatapu"

User timezone

users[][facebook_profile_url]
Array of strings

User facebook profile URL

users[][instagram_profile_url]
Array of strings

User instagram profile URL

users[][honorary_title]
Array of strings
Items Enum: "mr" "mrs" "ms" "dr" "prof"

User's honorary title

users[][locale]
Array of strings
Items Enum: "en" "en-GB" "fr" "he" "de" "es" "it" "da" "nl" "pt" "ru" "deepbloo" "zh-Hans" "zh-Hant" "af" "pl" "fi" "nl-BE" "nb" "ja" "lt" "hu" "vi" "sv" "ko" "pt-BR" "el" "cy" "hi" "id"

User Locale

users[][share_email]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

User's visibility information regarding email

users[][share_email2]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

User's visibility information regarding secondary email

users[][share_email3]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

User's visibility information regarding complementary email

users[][share_postal_address_personal]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

User's visibility information regarding postal home location

users[][share_postal_address_work]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

User's visibility information regarding postal work location

users[][share_nationalities]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

User's visibility information regarding nationalities

users[][share_resume]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

User's visibility information regarding resume

users[][share_mobile_pro]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

User's visibility information regarding work mobile phone

users[][share_mobile_perso]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

User's visibility information regarding personal mobile phone

users[][share_landline_pro]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

User's visibility information regarding professional landline phone

users[][share_landline_perso]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

User's visibility information regarding personal landline phone

users[][skills][]
Array of strings

READ ONLY, list of user skills

users[][custom_attributes][]
Array of strings

Array of customizable attributes with name, value and type

users[][photo]
Array of file

Profile picture of the user

users[][resume]
Array of file

Resume of the user

users[][notify_after_create]
Array of strings
Items Enum: "primary_email" "email" "email2" "email3" "email1then2" "email1then2then3" "email2then1" "email3then2then1" "email1and2" "email1and2and3"

Responses

Response samples

Content type
application/json
{
  • "users": [
    ]
}

Bulk update of existing users

Batch update of users

Find users using the ID setted in the users hash, or set external_id or previous_id as the key parameter to fetch users on these identifier instead of default ID, and set the correct value for the ID params in users. Photo and resume must be sent as files (URL to files won't work)

WARNING: Swagger generated example of the parameters is false! You should use an array of users data

{
  "users": [
    // User 1
    {
      "id": 1,
      "email": "string",
      "sub_network_ids": [
        0
      ],
      ...
    },
    // User 2
    {
      "id": 2,
      "email": "string",
      "sub_network_ids": [
        0
      ],
      ...
    }
  ]
}

Errors

If any users failed to update, the whole transaction is rollbacked

Request Body schema: application/x-www-form-urlencoded
key
string
Enum: "external_id" "previous_id"
users[][id]
required
Array of strings

User ID

users[][postal_personal][address_1]
Array of strings

Address line 1

users[][postal_personal][address_2]
Array of strings

Address line 2

users[][postal_personal][address_3]
Array of strings

Address line 3

users[][postal_personal][city]
Array of strings

City

users[][postal_personal][state]
Array of strings

State

users[][postal_personal][full_name]
Array of strings

Full name

users[][postal_personal][postal_code]
Array of strings

Zip code

users[][postal_personal][country]
Array of strings
Items Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW" "XK"

Country

users[][postal_personal][default_billing_address]
Array of booleans

is the default billing address for the user ?

users[][postal_personal][created_at]
Array of strings <date-time> [ items <date-time > ]

Postal address creation date time - iso8601

users[][postal_personal][updated_at]
Array of strings <date-time> [ items <date-time > ]

Postal address last update date time - iso8601

users[][postal_work][address_1]
Array of strings

Address line 1

users[][postal_work][address_2]
Array of strings

Address line 2

users[][postal_work][address_3]
Array of strings

Address line 3

users[][postal_work][city]
Array of strings

City

users[][postal_work][state]
Array of strings

State

users[][postal_work][full_name]
Array of strings

Full name

users[][postal_work][postal_code]
Array of strings

Zip code

users[][postal_work][country]
Array of strings
Items Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW" "XK"

Country

users[][postal_work][default_billing_address]
Array of booleans

is the default billing address for the user ?

users[][postal_work][created_at]
Array of strings <date-time> [ items <date-time > ]

Postal address creation date time - iso8601

users[][postal_work][updated_at]
Array of strings <date-time> [ items <date-time > ]

Postal address last update date time - iso8601

users[][live_location][city]
Array of strings

City

users[][live_location][country]
Array of strings

Country

users[][live_location][country_code]
Array of strings

ISO3166-2 Country code

users[][live_location][address]
Array of strings

Address

users[][live_location][lat]
Array of numbers <float> [ items <float > ]

Latitude

users[][live_location][lng]
Array of numbers <float> [ items <float > ]

Longitude

users[][config][private_profile]
Array of booleans

Unique ID

users[][config][opt_out_of_directory]
Array of booleans

Unique ID

users[][config][opt_out_of_group_directories][]
Array of objects

Unique ID

users[][config][opt_out_of_messaging]
Array of booleans

Opt out of messaging

users[][config][share_gender]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of gender

users[][config][share_prefix_firstname]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of prefix_firstname

users[][config][share_honorary_title]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of honorary_title

users[][config][share_prefix_name]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of prefix_name

users[][config][share_suffix_name]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of suffix_name

users[][config][share_maidenname]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of maidenname

users[][config][share_birthday]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of birthday

users[][config][share_birthplace]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of birthplace

users[][config][share_headline]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of headline

users[][config][share_live_location]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of live_location

users[][config][share_sub_networks]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of sub_networks

users[][config][share_nationalities]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of nationalities

users[][config][share_resume]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of resume

users[][config][share_summary]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of summary

users[][config][share_industries]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of industries

users[][config][share_skills]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of skills

users[][config][share_facebook_profile_url]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of facebook_profile_url

users[][config][share_instagram_profile_url]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of instagram_profile_url

users[][config][share_twitter]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of twitter

users[][config][share_skype]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of skype

users[][config][share_linkedin_profile_url]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of linkedin_profile_url

users[][config][share_website]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of website

users[][config][share_bbm]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of bbm

users[][config][share_email]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of email

users[][config][share_email2]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of email2

users[][config][share_email3]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of email3

users[][config][share_mobile_perso]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of mobile_perso

users[][config][share_landline_perso]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of landline_perso

users[][config][share_mobile_pro]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of mobile_pro

users[][config][share_landline_pro]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of landline_pro

users[][config][share_postal_personal]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of postal_personal

users[][config][share_postal_work]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of postal_work

users[][config][share_memberships]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of memberships

users[][config][share_educations]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of educations

users[][config][share_experiences]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

Privacy sharing status of experiences

users[][email]
Array of strings

User email

users[][sub_network_ids][]
Array of integers <int32> [ items <int32 > ]

IDs list of user sub networks

users[][extended_updated_at]
Array of strings <date-time> [ items <date-time > ]

User full profile ( with experiences, educations, customs) last update date time - iso8601

users[][likes_count]
Array of integers <int32> [ items <int32 > ]

Total count of likes on this Likeable

users[][comments_count]
Array of strings

Total count of comment for this Commentable

users[][email2]
Array of strings

User secondary email

users[][email3]
Array of strings

User complementary email

users[][primary_email_choice]
Array of strings
Items Enum: "email" "email2" "email3"

User primary email choice

users[][firstname]
Array of strings

User first name

users[][lastname]
Array of strings

User last name

users[][maidenname]
Array of strings

User maiden name

users[][prefix_firstname]
Array of strings

User prefix firstname

users[][prefix_name]
Array of strings

User prefix name

users[][suffix_name]
Array of strings

User suffix name

users[][external_id]
Array of strings

User ID in your database

users[][sso_identifier]
Array of strings

User identifier for SSO

users[][previous_id]
Array of strings

User ID in your community system

users[][last_visited_at]
Array of strings <date-time> [ items <date-time > ]

Date of last visit - iso8601. READ only, can't be updated

users[][sign_in_count]
Array of strings

Number of platform visits. READ only, can't be updated

users[][is_active]
Array of booleans

User account enabled ?

users[][gender]
Array of strings
Items Enum: "male" "female" "other"

User gender (male/female/other)

users[][birthday]
Array of strings <date> [ items <date > ]

User birth date

users[][birthplace]
Array of strings

User birth place

users[][headline]
Array of strings

User headline

users[][summary]
Array of strings

User summary

users[][created_at]
Array of strings <date-time> [ items <date-time > ]

User creation date time - iso8601. READ only, can't be updated

users[][updated_at]
Array of strings <date-time> [ items <date-time > ]

User last update date time - iso8601. READ only, can't be updated

users[][citizenship_ids][]
Array of integers <int32> [ items <int32 > ]

List of citizenship IDs

users[][citizenship_country_codes][]
Array of strings

List of ISO-3166-2 citizenship country codes

users[][deceased]
Array of booleans

User deceased ?

users[][deceased_at]
Array of strings <date-time> [ items <date-time > ]

User decease date time - iso8601.

users[][do_not_contact]
Array of booleans

User can be contacted ?

users[][mobile_perso]
Array of strings

User mobile perso number

users[][mobile_pro]
Array of strings

User mobile pro number

users[][landline_perso]
Array of strings

User landline perso number

users[][landline_pro]
Array of strings

User landline pro number

users[][preferred_phone_number]
Array of strings
Items Enum: "mobile_pro" "mobile_perso" "landline_pro" "landline_perso" "none"

User preferred phone number

users[][preferred_postal_address]
Array of strings
Items Enum: "postal_personal" "postal_work"

User preferred postal address

users[][role_id]
Array of integers <int32> [ items <int32 > ]

User role ID

users[][awards]
Array of strings

User awards

users[][linkedin_profile_url]
Array of strings

User linkedin profile URL

users[][website]
Array of strings

User Website URL

users[][skype]
Array of strings

User skype profile

users[][bbm]
Array of strings

User BlackBerry Messenger profile

users[][twitter]
Array of strings

User twitter profile

users[][timezone]
Array of strings
Items Enum: "Africa/Abidjan" "Africa/Algiers" "Africa/Bissau" "Africa/Cairo" "Africa/Casablanca" "Africa/Ceuta" "Africa/El_Aaiun" "Africa/Johannesburg" "Africa/Juba" "Africa/Khartoum" "Africa/Lagos" "Africa/Maputo" "Africa/Monrovia" "Africa/Nairobi" "Africa/Ndjamena" "Africa/Sao_Tome" "Africa/Tripoli" "Africa/Tunis" "Africa/Windhoek" "America/Adak" "America/Anchorage" "America/Araguaina" "America/Asuncion" "America/Bahia" "America/Bahia_Banderas" "America/Barbados" "America/Belem" "America/Belize" "America/North_Dakota/Beulah" "America/Boa_Vista" "America/Bogota" "America/Boise" "America/Argentina/Buenos_Aires" "America/Cambridge_Bay" "America/Campo_Grande" "America/Cancun" "America/Caracas" "America/Argentina/Catamarca" "America/Cayenne" "America/North_Dakota/Center" "America/Chicago" "America/Chihuahua" "America/Ciudad_Juarez" "America/Argentina/Cordoba" "America/Costa_Rica" "America/Cuiaba" "America/Danmarkshavn" "America/Dawson" "America/Dawson_Creek" "America/Denver" "America/Detroit" "America/Edmonton" "America/Eirunepe" "America/El_Salvador" "America/Fort_Nelson" "America/Fortaleza" "America/Glace_Bay" "America/Goose_Bay" "America/Grand_Turk" "America/Guatemala" "America/Guayaquil" "America/Guyana" "America/Halifax" "America/Havana" "America/Hermosillo" "America/Indiana/Indianapolis" "America/Inuvik" "America/Iqaluit" "America/Jamaica" "America/Argentina/Jujuy" "America/Juneau" "America/Indiana/Knox" "America/La_Paz" "America/Argentina/La_Rioja" "America/Lima" "America/Los_Angeles" "America/Kentucky/Louisville" "America/Maceio" "America/Managua" "America/Manaus" "America/Indiana/Marengo" "America/Martinique" "America/Matamoros" "America/Mazatlan" "America/Argentina/Mendoza" "America/Menominee" "America/Merida" "America/Metlakatla" "America/Mexico_City" "America/Miquelon" "America/Moncton" "America/Monterrey" "America/Montevideo" "America/Kentucky/Monticello" "America/North_Dakota/New_Salem" "America/New_York" "America/Nome" "America/Noronha" "America/Nuuk" "America/Ojinaga" "America/Panama" "America/Paramaribo" "America/Indiana/Petersburg" "America/Phoenix" "America/Port-au-Prince" "America/Porto_Velho" "America/Puerto_Rico" "America/Punta_Arenas" "America/Rankin_Inlet" "America/Recife" "America/Regina" "America/Resolute" "America/Rio_Branco" "America/Argentina/Rio_Gallegos" "America/Argentina/Salta" "America/Argentina/San_Juan" "America/Argentina/San_Luis" "America/Santarem" "America/Santiago" "America/Santo_Domingo" "America/Sao_Paulo" "America/Scoresbysund" "America/Sitka" "America/St_Johns" "America/Swift_Current" "America/Tegucigalpa" "America/Indiana/Tell_City" "America/Thule" "America/Tijuana" "America/Toronto" "America/Argentina/Tucuman" "America/Argentina/Ushuaia" "America/Vancouver" "America/Indiana/Vevay" "America/Indiana/Vincennes" "America/Whitehorse" "America/Indiana/Winamac" "America/Winnipeg" "America/Yakutat" "Antarctica/Casey" "Antarctica/Davis" "Antarctica/Macquarie" "Antarctica/Mawson" "Antarctica/Palmer" "Antarctica/Rothera" "Antarctica/Troll" "Antarctica/Vostok" "Asia/Almaty" "Asia/Amman" "Asia/Anadyr" "Asia/Aqtau" "Asia/Aqtobe" "Asia/Ashgabat" "Asia/Atyrau" "Asia/Baghdad" "Asia/Baku" "Asia/Bangkok" "Asia/Barnaul" "Asia/Beirut" "Asia/Bishkek" "Asia/Chita" "Asia/Colombo" "Asia/Damascus" "Asia/Dhaka" "Asia/Dili" "Asia/Dubai" "Asia/Dushanbe" "Asia/Famagusta" "Asia/Gaza" "Asia/Hebron" "Asia/Ho_Chi_Minh" "Asia/Hong_Kong" "Asia/Hovd" "Asia/Irkutsk" "Asia/Jakarta" "Asia/Jayapura" "Asia/Jerusalem" "Asia/Kabul" "Asia/Kamchatka" "Asia/Karachi" "Asia/Kathmandu" "Asia/Khandyga" "Asia/Kolkata" "Asia/Krasnoyarsk" "Asia/Kuching" "Asia/Macau" "Asia/Magadan" "Asia/Makassar" "Asia/Manila" "Asia/Nicosia" "Asia/Novokuznetsk" "Asia/Novosibirsk" "Asia/Omsk" "Asia/Oral" "Asia/Pontianak" "Asia/Pyongyang" "Asia/Qatar" "Asia/Qostanay" "Asia/Qyzylorda" "Asia/Riyadh" "Asia/Sakhalin" "Asia/Samarkand" "Asia/Seoul" "Asia/Shanghai" "Asia/Singapore" "Asia/Srednekolymsk" "Asia/Taipei" "Asia/Tashkent" "Asia/Tbilisi" "Asia/Tehran" "Asia/Thimphu" "Asia/Tokyo" "Asia/Tomsk" "Asia/Ulaanbaatar" "Asia/Urumqi" "Asia/Ust-Nera" "Asia/Vladivostok" "Asia/Yakutsk" "Asia/Yangon" "Asia/Yekaterinburg" "Asia/Yerevan" "Atlantic/Azores" "Atlantic/Bermuda" "Atlantic/Canary" "Atlantic/Cape_Verde" "Atlantic/Faroe" "Atlantic/Madeira" "Atlantic/South_Georgia" "Atlantic/Stanley" "Australia/Adelaide" "Australia/Brisbane" "Australia/Broken_Hill" "Australia/Darwin" "Australia/Eucla" "Australia/Hobart" "Australia/Lindeman" "Australia/Lord_Howe" "Australia/Melbourne" "Australia/Perth" "Australia/Sydney" "Etc/UTC" "Europe/Andorra" "Europe/Astrakhan" "Europe/Athens" "Europe/Belgrade" "Europe/Berlin" "Europe/Brussels" "Europe/Bucharest" "Europe/Budapest" "Europe/Chisinau" "Europe/Dublin" "Europe/Gibraltar" "Europe/Helsinki" "Europe/Istanbul" "Europe/Kaliningrad" "Europe/Kirov" "Europe/Kyiv" "Europe/Lisbon" "Europe/London" "Europe/Madrid" "Europe/Malta" "Europe/Minsk" "Europe/Moscow" "Europe/Paris" "Europe/Prague" "Europe/Riga" "Europe/Rome" "Europe/Samara" "Europe/Saratov" "Europe/Simferopol" "Europe/Sofia" "Europe/Tallinn" "Europe/Tirane" "Europe/Ulyanovsk" "Europe/Vienna" "Europe/Vilnius" "Europe/Volgograd" "Europe/Warsaw" "Europe/Zurich" "Indian/Chagos" "Indian/Maldives" "Indian/Mauritius" "Pacific/Apia" "Pacific/Auckland" "Pacific/Bougainville" "Pacific/Chatham" "Pacific/Easter" "Pacific/Efate" "Pacific/Fakaofo" "Pacific/Fiji" "Pacific/Galapagos" "Pacific/Gambier" "Pacific/Guadalcanal" "Pacific/Guam" "Pacific/Honolulu" "Pacific/Kanton" "Pacific/Kiritimati" "Pacific/Kosrae" "Pacific/Kwajalein" "Pacific/Marquesas" "Pacific/Nauru" "Pacific/Niue" "Pacific/Norfolk" "Pacific/Noumea" "Pacific/Pago_Pago" "Pacific/Palau" "Pacific/Pitcairn" "Pacific/Port_Moresby" "Pacific/Rarotonga" "Pacific/Tahiti" "Pacific/Tarawa" "Pacific/Tongatapu"

User timezone

users[][facebook_profile_url]
Array of strings

User facebook profile URL

users[][instagram_profile_url]
Array of strings

User instagram profile URL

users[][honorary_title]
Array of strings
Items Enum: "mr" "mrs" "ms" "dr" "prof"

User's honorary title

users[][locale]
Array of strings
Items Enum: "en" "en-GB" "fr" "he" "de" "es" "it" "da" "nl" "pt" "ru" "deepbloo" "zh-Hans" "zh-Hant" "af" "pl" "fi" "nl-BE" "nb" "ja" "lt" "hu" "vi" "sv" "ko" "pt-BR" "el" "cy" "hi" "id"

User Locale

users[][share_email]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

User's visibility information regarding email

users[][share_email2]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

User's visibility information regarding secondary email

users[][share_email3]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

User's visibility information regarding complementary email

users[][share_postal_address_personal]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

User's visibility information regarding postal home location

users[][share_postal_address_work]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

User's visibility information regarding postal work location

users[][share_nationalities]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

User's visibility information regarding nationalities

users[][share_resume]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

User's visibility information regarding resume

users[][share_mobile_pro]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

User's visibility information regarding work mobile phone

users[][share_mobile_perso]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

User's visibility information regarding personal mobile phone

users[][share_landline_pro]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

User's visibility information regarding professional landline phone

users[][share_landline_perso]
Array of strings
Items Enum: "with_admin" "with_all" "with_bookmarked_users"

User's visibility information regarding personal landline phone

users[][skills][]
Array of objects

READ ONLY, list of user skills

users[][custom_attributes][]
Array of objects

Array of customizable attributes with name, value and type

users[][photo]
Array of file

Profile picture of the user

users[][resume]
Array of file

Resume of the user

Responses

Response samples

Content type
application/json
{
  • "users": [
    ]
}

Notify User

Notify user

Send invitation mail to the user

Set the params recipient_type to send an invitation to the user. Availables values to select on which email it should be sent are :

  • email
  • email2
  • email1then2
  • email2then1
  • email1and2
path Parameters
id
required
string
Request Body schema: application/x-www-form-urlencoded
key
string
Enum: "external_id" "previous_id"
recipient_type
required
string
Enum: "primary_email" "email" "email2" "email3" "email1then2" "email1then2then3" "email2then1" "email3then2then1" "email1and2" "email1and2and3"

Responses

Delete a User

Delete the user based on it's ID

Delete the user matching this ID, or use external_id or previous_id as the key parameter to fetch the user on one of these identifier instead of default ID.

path Parameters
id
required
string
query Parameters
key
string
Enum: "external_id" "previous_id"

Responses

Customizable Attribute Creation

Customizable Attribute creation for User

Required params are :

  • a Type,
  • a Display name

For DoubleSelect, the json_options params must be formatted the following way

{
  // ...
  "json_options": {
    "options": {
      "Parent Option A": [
        "Parent A, Child 1",
        "Parent A, Child 2",
        "Parent A, Child 3"
      ],
      "Parent Option B": [
        "Parent B, Child 1",
        "Parent B, Child 2",
        "Parent B, Child 3"
      ]
    }
  }
}
Request Body schema: application/x-www-form-urlencoded
required
customizable_attribute[type]
required
string
Enum: "CustomizableAttribute::Boolean" "CustomizableAttribute::Date" "CustomizableAttribute::DoubleSelect" "CustomizableAttribute::Number" "CustomizableAttribute::Select" "CustomizableAttribute::Text"
customizable_attribute[display_name]
string

Customizable Attribute displayed name

customizable_attribute[text_size]
integer <int32>
customizable_attribute[tooltip]
string

Customizable Attribute tooltip

customizable_attribute[placeholder]
string

Customizable Attribute placeholder

customizable_attribute[multi]
boolean

Customizable Attribute multi activated ?

customizable_attribute[visibility]
string
Enum: "admin_only" "tagged_user" "everybody" "not_visible"

Customizable Attribute visibility

customizable_attribute[user_editable]
boolean

Customizable Attribute editable by the user ?

customizable_attribute[required]
boolean

Customizable Attribute required ?

customizable_attribute[options][]
Array of strings

Customizable Attribute array of options

customizable_attribute[selected_value]
string

Customizable Attribute selected value

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "customizable_id": 0,
  • "type": "CustomizableAttribute::Boolean",
  • "customizable_type": "bizopp",
  • "name": "string",
  • "display_name": "string",
  • "tooltip": "string",
  • "placeholder": "string",
  • "multi": true,
  • "text_size": 0,
  • "visibility": "admin_only",
  • "user_editable": true,
  • "required": true,
  • "options": [
    ],
  • "json_options": { },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "selected_value": "string"
}

Customizable Attribute Update

Update a customizable attribute

The customizable attribute can be retrieved on the /api/admin/v1/settings/customizable_attributes endpoint.

For DoubleSelect, the json_options params must be formatted the following way

{
  // ...
  "json_options": {
    "options": {
      "Parent Option A": [
        "Parent A, Child 1",
        "Parent A, Child 2",
        "Parent A, Child 3"
      ],
      "Parent Option B": [
        "Parent B, Child 1",
        "Parent B, Child 2",
        "Parent B, Child 3"
      ]
    }
  }
}
Request Body schema: application/x-www-form-urlencoded
required
id
required
integer <int32>
customizable_attribute[display_name]
string

Customizable Attribute displayed name

customizable_attribute[tooltip]
string

Customizable Attribute tooltip

customizable_attribute[placeholder]
string

Customizable Attribute placeholder

customizable_attribute[multi]
boolean

Customizable Attribute multi activated ?

customizable_attribute[visibility]
string
Enum: "admin_only" "tagged_user" "everybody" "not_visible"

Customizable Attribute visibility

customizable_attribute[user_editable]
boolean

Customizable Attribute editable by the user ?

customizable_attribute[required]
boolean

Customizable Attribute required ?

customizable_attribute[options][]
Array of strings

Customizable Attribute array of options

customizable_attribute[selected_value]
string

Customizable Attribute selected value

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "customizable_id": 0,
  • "type": "CustomizableAttribute::Boolean",
  • "customizable_type": "bizopp",
  • "name": "string",
  • "display_name": "string",
  • "tooltip": "string",
  • "placeholder": "string",
  • "multi": true,
  • "text_size": 0,
  • "visibility": "admin_only",
  • "user_editable": true,
  • "required": true,
  • "options": [
    ],
  • "json_options": { },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "selected_value": "string"
}

Customizable Attribute Deletion

Destroy a Customizable Attribute

The customizable attributes of the Users can be retrieved on the /api/admin/v1/settings/customizable_attributes endpoint. BEWARE: This will delete the Users' answers to this customizable attribute as well as the customizable attributes linked to the Users.

query Parameters
id
required
integer <int32>

Responses

experiences

Operations about experiences

Get all experiences

Return an array of experiences with basic information

Use the param updated_since to fetch all experiences updated since this datetime (e.g. updated_since=2017-08-01T00:00:00)

Use the param order to choose on which criterias the results should be ordered (e.g. order=updated_at to order by updated_at descending, use the minus operator to order by ascending value e.g. order=-updated_at).

Pagination information are stored in the response header as defined by RFC-5988 http://tools.ietf.org/html/rfc5988

Example:

{
"link": "<https://hivebrite.com/api/admin/v1/experiences?page=1&per_page=30>; rel=\"first\", <https://hivebrite.com/api/admin/v1/experiences?page=3&per_page=30>; rel=\"prev\", <https://hivebrite.com/api/admin/v1/experiences?page=2041&per_page=30>; rel=\"last\", <https://hivebrite.com/api/admin/v1/experiences?page=30&per_page=30>; rel=\"next\"",
"x-per-page": "30",
"x-total": "10201",
"x-page": "4"
}
query Parameters
order
string
Enum: "id" "-id" "position" "-position" "from" "-from" "to" "-to" "external_id" "-external_id" "created_at" "-created_at" "extended_updated_at" "-extended_updated_at" "updated_at" "-updated_at" "companies_company_id" "-companies_company_id"
updated_since
string <date-time>
filter[user_key]
string
Enum: "external_id" "previous_id"
filter[user_id]
string

User ID attached to the experience

filter[id]
integer <int32>

Unique ID

filter[position]
string

Experience position

filter[from]
string <date>

Experience started at

filter[to]
string <date>

Experience ended at

filter[companies_company_id]
string

ID of company linked

filter[industry_id]
integer <int32>

Industry ID matching the experience

filter[job_function_id]
integer <int32>

Job Function ID matching the experience

filter[external_id]
string

Experience ID in your database

filter[created_at]
string <date-time>

Experience creation date

filter[updated_at]
string <date-time>

Experience last update date time - iso8601

page
integer <int32>
Default: 1

Page of results to fetch.

per_page
integer <int32>
Default: null

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "experiences": [
    ]
}

Get user experience

Return the user experience based on its ID

Find the user experience matching its ID, or use external_id as the experience_key parameter to identify the experience on one of these identifier instead of default ID.

path Parameters
id
required
integer <int32>
query Parameters
experience_key
string
Value: "external_id"

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "position": "string",
  • "from": "2019-08-24",
  • "to": "2019-08-24",
  • "custom_attributes": [
    ],
  • "external_id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "user_id": 0,
  • "industry": {
    },
  • "job_function": {
    },
  • "company": {
    },
  • "extended_updated_at": "2019-08-24T14:15:22Z"
}

Update existing user experience

Update a user experience

Find the user experience matching its ID, or use external_id as the experience_key parameter to identify the experience instead of default ID.

path Parameters
id
required
string

Experience ID

Request Body schema: application/x-www-form-urlencoded
experience_key
string
Value: "external_id"
experience[companies_company_key]
string
Value: "external_id"
experience[position]
string

Experience position

experience[from]
string <date>

Experience started at

experience[to]
string <date>

Experience ended at

experience[companies_company_id]
string

ID of company linked

experience[custom_attributes][]
Array of objects

Array of customizable attributes with name, value and type

experience[industry_id]
integer <int32>

Industry ID matching the experience

experience[job_function_id]
integer <int32>

Job Function ID matching the experience

experience[external_id]
string

Experience ID in your database

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "position": "string",
  • "from": "2019-08-24",
  • "to": "2019-08-24",
  • "custom_attributes": [
    ],
  • "external_id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "user_id": 0,
  • "industry": {
    },
  • "job_function": {
    },
  • "company": {
    },
  • "extended_updated_at": "2019-08-24T14:15:22Z"
}

Delete User experience

Delete the user experience based on its ID

Use external_id as the experience_key parameter to identify the experience instead of default experience ID.

path Parameters
id
required
string
query Parameters
experience_key
string
Value: "external_id"

Responses

Customizable Attribute Creation

Customizable Attribute creation for Experiences

Required params are :

  • a Type,
  • a Display name
  • if the Type is a Select, a 'options' array of possible choice
  • if the Type is a DoubleSelect, a 'json_options' hash with values like so :
      {
    // ...
    "json_options": {
      "options": {
        "Parent Option A": [
          "Parent A, Child 1",
          "Parent A, Child 2",
          "Parent A, Child 3"
        ],
        "Parent Option B": [
          "Parent B, Child 1",
          "Parent B, Child 2",
          "Parent B, Child 3"
        ]
      }
    }
  }
Request Body schema: application/x-www-form-urlencoded
required
customizable_attribute[type]
required
string
Enum: "CustomizableAttribute::Boolean" "CustomizableAttribute::Date" "CustomizableAttribute::DoubleSelect" "CustomizableAttribute::Number" "CustomizableAttribute::Select" "CustomizableAttribute::Text"
customizable_attribute[display_name]
string

Customizable Attribute displayed name

customizable_attribute[text_size]
integer <int32>

Customizable Attribute text_size

customizable_attribute[tooltip]
string

Customizable Attribute tooltip

customizable_attribute[placeholder]
string

Customizable Attribute placeholder

customizable_attribute[multi]
boolean

Customizable Attribute multi activated ?

customizable_attribute[visibility]
string
Enum: "admin_only" "tagged_user" "everybody" "not_visible"

Customizable Attribute visibility

customizable_attribute[user_editable]
boolean

Customizable Attribute editable by the user ?

customizable_attribute[required]
boolean

Customizable Attribute required ?

customizable_attribute[options][]
Array of strings

Customizable Attribute array of options

customizable_attribute[selected_value]
string

Customizable Attribute selected value

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "customizable_id": 0,
  • "type": "CustomizableAttribute::Boolean",
  • "customizable_type": "bizopp",
  • "name": "string",
  • "display_name": "string",
  • "tooltip": "string",
  • "placeholder": "string",
  • "multi": true,
  • "text_size": 0,
  • "visibility": "admin_only",
  • "user_editable": true,
  • "required": true,
  • "options": [
    ],
  • "json_options": { },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "selected_value": "string"
}

Customizable Attribute Update

Update a customizable attribute

The customizable attribute can be retrieved on the /api/admin/v1/settings/customizable_attributes endpoint.

For DoubleSelect, the json_options params must be formatted the following way

{
  // ...
  "json_options": {
    "options": {
      "Parent Option A": [
        "Parent A, Child 1",
        "Parent A, Child 2",
        "Parent A, Child 3"
      ],
      "Parent Option B": [
        "Parent B, Child 1",
        "Parent B, Child 2",
        "Parent B, Child 3"
      ]
    }
  }
}
Request Body schema: application/x-www-form-urlencoded
required
id
required
integer <int32>
customizable_attribute[display_name]
string

Customizable Attribute displayed name

customizable_attribute[tooltip]
string

Customizable Attribute tooltip

customizable_attribute[placeholder]
string

Customizable Attribute placeholder

customizable_attribute[multi]
boolean

Customizable Attribute multi activated ?

customizable_attribute[text_size]
integer <int32>

Customizable Attribute text_size

customizable_attribute[visibility]
string
Enum: "admin_only" "tagged_user" "everybody" "not_visible"

Customizable Attribute visibility

customizable_attribute[user_editable]
boolean

Customizable Attribute editable by the user ?

customizable_attribute[required]
boolean

Customizable Attribute required ?

customizable_attribute[options][]
Array of strings

Customizable Attribute array of options

customizable_attribute[selected_value]
string

Customizable Attribute selected value

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "customizable_id": 0,
  • "type": "CustomizableAttribute::Boolean",
  • "customizable_type": "bizopp",
  • "name": "string",
  • "display_name": "string",
  • "tooltip": "string",
  • "placeholder": "string",
  • "multi": true,
  • "text_size": 0,
  • "visibility": "admin_only",
  • "user_editable": true,
  • "required": true,
  • "options": [
    ],
  • "json_options": { },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "selected_value": "string"
}

Customizable Attribute Deletion

Destroy a Customizable Attribute

The customizable attributes of an experience can be retrieved on the /api/admin/v1/settings/customizable_attributes endpoint. BEWARE: This will delete the answers to this customizable attribute in all user experiences as well as the customizable attributes linked to the experience.

query Parameters
id
required
integer <int32>

Responses

educations

Operations about educations

Get all user educations

Return an array of educations with basic informations

Use the param updated_since to fetch all educations updated since this datetime (e.g. updated_since=2017-08-01T00:00:00)

Use the param order to choose on which criterias the results should be ordered (e.g. order=updated_at to order by updated_at descending, use the minus operator to order by ascending value e.g. order=-updated_at).

Pagination information are stored in the response header as defined by RFC-5988 http://tools.ietf.org/html/rfc5988

Example:

{
"link": "<https://hivebrite.com/api/admin/v1/educations?page=1&per_page=30>; rel=\"first\", <https://hivebrite.com/api/admin/v1/educations?page=3&per_page=30>; rel=\"prev\", <https://hivebrite.com/api/admin/v1//educations?page=2041&per_page=30>; rel=\"last\", <https://hivebrite.com/api/admin/v1/educations?page=30&per_page=30>; rel=\"next\"",
"x-per-page": "30",
"x-total": "10201",
"x-page": "4"
}
query Parameters
page
integer <int32>
Default: 1

Page of results to fetch.

per_page
integer <int32>
Default: null

Number of results to return per page.

order
string
Enum: "id" "-id" "school_name" "-school_name" "degree" "-degree" "from" "-from" "to" "-to" "external_id" "-external_id" "created_at" "-created_at" "extended_updated_at" "-extended_updated_at" "updated_at" "-updated_at"
updated_since
string <date-time>
filter[user_key]
string
Enum: "external_id" "previous_id"
filter[user_id]
string

User ID attached to the education

filter[id]
integer <int32>

Unique ID

filter[school_name]
string

Education school

filter[degree]
string

Education degree

filter[from]
string <date>

Education started at

filter[to]
string <date>

Education ended at

filter[field_of_study_id]
integer <int32>

Field of study ID matching the education

filter[field_of_study_name]
string

Field of study name (from Field of study Object linked)

filter[external_id]
string

Education ID in your database

filter[user_can_edit]
boolean

Is this education editable by the user

filter[created_at]
string <date-time>

Education creation date

filter[updated_at]
string <date-time>

Education last update date time - iso8601

Responses

Response samples

Content type
application/json
{
  • "educations": [
    ]
}

Get user education

Return the user education based on its ID

Find the user education matching its ID, or use external_id as the education_key parameter to identify the education instead of default education ID.

path Parameters
id
required
integer <int32>
query Parameters
education_key
string
Value: "external_id"

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "school_name": "string",
  • "degree": "string",
  • "from": "2019-08-24",
  • "to": "2019-08-24",
  • "custom_attributes": [
    ],
  • "external_id": "string",
  • "user_can_edit": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "user_id": 0,
  • "field_of_study": {
    },
  • "extended_updated_at": "2019-08-24T14:15:22Z"
}

Update existing user education

Update a user education

Find the user education matching its ID,or use external_id as the education_key parameter to identify the education instead of default Education ID.

path Parameters
id
required
string

Education ID

Request Body schema: application/x-www-form-urlencoded
education_key
string
Value: "external_id"
education[degree]
string

Education degree

education[from]
string <date>

Education started at

education[to]
string <date>

Education ended at

education[custom_attributes][]
Array of objects

Array of customizable attributes with name, value and type

education[field_of_study_id]
integer <int32>

Field of study ID matching the education

education[field_of_study_name]
string

Field of study name (from Field of study Object linked)

education[external_id]
string

Education ID in your database

education[user_can_edit]
boolean

Is this education editable by the user

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "school_name": "string",
  • "degree": "string",
  • "from": "2019-08-24",
  • "to": "2019-08-24",
  • "custom_attributes": [
    ],
  • "external_id": "string",
  • "user_can_edit": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "user_id": 0,
  • "field_of_study": {
    },
  • "extended_updated_at": "2019-08-24T14:15:22Z"
}

Delete User education 

          ## Delete the user education based on its ID
          Use `external_id`as the **education_key** parameter to identify the education instead of default education ID.
path Parameters
id
required
string
query Parameters
education_key
string
Value: "external_id"

Responses

Get all user educations

Return an array of educations with basic informations

Use the param updated_since to fetch all educations updated since this datetime (e.g. updated_since=2017-08-01T00:00:00)

Use the param order to choose on which criterias the results should be ordered (e.g. order=updated_at to order by updated_at descending, use the minus operator to order by ascending value e.g. order=-updated_at).

Pagination information are stored in the response header as defined by RFC-5988 http://tools.ietf.org/html/rfc5988

Example:

{
"link": "<https://hivebrite.com/api/admin/v2/educations?page=1&per_page=30>; rel=\"first\", <https://hivebrite.com/api/admin/v2/educations?page=3&per_page=30>; rel=\"prev\", <https://hivebrite.com/api/admin/v2//educations?page=2041&per_page=30>; rel=\"last\", <https://hivebrite.com/api/admin/v2/educations?page=30&per_page=30>; rel=\"next\"",
"x-per-page": "30",
"x-total": "10201",
"x-page": "4"
}
query Parameters
page
integer <int32>
Default: 1

Page of results to fetch.

per_page
integer <int32>
Default: null

Number of results to return per page.

order
string
Enum: "id" "-id" "user_id" "-user_id" "school" "-school" "degree" "-degree" "field_of_study" "-field_of_study" "from" "-from" "to" "-to" "custom_attributes" "-custom_attributes" "external_id" "-external_id" "user_can_edit" "-user_can_edit" "created_at" "-created_at" "extended_updated_at" "-extended_updated_at" "updated_at" "-updated_at"
updated_since
string <date-time>
filter[user_id]
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "school_name": "string",
  • "degree": "string",
  • "from": "2019-08-24",
  • "to": "2019-08-24",
  • "custom_attributes": [
    ],
  • "external_id": "string",
  • "user_can_edit": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "user_id": 0,
  • "field_of_study": {
    },
  • "extended_updated_at": "2019-08-24T14:15:22Z"
}

Add a user education

Create a user education based

Add education to user matching the user_id param

Request Body schema: application/x-www-form-urlencoded
required
education[user_id]
required
string

User ID attached to the education

education[school]
required
string

School name

education[degree]
string

Education degree

education[field_of_study]
string

Field of study

education[from]
string <date>

Education started at

education[to]
string <date>

Education ended at

education[custom_attributes][]
Array of objects

Array of customizable attributes with name, value and type

education[external_id]
string

Education ID in your database

education[user_can_edit]
boolean

Is this education editable by the user

education[created_at]
string <date-time>

Education creation date

education[updated_at]
string <date-time>

Education last update date time - iso8601

education[extended_updated_at]
string <date-time>

Education (including custom attributes) last update date time - iso8601

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "school_name": "string",
  • "degree": "string",
  • "from": "2019-08-24",
  • "to": "2019-08-24",
  • "custom_attributes": [
    ],
  • "external_id": "string",
  • "user_can_edit": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "user_id": 0,
  • "field_of_study": {
    },
  • "extended_updated_at": "2019-08-24T14:15:22Z"
}

Get user education

Return the user education

Find the user education matching the education ID

path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "school_name": "string",
  • "degree": "string",
  • "from": "2019-08-24",
  • "to": "2019-08-24",
  • "custom_attributes": [
    ],
  • "external_id": "string",
  • "user_can_edit": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "user_id": 0,
  • "field_of_study": {
    },
  • "extended_updated_at": "2019-08-24T14:15:22Z"
}

Update existing user education

Update the user education

Find the user education matching the education ID.

path Parameters
id
required
string

Education ID

Request Body schema: application/x-www-form-urlencoded
education[school]
string

Education school

education[degree]
string

Education degree

education[field_of_study]
string

Field of study

education[from]
string <date>

Education started at

education[to]
string <date>

Education ended at

education[custom_attributes][]
Array of objects

Array of customizable attributes with name, value and type

education[external_id]
string

Education ID in your database

education[user_can_edit]
boolean

Is this education editable by the user

education[created_at]
string <date-time>

Education creation date

education[updated_at]
string <date-time>

Education last update date time - iso8601

education[extended_updated_at]
string <date-time>

Education (including custom attributes) last update date time - iso8601

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "school_name": "string",
  • "degree": "string",
  • "from": "2019-08-24",
  • "to": "2019-08-24",
  • "custom_attributes": [
    ],
  • "external_id": "string",
  • "user_can_edit": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "user_id": 0,
  • "field_of_study": {
    },
  • "extended_updated_at": "2019-08-24T14:15:22Z"
}

Delete User education

Delete the user education

Find the user education matching the education ID or use external_id as the education_key parameter to identify the education.

path Parameters
id
required
integer <int32>

Responses

Customizable Attribute Creation

Customizable Attribute creation for Educations

Required params are :

  • a Type,
  • a Display name
  • if the Type is a Select, a 'options' array of possible choice
  • if the Type is a DoubleSelect, a 'json_options' hash with values like so :
      {
    // ...
    "json_options": {
      "options": {
        "Parent Option A": [
          "Parent A, Child 1",
          "Parent A, Child 2",
          "Parent A, Child 3"
        ],
        "Parent Option B": [
          "Parent B, Child 1",
          "Parent B, Child 2",
          "Parent B, Child 3"
        ]
      }
    }
  }
Request Body schema: application/x-www-form-urlencoded
required
customizable_attribute[type]
required
string
Enum: "CustomizableAttribute::Boolean" "CustomizableAttribute::Date" "CustomizableAttribute::DoubleSelect" "CustomizableAttribute::Number" "CustomizableAttribute::Select" "CustomizableAttribute::Text"
customizable_attribute[display_name]
string

Customizable Attribute displayed name

customizable_attribute[text_size]
integer <int32>

Customizable Attribute text_size

customizable_attribute[tooltip]
string

Customizable Attribute tooltip

customizable_attribute[placeholder]
string

Customizable Attribute placeholder

customizable_attribute[multi]
boolean

Customizable Attribute multi activated ?

customizable_attribute[visibility]
string
Enum: "admin_only" "tagged_user" "everybody" "not_visible"

Customizable Attribute visibility

customizable_attribute[user_editable]
boolean

Customizable Attribute editable by the user ?

customizable_attribute[required]
boolean

Customizable Attribute required ?

customizable_attribute[options][]
Array of strings

Customizable Attribute array of options

customizable_attribute[selected_value]
string

Customizable Attribute selected value

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "customizable_id": 0,
  • "type": "CustomizableAttribute::Boolean",
  • "customizable_type": "bizopp",
  • "name": "string",
  • "display_name": "string",
  • "tooltip": "string",
  • "placeholder": "string",
  • "multi": true,
  • "text_size": 0,
  • "visibility": "admin_only",
  • "user_editable": true,
  • "required": true,
  • "options": [
    ],
  • "json_options": { },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "selected_value": "string"
}

Customizable Attribute Update

Update a customizable attribute

The customizable attribute can be retrieved on the /api/admin/v1/settings/customizable_attributes endpoint.

For DoubleSelect, the json_options params must be formatted the following way

{
  // ...
  "json_options": {
    "options": {
      "Parent Option A": [
        "Parent A, Child 1",
        "Parent A, Child 2",
        "Parent A, Child 3"
      ],
      "Parent Option B": [
        "Parent B, Child 1",
        "Parent B, Child 2",
        "Parent B, Child 3"
      ]
    }
  }
}
Request Body schema: application/x-www-form-urlencoded
required
id
required
integer <int32>
customizable_attribute[display_name]
string

Customizable Attribute displayed name

customizable_attribute[tooltip]
string

Customizable Attribute tooltip

customizable_attribute[placeholder]
string

Customizable Attribute placeholder

customizable_attribute[multi]
boolean

Customizable Attribute multi activated ?

customizable_attribute[text_size]
integer <int32>

Customizable Attribute text_size

customizable_attribute[visibility]
string
Enum: "admin_only" "tagged_user" "everybody" "not_visible"

Customizable Attribute visibility

customizable_attribute[user_editable]
boolean

Customizable Attribute editable by the user ?

customizable_attribute[required]
boolean

Customizable Attribute required ?

customizable_attribute[options][]
Array of strings

Customizable Attribute array of options

customizable_attribute[selected_value]
string

Customizable Attribute selected value

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "customizable_id": 0,
  • "type": "CustomizableAttribute::Boolean",
  • "customizable_type": "bizopp",
  • "name": "string",
  • "display_name": "string",
  • "tooltip": "string",
  • "placeholder": "string",
  • "multi": true,
  • "text_size": 0,
  • "visibility": "admin_only",
  • "user_editable": true,
  • "required": true,
  • "options": [
    ],
  • "json_options": { },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "selected_value": "string"
}

Customizable Attribute Deletion

Destroy a Customizable Attribute

The customizable attributes of the education block can be retrieved on the /api/admin/v1/settings/customizable_attributes endpoint. BEWARE: This will delete the answers to this customizable attribute in all user educations as well as the customizable attributes linked to the education.

query Parameters
id
required
integer <int32>

Responses

emailings

Operations about emailings

Get emailing categories list

Return an array of emailing categories with basic information

Pagination information are stored in the response header as defined by RFC-5988 http://tools.ietf.org/html/rfc5988

Example:

{
"link": "<https://hivebrite.com/api/admin/v1/emailing/categories?page=1&per_page=30>; rel=\"first\", <https://hivebrite.com/api/admin/v1/emailing/categories?page=3&per_page=30>; rel=\"prev\", <https://hivebrite.com/api/admin/v1/emailing/categories?page=2041&per_page=30>; rel=\"last\", <https://hivebrite.com/api/admin/v1/emailing/categories?page=30&per_page=30>; rel=\"next\"",
"x-per-page": "30",
"x-total": "10201",
"x-page": "4"
}
query Parameters
page
integer <int32>
Default: 1

Page of results to fetch.

per_page
integer <int32>
Default: null

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "categories": [
    ]
}

Add a new emailing category

Create a new emailing category

Request Body schema: application/x-www-form-urlencoded
category[name]
string

Name of the category

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Get emailing category information

Return the emailing category.

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update an emailing category

Update the emailing category attributes and return the updated emailing category.

path Parameters
id
required
integer <int32>
Request Body schema: application/x-www-form-urlencoded
category[name]
string

Name of the category

category[created_at]
string <date-time>

Category creation date time - iso8601

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Delete Emailing Category

Delete the Emailing Category based on its ID

path Parameters
id
required
string

Responses

Get emailing campaigns list

Return an array of emailing campaigns with basic information

Pagination information are stored in the response header as defined by RFC-5988 http://tools.ietf.org/html/rfc5988

Example:

{
"link": "<https://hivebrite.com/api/admin/v1/emailing/campaigns?page=1&per_page=30>; rel=\"first\", <https://hivebrite.com/api/admin/v1/emailing/campaigns?page=3&per_page=30>; rel=\"prev\", <https://hivebrite.com/api/admin/v1/emailing/campaigns?page=2041&per_page=30>; rel=\"last\", <https://hivebrite.com/api/admin/v1/emailing/campaigns?page=30&per_page=30>; rel=\"next\"",
"x-per-page": "30",
"x-total": "10201",
"x-page": "4"
}
query Parameters
page
integer <int32>
Default: 1

Page of results to fetch.

per_page
integer <int32>
Default: null

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "sent_date": "2019-08-24T14:15:22Z",
  • "which_user_email": "primary_email",
  • "subject": "string",
  • "from_name": "string",
  • "from": "string",
  • "reply_to_name": "string",
  • "reply_to": "string",
  • "content": "string",
  • "network_categories": {
    },
  • "display_invitation": true,
  • "topic_ids": 0,
  • "network_event_ids": 0,
  • "recipients_count": 0,
  • "recipient_ids": 0
}

Create an emailing campaign

Create an emailing campaign with the specified parameters

Request Body schema: application/x-www-form-urlencoded
required
emailing_campaign[subject]
required
string
emailing_campaign[which_user_email]
string
Enum: "primary_email" "email" "email2" "email3" "email1then2" "email1then2then3" "email2then1" "email3then2then1" "email1and2" "email1and2and3"

To which email the campaign is sent

emailing_campaign[from_name]
string

Sender name of the Emailing campaign

emailing_campaign[from]
string

Sender email of the Emailing campaign

emailing_campaign[reply_to_name]
string

Reply to name for the Emailing campaign

emailing_campaign[reply_to]
string

Reply to email for the Emailing campaign

emailing_campaign[content]
string

Content of the Emailing campaign

emailing_campaign[network_categories]
NetworkCategory

Network categories linked to the campaign

emailing_campaign[display_invitation]
boolean

Display the invitation button at the end of the emailing ?

emailing_campaign[topic_ids][]
Array of integers <int32> [ items <int32 > ]

Linked topic ids

emailing_campaign[network_event_ids][]
Array of integers <int32> [ items <int32 > ]

linked event ids

emailing_campaign[recipients_count]
integer <int32>

Number of recipients

emailing_campaign[recipient_ids][]
Array of integers <int32> [ items <int32 > ]

user ids who received the campaign

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "sent_date": "2019-08-24T14:15:22Z",
  • "which_user_email": "primary_email",
  • "subject": "string",
  • "from_name": "string",
  • "from": "string",
  • "reply_to_name": "string",
  • "reply_to": "string",
  • "content": "string",
  • "network_categories": {
    },
  • "display_invitation": true,
  • "topic_ids": 0,
  • "network_event_ids": 0,
  • "recipients_count": 0,
  • "recipient_ids": 0
}

Get an emailing campaign

Get a specific emailing campaign

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "sent_date": "2019-08-24T14:15:22Z",
  • "which_user_email": "primary_email",
  • "subject": "string",
  • "from_name": "string",
  • "from": "string",
  • "reply_to_name": "string",
  • "reply_to": "string",
  • "content": "string",
  • "network_categories": {
    },
  • "display_invitation": true,
  • "topic_ids": 0,
  • "network_event_ids": 0,
  • "recipients_count": 0,
  • "recipient_ids": 0
}

Update an emailing campaign

Update a non-sent emailing campaign

path Parameters
id
required
string
Request Body schema: application/x-www-form-urlencoded
emailing_campaign[which_user_email]
string
Enum: "primary_email" "email" "email2" "email3" "email1then2" "email1then2then3" "email2then1" "email3then2then1" "email1and2" "email1and2and3"

To which email the campaign is sent

emailing_campaign[subject]
string

Subject of the Emailing campaign

emailing_campaign[from_name]
string

Sender name of the Emailing campaign

emailing_campaign[from]
string

Sender email of the Emailing campaign

emailing_campaign[reply_to_name]
string

Reply to name for the Emailing campaign

emailing_campaign[reply_to]
string

Reply to email for the Emailing campaign

emailing_campaign[content]
string

Content of the Emailing campaign

emailing_campaign[network_categories]
NetworkCategory

Network categories linked to the campaign

emailing_campaign[display_invitation]
boolean

Display the invitation button at the end of the emailing ?

emailing_campaign[topic_ids][]
Array of integers <int32> [ items <int32 > ]

Linked topic ids

emailing_campaign[network_event_ids][]
Array of integers <int32> [ items <int32 > ]

linked event ids

emailing_campaign[recipients_count]
integer <int32>

Number of recipients

emailing_campaign[recipient_ids][]
Array of integers <int32> [ items <int32 > ]

user ids who received the campaign

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "sent_date": "2019-08-24T14:15:22Z",
  • "which_user_email": "primary_email",
  • "subject": "string",
  • "from_name": "string",
  • "from": "string",
  • "reply_to_name": "string",
  • "reply_to": "string",
  • "content": "string",
  • "network_categories": {
    },
  • "display_invitation": true,
  • "topic_ids": 0,
  • "network_event_ids": 0,
  • "recipients_count": 0,
  • "recipient_ids": 0
}

Delete emailing campaign

Deletes an emailing campaign

path Parameters
id
required
string

Responses

Send an emailing campaign

Sends the specified non-sent emailing campaign

path Parameters
id
required
string
Request Body schema: application/x-www-form-urlencoded
recipients[user_list_ids][]
Array of integers <int32> [ items <int32 > ]

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "sent_date": "2019-08-24T14:15:22Z",
  • "which_user_email": "primary_email",
  • "subject": "string",
  • "from_name": "string",
  • "from": "string",
  • "reply_to_name": "string",
  • "reply_to": "string",
  • "content": "string",
  • "network_categories": {
    },
  • "display_invitation": true,
  • "topic_ids": 0,
  • "network_event_ids": 0,
  • "recipients_count": 0,
  • "recipient_ids": 0
}

topics

Operations about topics

Get Topic Categories

Return this network Topic Categories. This endpoint has been deprecated.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string"
}

(DEPRECATED) Get Topics Deprecated

Return this network topics. This endpoint has been deprecated.

query Parameters
page
integer <int32>
Default: 1

Page of results to fetch.

per_page
integer <int32>
Default: null

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "topics": [
    ]
}

(DEPRECATED) Create a new Topic Deprecated

Create a new topic

This endpoint has been deprecated.

Request Body schema: application/x-www-form-urlencoded
required
topic[name]
required
string

Topic Name

topic[description]
required
string

Topic Description

topic[expert_ids][]
Array of integers <int32> [ items <int32 > ]

Topic Expert user ids

topic[logo]
string <binary>
topic[cover_picture]
string <binary>
topic[expert_title]
string

Topic expert title

topic[public]
boolean

Topic public ?

topic[restricted_access]
boolean

Restricted access to this topic ?

topic[category_id]
integer <int32>

Topic Category ID

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "expert_title": "string",
  • "public": true,
  • "restricted_access": true,
  • "category_id": 0,
  • "category": {
    },
  • "experts": { },
  • "followers": [
    ],
  • "logo": {
    },
  • "cover_picture": {
    }
}

(DEPRECATED) Get Topic Deprecated

Return this Topic. This endpoint has been deprecated.

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "expert_title": "string",
  • "public": true,
  • "restricted_access": true,
  • "category_id": 0,
  • "category": {
    },
  • "experts": { },
  • "followers": [
    ],
  • "logo": {
    },
  • "cover_picture": {
    }
}

(DEPRECATED) Update a topic Deprecated

Update the topic attributes and return the updated topic. This endpoint has been deprecated.

path Parameters
id
required
integer <int32>

Topic ID

Request Body schema: application/x-www-form-urlencoded
topic[expert_ids][]
Array of integers <int32> [ items <int32 > ]

Topic Expert user ids

topic[logo]
string <binary>
topic[cover_picture]
string <binary>
topic[name]
string

Topic title

topic[description]
string

Topic description

topic[expert_title]
string

Topic expert title

topic[public]
boolean

Topic public ?

topic[restricted_access]
boolean

Restricted access to this topic ?

topic[category_id]
integer <int32>

Topic Category ID

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "expert_title": "string",
  • "public": true,
  • "restricted_access": true,
  • "category_id": 0,
  • "category": {
    },
  • "experts": { },
  • "followers": [
    ],
  • "logo": {
    },
  • "cover_picture": {
    }
}

(DEPRECATED) Delete Topic Deprecated

Delete the topic based on its ID This endpoint has been deprecated.

path Parameters
id
required
string

Responses

(DEPRECATED) Add Followers Deprecated

Add one or more user as follower of this Topic. This endpoint has been deprecated.

path Parameters
topic_id
required
string
Request Body schema: application/x-www-form-urlencoded
required
user_ids[]
required
Array of integers <int32> [ items <int32 > ]

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "email": "string",
  • "name": "string",
  • "sub_network_ids": [
    ],
  • "extended_updated_at": "2019-08-24T14:15:22Z",
  • "joined_at": "2019-08-24T14:15:22Z"
}

(DEPRECATED) Remove Followers Deprecated

Remove one or more user as follower of this Topic. This endpoint has been deprecated.

path Parameters
topic_id
required
string
query Parameters
user_ids[]
required
Array of integers <int32> [ items <int32 > ]

Responses

Groups Users Index

All Members and Prospects for each Groups

Return a paginated list of the members and prospects for each groups of your community. For each member, it will return the related user_id, joined_at date, and if the user enabled the notifications for this group.

Filters:

  • status to retrieve only members, only prospects, only left, or all users (default)
  • group_ids to retrieve only data for some groups.
  • updated_since to retrieve only members / prospects updated since this date
query Parameters
page
integer <int32>
Default: 1

Page of results to fetch.

per_page
integer <int32>
Default: null

Number of results to return per page.

status
string
Default: "all"
Enum: "all" "members" "prospects" "left"
group_ids[]
Array of integers <int32> [ items <int32 > ]

Filter only these groups

updated_since
string <date-time>

Filter only users updated since this date

Responses

Response samples

Content type
application/json
{
  • "group_id": "string",
  • "user_id": "string",
  • "status": "string",
  • "joined_at": "2019-08-24T14:15:22Z",
  • "notifications": true
}

Groups Users Create

Add Members and Prospects to Groups

For each Members or Prospects to add, use a Hash with the Group ID and all the User IDs you wish to add to this group.

Use one Array of Hash for each Groups, within members or prospects as top level keys.

You can also pass the send_email_invitation [true|false] parameter to send an invitation directly to the user when he is added to the group. Only available for members and unconfirmed users.

{
  "send_email_invitation": true,
  "members": [
    {"group_id": 1, "user_ids": [1, 2, 4]},
    {"group_id": 2, "user_ids": [2, 3, 4]}
  ],
  {"prospects": [
    {"group_id": 1, "user_ids": [3, 5, 6]},
    {"group_id": 2, "user_ids": [5, 6, 7]}
  ]
}

Returns created Members and Prospects

Request Body schema: application/x-www-form-urlencoded
send_email_invitation
boolean
Default: false

Send an invitation email when the user is added to the group, only available for members a unconfirmed users

members[][group_id]
Array of integers <int32> [ items <int32 > ]

Group unique ID

members[][user_ids][]
Array of integers <int32> [ items <int32 > ]

Each user IDs to add as Members

prospects[][group_id]
Array of integers <int32> [ items <int32 > ]

Group unique ID

prospects[][user_ids][]
Array of integers <int32> [ items <int32 > ]

Each user IDs to add as Prospects

Responses

Response samples

Content type
application/json
{
  • "group_id": "string",
  • "user_id": "string",
  • "status": "string",
  • "joined_at": "2019-08-24T14:15:22Z",
  • "notifications": true
}

Groups Users Delete

Remove Members or Prospects from Groups

For each users to remove, use a Hash with the Group ID and all the User IDs you wish to remove from this group.

{"users":
    [
      {"group_id": 1, "user_ids": [1, 2, 3]},
      {"group_id": 2, "user_ids": [2, 3, 4]}
    ]
}
query Parameters
users[][group_id]
required
Array of integers <int32> [ items <int32 > ]

Group unique ID

users[][user_ids][]
required
Array of integers <int32> [ items <int32 > ]

Each user IDs to remove

Responses

Response samples

Content type
application/json
{
  • "group_id": "string",
  • "user_id": "string",
  • "status": "string",
  • "joined_at": "2019-08-24T14:15:22Z",
  • "notifications": true
}

Add a new Memberships Type

Add a Membership Type to the Topic

path Parameters
topic_id
required
integer <int32>
Request Body schema: application/x-www-form-urlencoded
required
type[currency]
required
string
type[periodicity]
required
string
Enum: "none" "week" "fifteen_days" "month" "two_months" "three_months" "six_months" "year" "two_years" "three_years" "four_years" "five_years"
type[price]
required
number <float>
Default: 0
type[external_id]
string

External ID of the Memberships Type (ID in your system)

type[name]
string

Memberships Type Name

type[description]
string

Memberships Type Description

type[active]
boolean

Memberships Type active ?

type[restriction_enabled]
boolean

Memberships Type restriction enabled ?

type[discharged]
boolean

Memberships Type discharged ?

type[recurring_payment_enabled]
boolean

Memberships Type recurring payment enabled ? (deprecated)

type[until_year_end]
boolean

Memberships Type valid until year end ?

type[enable_expire_month]
boolean

Memberships Type expire month ?

type[expire_month]
integer <int32>

Month when the Memberships Type expires

type[recurring_mode]
string

Automatic renewal for memberships ?

type[payment_account_id]
integer <int32>

ID of associated payment account

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "external_id": "string",
  • "name": "string",
  • "description": "string",
  • "active": true,
  • "restriction_enabled": true,
  • "discharged": true,
  • "recurring_payment_enabled": true,
  • "until_year_end": true,
  • "enable_expire_month": true,
  • "expire_month": 0,
  • "price": 0.1,
  • "currency": "string",
  • "periodicity": "none",
  • "recurring_mode": "no_recurring",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "payment_account_id": 0,
  • "parent": {
    }
}

Create a Topic Project

Create a topic Project

Logo and cover_picture must be sent as files (URL to files won't work)

path Parameters
topic_id
required
integer <int32>
Request Body schema: application/x-www-form-urlencoded
required
venture[company_name]
required
string
venture[business_stage]
required
string
Enum: "seed_startup" "growing" "established" "unknown"
venture[high_level_pitch]
required
string
venture[product]
required
string
venture[user_id]
required
integer <int32>
venture[customizable_attributes][]
Array of objects
venture[company_size]
string
Enum: "only_me" "2_10" "11_50" "51_200" "201_500" "501_1000" "1001_5000" "5001_10000" "10001_more"
venture[industry_ids][]
Array of integers <int32> [ items <int32 > ]
venture[logo]
string <binary>
venture[cover_picture]
string <binary>
venture[company_website]
string

URL to the website of the project

venture[twitter]
string

Link to the twitter acount of the project

venture[facebook]
string

Link to the facebook acount of the project

venture[angel_list]
string

Link to the angel list acount of the project

venture[currently_fundraising]
boolean

Is the project currently raising fund ?

venture[feedable_at]
string <date-time>

project feed date - iso8601 / is used to sort items in a reverse chronological order in the live feed

venture[fundraising_at]
string <date-time>

project is raising funds for the next date - iso8601

venture[fundraising_amount]
integer <int32>

Amount of find the project is raising

venture[help]
string

What help can be brought to the project

venture[non_profit]
boolean

Is the project non-for profit ?

venture[video_html]
string

Link to a video presenting the project

venture[created_date]
string <date-time>

project creation date - iso8601

venture[fundraising_currency]
string

Currency linked to the fundraising

venture[linkedin]
string

Link to the linkedin account of the company

venture[tagline]
string

Tagline of the project

venture[locations][][address]
Array of strings
venture[locations][][city]
Array of strings
venture[locations][][country_code]
Array of strings
Items Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW" "XK"
venture[funding_rounds][][amount]
Array of integers <int32> [ items <int32 > ]

Amound raised in the Funding round

venture[funding_rounds][][currency]
required
Array of strings
Items Enum: "usd" "eur" "gbp" "aud" "cad" "jpy" "huf" "byr" "syp" "svc" "stn" "std" "ssp" "srd" "sos" "sll" "aed" "szl" "thb" "tjs" "tmt" "tnd" "top" "try" "ttd" "twd" "tzs" "uah" "zmw" "nok" "npr" "nzd" "omr" "pab" "pen" "pgk" "php" "pkr" "pln" "pyg" "qar" "ron" "rsd" "rub" "rwf" "sar" "sbd" "scr" "sdg" "sek" "sgd" "shp" "skk" "sle" "bch" "btc" "jep" "ggp" "imp" "xfu" "gbx" "cnh" "usdc" "eek" "ghs" "hrk" "ltl" "lvl" "mro" "mtl" "tmm" "jpy" "zwd" "zwl" "zwn" "zwr" "vef" "ugx" "uyu" "uzs" "ves" "vnd" "vuv" "wst" "xaf" "xag" "xau" "xba" "xbb" "xbc" "xbd" "xcd" "xdr" "xof" "xpd" "xpf" "xpt" "xts" "yer" "zar" "zmk" "cdf" "chf" "clf" "clp" "cny" "cop" "crc" "cuc" "cup" "cve" "czk" "djf" "dkk" "dop" "dzd" "egp" "ern" "etb" "fjd" "fkp" "gel" "ghs" "gip" "afn" "all" "amd" "ang" "aoa" "ars" "awg" "azn" "bam" "bbd" "bdt" "bgn" "bhd" "bif" "bmd" "bnd" "bob" "brl" "bsd" "btn" "bwp" "byn" "bzd" "gmd" "lak" "lbp" "lkr" "lrd" "lsl" "lyd" "mad" "mdl" "mga" "mkd" "mmk" "mnt" "mop" "mru" "mur" "mvr" "mwk" "mxn" "myr" "mzn" "nad" "ngn" "nio" "gnf" "gtq" "gyd" "hkd" "hnl" "htg" "idr" "ils" "inr" "iqd" "irr" "isk" "jmd" "jod" "kes" "kgs" "khr" "kmf" "kpw" "krw" "kwd" "kyd" "kzt"
venture[funding_rounds][][funding_type]
Array of strings

Type of the Funding Round

venture[funding_rounds][][closed_date]
Array of strings <date-time> [ items <date-time > ]

Funding Round closing date - iso8601

venture[funding_rounds][][press_url]
Array of strings

URL of the press release regarding this Funding Round

venture[funding_rounds][][investors][][name]
required
Array of strings
venture[funding_rounds][][investors][][url]
Array of strings

URL to the website of the Investor

venture[team_members][][user_id]
required
Array of integers <int32> [ items <int32 > ]
venture[team_members][][role]
Array of strings

Role of the Team Member

venture[team_members][][status]
Array of strings

Approvals::Network status of the Team member in the project

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "company_name": "string",
  • "high_level_pitch": "string",
  • "product": "string",
  • "logo": "string",
  • "company_website": "string",
  • "twitter": "string",
  • "facebook": "string",
  • "angel_list": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "user_id": 0,
  • "currently_fundraising": true,
  • "feedable_at": "2019-08-24T14:15:22Z",
  • "fundraising_at": "2019-08-24T14:15:22Z",
  • "fundraising_amount": 0,
  • "help": "string",
  • "business_stage": "seed_startup",
  • "non_profit": true,
  • "video_html": "string",
  • "created_date": "2019-08-24T14:15:22Z",
  • "cover_picture": "string",
  • "company_size": "only_me",
  • "fundraising_currency": "USD",
  • "linkedin": "string",
  • "tagline": "string",
  • "funding_rounds": {
    },
  • "locations": {
    },
  • "team_members": {
    },
  • "industry_ids": 0,
  • "parent": {
    },
  • "customizable_attributes": [
    ]
}

Groups Index

Get a paginated list of Groups

Pagination information are stored in the response header as defined by RFC-5988 http://tools.ietf.org/html/rfc5988

Example:

{
"link": "<https://hivebrite.com/api/admin/v2/topics?page=1&per_page=30>; rel=\"first\", <https://hivebrite.com/api/admin/v2/topics?page=3&per_page=30>; rel=\"prev\", <https://hivebrite.com/api/admin/v2/topics?page=2041&per_page=30>; rel=\"last\", <https://hivebrite.com/api/admin/v2/topics?page=30&per_page=30>; rel=\"next\"",
"x-per-page": "30",
"x-total": "10201",
"x-page": "4"
}
query Parameters
updated_since
string <date-time>

Filter only Groups created or updated since this date

name
string

Filter by name

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "expert_title": "string",
  • "public": true,
  • "restricted_access": true,
  • "secret": true,
  • "published_at": "2019-08-24T14:15:22Z",
  • "published": true,
  • "categories": {
    },
  • "experts": {
    },
  • "partners": {
    },
  • "config": null,
  • "logo": {
    },
  • "cover_picture": {
    },
  • "cover_picture_small": {
    },
  • "location": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Add a new Group

Add a new Group to your community

Logo and cover_picture must be sent as files (URL to files won't work).

Note on Partners, you must send the logo as files (URL to files won't work).

Note on Location, you should at least fill Country or Country Code if you specify a location.

Request Body schema: application/x-www-form-urlencoded
required
group[name]
required
string

Group Name

group[category_ids][]
Array of integers <int32> [ items <int32 > ]

Group categories ids

group[logo]
string <binary>
group[cover_picture]
string <binary>
group[cover_picture_small]
string <binary>
group[closed]
boolean

Closed topic ?

group[restricted_access]
boolean

Users should ask to join the group ?

group[config][news_tab_enabled]
boolean

News tab enabled ?

group[config][home_tab_enabled]
boolean

Home tab enabled ?

group[config][forum_tab_enabled]
boolean

Forum tab enabled ?

group[config][events_tab_enabled]
boolean

Events tab enabled ?

group[config][memberships_tab_enabled]
boolean

Memberships tab enabled ?

group[config][media_center_tab_enabled]
boolean

Media Center tab enabled ?

group[config][ventures_tab_enabled]
boolean

Ventures tab enabled ?

group[config][followers_tab_enabled]
boolean

Followers tab enabled ?

group[config][default_group_activity_frequency]
required
string
Enum: "none" "instant" "daily" "weekly"

Group activity frequency

group[experts][][user_id]
required
Array of integers <int32> [ items <int32 > ]

Unique User ID

group[experts][][description]
Array of strings

Expert description

group[partners][][name]
required
Array of strings

Partner name

group[partners][][url]
required
Array of strings

Partner website url

group[partners][][description]
Array of strings

Partner description

group[partners][][end_date]
Array of strings <date-time> [ items <date-time > ]

Partner end date

group[partners][][logo]
Array of file

Partner logo file (300x300)

group[location][address]
string

Group Address

group[location][city]
string

Group City

group[location][postal_code]
string

Group Postal Code

group[location][country]
string

Group Country

group[location][country_code]
string
Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW" "XK"

Group Country code (2 letters)

group[description]
string

Group description

group[expert_title]
string

Group expert title

group[public]
boolean

Group visible on user not-connected Group pages?

group[secret]
boolean

Secret group ? (Not displayed)

group[published_at]
string <date-time>

Publication date of the Group - Iso8601

group[published]
boolean

Group is published ?

group[created_at]
string <date-time>

Group creation date - iso8601

group[updated_at]
string <date-time>

Group update date - iso8601

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "expert_title": "string",
  • "public": true,
  • "restricted_access": true,
  • "secret": true,
  • "published_at": "2019-08-24T14:15:22Z",
  • "published": true,
  • "categories": {
    },
  • "experts": {
    },
  • "partners": {
    },
  • "config": null,
  • "logo": {
    },
  • "cover_picture": {
    },
  • "cover_picture_small": {
    },
  • "location": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Group

Details of a Group

path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "expert_title": "string",
  • "public": true,
  • "restricted_access": true,
  • "secret": true,
  • "published_at": "2019-08-24T14:15:22Z",
  • "published": true,
  • "categories": {
    },
  • "experts": {
    },
  • "partners": {
    },
  • "config": null,
  • "logo": {
    },
  • "cover_picture": {
    },
  • "cover_picture_small": {
    },
  • "location": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update Group

Update one Group data

Logo and cover_picture must be sent as files (URL to files won't work).

Note on Experts, when you use the experts param, it will update specified experts, set new experts with the data you specified in this params, and remove not mentionned experts. Sending an empty array will just clear all experts from the group.

Note on Partners, same as Experts, will only update specified partners (from their name), create new partners, and remove unmentionned Partners. Logo for Partners must be sent as files (URL to files won't work).

Note on Location, you should at least fill Country or Country Code if you specify a location.

path Parameters
id
required
integer <int32>
Request Body schema: application/x-www-form-urlencoded
group[category_ids][]
Array of integers <int32> [ items <int32 > ]

Group categories ids

group[logo]
string <binary>
group[cover_picture]
string <binary>
group[cover_picture_small]
string <binary>
group[closed]
boolean

Closed topic ?

group[restricted_access]
boolean

Users should ask to join the group ?

group[config][news_tab_enabled]
boolean

News tab enabled ?

group[config][home_tab_enabled]
boolean

Home tab enabled ?

group[config][forum_tab_enabled]
boolean

Forum tab enabled ?

group[config][events_tab_enabled]
boolean

Events tab enabled ?

group[config][memberships_tab_enabled]
boolean

Memberships tab enabled ?

group[config][media_center_tab_enabled]
boolean

Media Center tab enabled ?

group[config][ventures_tab_enabled]
boolean

Ventures tab enabled ?

group[config][followers_tab_enabled]
boolean

Followers tab enabled ?

group[config][default_group_activity_frequency]
required
string
Enum: "none" "instant" "daily" "weekly"

Group activity frequency

group[experts][][user_id]
Array of integers <int32> [ items <int32 > ]

Unique User ID

group[experts][][description]
Array of strings

Expert description

group[partners][][name]
Array of strings

Partner name

group[partners][][url]
Array of strings

Partner website url

group[partners][][description]
Array of strings

Partner description

group[partners][][end_date]
Array of strings <date-time> [ items <date-time > ]

Partner end date

group[partners][][logo]
Array of file

Partner logo file (300x300)

group[location][address]
string

Group Address

group[location][city]
string

Group City

group[location][postal_code]
string

Group Postal Code

group[location][country]
string

Group Country

group[location][country_code]
string
Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW" "XK"

Group Country code (2 letters)

group[name]
string

Group title

group[description]
string

Group description

group[expert_title]
string

Group expert title

group[public]
boolean

Group visible on user not-connected Group pages?

group[secret]
boolean

Secret group ? (Not displayed)

group[published_at]
string <date-time>

Publication date of the Group - Iso8601

group[published]
boolean

Group is published ?

group[created_at]
string <date-time>

Group creation date - iso8601

group[updated_at]
string <date-time>

Group update date - iso8601

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "expert_title": "string",
  • "public": true,
  • "restricted_access": true,
  • "secret": true,
  • "published_at": "2019-08-24T14:15:22Z",
  • "published": true,
  • "categories": {
    },
  • "experts": {
    },
  • "partners": {
    },
  • "config": null,
  • "logo": {
    },
  • "cover_picture": {
    },
  • "cover_picture_small": {
    },
  • "location": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Delete Group

Remove one of your Group

path Parameters
id
required
integer <int32>

Responses

companies

Operations about companies

Get all companies

Return an array of companies with basic information

Use the param updated_since to fetch all companies updated since this datetime (e.g. updated_since=2017-08-01T00:00:00)

Use the param order to choose on which criterias the results should be ordered (e.g. order=updated_at to order by updated_at descending, use the minus operator to order by ascending value e.g. order=-updated_at).

Use the boolean full_profile to display all the available fields for all companies (e.g. full_profile=true)

Pagination information are stored in the response header as defined by RFC-5988 http://tools.ietf.org/html/rfc5988

Example:

{
"link": "<https://hivebrite.com/api/admin/v1/companies?page=1&per_page=30>; rel=\"first\", <https://hivebrite.com/api/admin/v1/companies?page=3&per_page=30>; rel=\"prev\", <https://hivebrite.com/api/admin/v1/companies?page=2041&per_page=30>; rel=\"last\", <https://hivebrite.com/api/admin/v1/companies?page=30&per_page=30>; rel=\"next\"",
"x-per-page": "30",
"x-total": "10201",
"x-page": "4"
}
query Parameters
page
integer <int32>
Default: 1

Page of results to fetch.

per_page
integer <int32>
Default: null

Number of results to return per page.

updated_since
string <date-time>
order
string
Enum: "id" "-id" "name" "-name" "corporate_name" "-corporate_name" "company_identifier" "-company_identifier" "group_name" "-group_name" "company_number" "-company_number" "juridiction" "-juridiction" "siret_nb" "-siret_nb" "siren_nb" "-siren_nb" "website_url" "-website_url" "blog_rss_url" "-blog_rss_url" "twitter_id" "-twitter_id" "facebook_id" "-facebook_id" "contact_info_phone1" "-contact_info_phone1" "contact_info_phone2" "-contact_info_phone2" "contact_info_fax" "-contact_info_fax" "short_description" "-short_description" "long_description" "-long_description" "founded_year" "-founded_year" "video_url" "-video_url" "angel_list_url" "-angel_list_url" "linkedin_url" "-linkedin_url" "linkedin_id" "-linkedin_id" "admin_comment" "-admin_comment" "annual_revenue" "-annual_revenue" "external_job_board" "-external_job_board" "status" "-status" "activity_status" "-activity_status" "code_naf" "-code_naf" "email" "-email" "do_not_contact" "-do_not_contact" "code_ape_id" "-code_ape_id" "xing_url" "-xing_url" "xing_id" "-xing_id" "created_at" "-created_at" "updated_at" "-updated_at"
full_profile
boolean
filter[id]
integer <int32>

Unique ID

filter[name]
string

Company full name

filter[corporate_name]
string

Company corporate name

filter[company_identifier]
string

Company identifier

filter[group_name]
string

Company group name

filter[company_number]
string

Company number

filter[juridiction]
string

Company juridiction (Country Code)

filter[siret_nb]
string

Company siret number

filter[siren_nb]
string

Company siren number

filter[website_url]
string

Company website url

filter[blog_rss_url]
string

Company blog rss url

filter[twitter_id]
string

Company twitter account

filter[facebook_id]
string

Company facebook account

filter[contact_info_phone1]
string

Contact info phone number 1

filter[contact_info_phone2]
string

Contact info phone number 2

filter[contact_info_fax]
string

Contact info fax number

filter[short_description]
string

Company short description

filter[long_description]
string

Company long description

filter[founded_year]
string

Company founded year

filter[video_url]
string

Company videdo url

filter[angel_list_url]
string

Company angel list url

filter[linkedin_url]
string

Company linkedin url

filter[linkedin_id]
string

Company linkedin id

filter[admin_comment]
string

Admin comment

filter[annual_revenue]
string

Company annual revenue

filter[external_job_board]
string

Company external job board

filter[status]
string

Company status: draft: 0, checked: 1

filter[activity_status]
string

Company activity status: active: 0, ceased: 1

filter[code_naf]
string

Company code NAF

filter[email]
string

Contact email

filter[do_not_contact]
boolean

Do not contact ?

filter[code_ape_id]
string

Company code APE ID

filter[xing_url]
string

Company Xing url

filter[xing_id]
string

Company Xing account

filter[created_at]
string <date-time>

Company creation date time - iso8601

filter[updated_at]
string <date-time>

Company last update date time - iso8601

filter[external_id]
string

Company external identifier

filter[employee_count_range]
string

Company number of employees

filter[industries]
Industry

Company industries

filter[postal_location]
PostalAddress

Company postal address

filter[billing_location]
PostalAddress

Company billing address

filter[logo]
string

Company logo url

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string"
}

Add a new company

Return the created company.

Request Body schema: application/x-www-form-urlencoded
required
company[name]
required
string

Company name

company[postal_location][address_1]
string

Address line 1

company[postal_location][address_2]
string

Address line 2

company[postal_location][address_3]
string

Address line 3

company[postal_location][city]
string

City

company[postal_location][state]
string

State

company[postal_location][full_name]
string

Full name

company[postal_location][postal_code]
string

Zip code

company[postal_location][country]
string
Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW" "XK"

Country

company[postal_location][created_at]
string <date-time>

Postal address creation date time - iso8601

company[postal_location][updated_at]
string <date-time>

Postal address last update date time - iso8601

company[billing_location][address_1]
string

Address line 1

company[billing_location][address_2]
string

Address line 2

company[billing_location][address_3]
string

Address line 3

company[billing_location][city]
string

City

company[billing_location][state]
string

State

company[billing_location][full_name]
string

Full name

company[billing_location][postal_code]
string

Zip code

company[billing_location][country]
string
Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW" "XK"

Country

company[billing_location][created_at]
string <date-time>

Postal address creation date time - iso8601

company[billing_location][updated_at]
string <date-time>

Postal address last update date time - iso8601

company[industries][][id]
Array of integers <int32> [ items <int32 > ]
company[logo]
string <binary>

Company logo image

company[corporate_name]
string

Company corporate name

company[company_identifier]
string

Company identifier

company[group_name]
string

Company group name

company[company_number]
string

Company number

company[juridiction]
string

Company juridiction (Country Code)

company[siret_nb]
string

Company siret number

company[siren_nb]
string

Company siren number

company[website_url]
string

Company website url

company[blog_rss_url]
string

Company blog rss url

company[twitter_id]
string

Company twitter account

company[facebook_id]
string

Company facebook account

company[contact_info_phone1]
string

Contact info phone number 1

company[contact_info_phone2]
string

Contact info phone number 2

company[contact_info_fax]
string

Contact info fax number

company[short_description]
string

Company short description

company[long_description]
string

Company long description

company[founded_year]
string

Company founded year

company[video_url]
string

Company videdo url

company[angel_list_url]
string

Company angel list url

company[linkedin_url]
string

Company linkedin url

company[linkedin_id]
string

Company linkedin id

company[admin_comment]
string

Admin comment

company[annual_revenue]
string

Company annual revenue

company[external_job_board]
string

Company external job board

company[status]
string

Company status: draft: 0, checked: 1

company[activity_status]
string

Company activity status: active: 0, ceased: 1

company[code_naf]
string

Company code NAF

company[email]
string

Contact email

company[do_not_contact]
boolean

Do not contact ?

company[code_ape_id]
string

Company code APE ID

company[xing_url]
string

Company Xing url

company[xing_id]
string

Company Xing account

company[created_at]
string <date-time>

Company creation date time - iso8601

company[updated_at]
string <date-time>

Company last update date time - iso8601

company[external_id]
string

Company external identifier

company[employee_count_range]
string

Company number of employees

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "corporate_name": "string",
  • "company_identifier": "string",
  • "group_name": "string",
  • "company_number": "string",
  • "juridiction": "string",
  • "siret_nb": "string",
  • "siren_nb": "string",
  • "website_url": "string",
  • "blog_rss_url": "string",
  • "twitter_id": "string",
  • "facebook_id": "string",
  • "contact_info_phone1": "string",
  • "contact_info_phone2": "string",
  • "contact_info_fax": "string",
  • "short_description": "string",
  • "long_description": "string",
  • "founded_year": "string",
  • "video_url": "string",
  • "angel_list_url": "string",
  • "linkedin_url": "string",
  • "linkedin_id": "string",
  • "admin_comment": "string",
  • "annual_revenue": "string",
  • "external_job_board": "string",
  • "status": "string",
  • "activity_status": "string",
  • "code_naf": "string",
  • "email": "string",
  • "do_not_contact": true,
  • "code_ape_id": "string",
  • "xing_url": "string",
  • "xing_id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "external_id": "string",
  • "employee_count_range": "1",
  • "industries": [
    ],
  • "postal_location": {
    },
  • "billing_location": {
    },
  • "logo": "string"
}

Get company profile

Return the company profile based on it's ID

Find the company matching its ID, or use external_id or company_identifier as the key parameter to identify the company instead of default company ID.

path Parameters
id
required
string
query Parameters
key
string
Enum: "external_id" "company_identifier"

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "corporate_name": "string",
  • "company_identifier": "string",
  • "group_name": "string",
  • "company_number": "string",
  • "juridiction": "string",
  • "siret_nb": "string",
  • "siren_nb": "string",
  • "website_url": "string",
  • "blog_rss_url": "string",
  • "twitter_id": "string",
  • "facebook_id": "string",
  • "contact_info_phone1": "string",
  • "contact_info_phone2": "string",
  • "contact_info_fax": "string",
  • "short_description": "string",
  • "long_description": "string",
  • "founded_year": "string",
  • "video_url": "string",
  • "angel_list_url": "string",
  • "linkedin_url": "string",
  • "linkedin_id": "string",
  • "admin_comment": "string",
  • "annual_revenue": "string",
  • "external_job_board": "string",
  • "status": "string",
  • "activity_status": "string",
  • "code_naf": "string",
  • "email": "string",
  • "do_not_contact": true,
  • "code_ape_id": "string",
  • "xing_url": "string",
  • "xing_id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "external_id": "string",
  • "employee_count_range": "1",
  • "industries": [
    ],
  • "postal_location": {
    },
  • "billing_location": {
    },
  • "logo": "string"
}

Update existing company

Return the updated company profile based on its ID

Updates the company matching its ID, or use external_id or company_identifier as the key parameter to identify the company instead of default company ID.

path Parameters
id
required
string

Company ID

Request Body schema: application/x-www-form-urlencoded
key
string
Enum: "external_id" "company_identifier"
company[postal_location][address_1]
string

Address line 1

company[postal_location][address_2]
string

Address line 2

company[postal_location][address_3]
string

Address line 3

company[postal_location][city]
string

City

company[postal_location][state]
string

State

company[postal_location][full_name]
string

Full name

company[postal_location][postal_code]
string

Zip code

company[postal_location][country]
string
Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW" "XK"

Country

company[postal_location][created_at]
string <date-time>

Postal address creation date time - iso8601

company[postal_location][updated_at]
string <date-time>

Postal address last update date time - iso8601

company[billing_location][address_1]
string

Address line 1

company[billing_location][address_2]
string

Address line 2

company[billing_location][address_3]
string

Address line 3

company[billing_location][city]
string

City

company[billing_location][state]
string

State

company[billing_location][full_name]
string

Full name

company[billing_location][postal_code]
string

Zip code

company[billing_location][country]
string
Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW" "XK"

Country

company[billing_location][created_at]
string <date-time>

Postal address creation date time - iso8601

company[billing_location][updated_at]
string <date-time>

Postal address last update date time - iso8601

company[industries][][id]
Array of integers <int32> [ items <int32 > ]
company[logo]
string <binary>

Company logo image

company[name]
string

Company full name

company[corporate_name]
string

Company corporate name

company[company_identifier]
string

Company identifier

company[group_name]
string

Company group name

company[company_number]
string

Company number

company[juridiction]
string

Company juridiction (Country Code)

company[siret_nb]
string

Company siret number

company[siren_nb]
string

Company siren number

company[website_url]
string

Company website url

company[blog_rss_url]
string

Company blog rss url

company[twitter_id]
string

Company twitter account

company[facebook_id]
string

Company facebook account

company[contact_info_phone1]
string

Contact info phone number 1

company[contact_info_phone2]
string

Contact info phone number 2

company[contact_info_fax]
string

Contact info fax number

company[short_description]
string

Company short description

company[long_description]
string

Company long description

company[founded_year]
string

Company founded year

company[video_url]
string

Company videdo url

company[angel_list_url]
string

Company angel list url

company[linkedin_url]
string

Company linkedin url

company[linkedin_id]
string

Company linkedin id

company[admin_comment]
string

Admin comment

company[annual_revenue]
string

Company annual revenue

company[external_job_board]
string

Company external job board

company[status]
string

Company status: draft: 0, checked: 1

company[activity_status]
string

Company activity status: active: 0, ceased: 1

company[code_naf]
string

Company code NAF

company[email]
string

Contact email

company[do_not_contact]
boolean

Do not contact ?

company[code_ape_id]
string

Company code APE ID

company[xing_url]
string

Company Xing url

company[xing_id]
string

Company Xing account

company[created_at]
string <date-time>

Company creation date time - iso8601

company[updated_at]
string <date-time>

Company last update date time - iso8601

company[external_id]
string

Company external identifier

company[employee_count_range]
string

Company number of employees

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "corporate_name": "string",
  • "company_identifier": "string",
  • "group_name": "string",
  • "company_number": "string",
  • "juridiction": "string",
  • "siret_nb": "string",
  • "siren_nb": "string",
  • "website_url": "string",
  • "blog_rss_url": "string",
  • "twitter_id": "string",
  • "facebook_id": "string",
  • "contact_info_phone1": "string",
  • "contact_info_phone2": "string",
  • "contact_info_fax": "string",
  • "short_description": "string",
  • "long_description": "string",
  • "founded_year": "string",
  • "video_url": "string",
  • "angel_list_url": "string",
  • "linkedin_url": "string",
  • "linkedin_id": "string",
  • "admin_comment": "string",
  • "annual_revenue": "string",
  • "external_job_board": "string",
  • "status": "string",
  • "activity_status": "string",
  • "code_naf": "string",
  • "email": "string",
  • "do_not_contact": true,
  • "code_ape_id": "string",
  • "xing_url": "string",
  • "xing_id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "external_id": "string",
  • "employee_count_range": "1",
  • "industries": [
    ],
  • "postal_location": {
    },
  • "billing_location": {
    },
  • "logo": "string"
}

Delete company

Delete the company based on its ID

Delete the company matching its ID, or use external_id or company_identifier as the key parameter to identify the company instead of default company ID.

path Parameters
id
required
string
query Parameters
key
string
Enum: "external_id" "company_identifier"

Responses

news

Operations about news

Get News Categories

Return this network News Categories.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string"
}

Get all news posts

Return an array of news posts with basic information

Pagination information are stored in the response header as defined by RFC-5988 http://tools.ietf.org/html/rfc5988

Example:

{
"link": "<https://hivebrite.com/api/admin/v1/news?page=1&per_page=30>; rel=\"first\", <https://hivebrite.com/api/admin/v1/news?page=3&per_page=30>; rel=\"prev\", <https://hivebrite.com/api/admin/v1/news?page=2041&per_page=30>; rel=\"last\", <https://hivebrite.com/api/admin/v1/news?page=30&per_page=30>; rel=\"next\"",
"x-per-page": "30",
"x-total": "10201",
"x-page": "4"
}
query Parameters
locale
string
Enum: "en" "en-GB" "fr" "he" "de" "es" "it" "da" "nl" "pt" "ru" "deepbloo" "zh-Hans" "zh-Hant" "af" "pl" "fi" "nl-BE" "nb" "ja" "lt" "hu" "vi" "sv" "ko" "pt-BR" "el" "cy" "hi" "id"
page
integer <int32>
Default: 1

Page of results to fetch.

per_page
integer <int32>
Default: null

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "subject": "string",
  • "published_at": "2019-08-24T14:15:22Z",
  • "feedable_at": "2019-08-24T14:15:22Z",
  • "content": "string",
  • "published": true,
  • "public": true,
  • "visible_on_index_page": true,
  • "visible_on_feed": true,
  • "pinned": true,
  • "seo_title": "string",
  • "seo_description": "string",
  • "canonical_url": "string",
  • "network_category_ids": 0,
  • "topic_ids": 0,
  • "network_event_ids": 0,
  • "publish_on_network": true,
  • "cover_picture": {
    }
}

Add a new news post

Return the created news post.

Request Body schema: application/x-www-form-urlencoded
locale
string
Enum: "en" "en-GB" "fr" "he" "de" "es" "it" "da" "nl" "pt" "ru" "deepbloo" "zh-Hans" "zh-Hant" "af" "pl" "fi" "nl-BE" "nb" "ja" "lt" "hu" "vi" "sv" "ko" "pt-BR" "el" "cy" "hi" "id"
news_post[subject]
required
string

Title of the news post

news_post[content]
required
string

Content of the news post

news_post[created_at]
string <date-time>

News post creation date

news_post[updated_at]
string <date-time>

News post last update date

news_post[published_at]
string <date-time>

News post publication date

news_post[feedable_at]
string <date-time>

News post feedable date (if scheduled for later)

news_post[published]
boolean

Is the News post published ?

news_post[public]
boolean

Is the News post public ?

news_post[visible_on_index_page]
boolean

Is the News post visible in the index page ?

news_post[visible_on_feed]
boolean

Is the News post visible in the live feed ?

news_post[pinned]
boolean

Is the News post pinned in the feed ?

news_post[seo_title]
string

SEO Customization of the news post

news_post[seo_description]
string

SEO Customization of the news post

news_post[canonical_url]
string

Canonical URL of the news post

news_post[network_category_ids][]
Array of integers <int32> [ items <int32 > ]

Network categories linked to the news post

news_post[topic_ids][]
Array of integers <int32> [ items <int32 > ]

Topics linked to the news post

news_post[network_event_ids][]
Array of integers <int32> [ items <int32 > ]

Events linked to the news post

news_post[publish_on_network]
boolean

If the news is linked to a group: is it also published for the network ?

news_post[cover_picture]
string <binary>

Cover picture of the news post

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "subject": "string",
  • "published_at": "2019-08-24T14:15:22Z",
  • "feedable_at": "2019-08-24T14:15:22Z",
  • "content": "string",
  • "published": true,
  • "public": true,
  • "visible_on_index_page": true,
  • "visible_on_feed": true,
  • "pinned": true,
  • "seo_title": "string",
  • "seo_description": "string",
  • "canonical_url": "string",
  • "network_category_ids": 0,
  • "topic_ids": 0,
  • "network_event_ids": 0,
  • "publish_on_network": true,
  • "cover_picture": {
    }
}

Get news post

Return the news post based on its ID

path Parameters
id
required
string
query Parameters
locale
string
Enum: "en" "en-GB" "fr" "he" "de" "es" "it" "da" "nl" "pt" "ru" "deepbloo" "zh-Hans" "zh-Hant" "af" "pl" "fi" "nl-BE" "nb" "ja" "lt" "hu" "vi" "sv" "ko" "pt-BR" "el" "cy" "hi" "id"

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "subject": "string",
  • "published_at": "2019-08-24T14:15:22Z",
  • "feedable_at": "2019-08-24T14:15:22Z",
  • "content": "string",
  • "published": true,
  • "public": true,
  • "visible_on_index_page": true,
  • "visible_on_feed": true,
  • "pinned": true,
  • "seo_title": "string",
  • "seo_description": "string",
  • "canonical_url": "string",
  • "network_category_ids": 0,
  • "topic_ids": 0,
  • "network_event_ids": 0,
  • "publish_on_network": true,
  • "cover_picture": {
    }
}

Update existing news post

Return the updated news post based on its ID

path Parameters
id
required
string
Request Body schema: application/x-www-form-urlencoded
locale
string
Enum: "en" "en-GB" "fr" "he" "de" "es" "it" "da" "nl" "pt" "ru" "deepbloo" "zh-Hans" "zh-Hant" "af" "pl" "fi" "nl-BE" "nb" "ja" "lt" "hu" "vi" "sv" "ko" "pt-BR" "el" "cy" "hi" "id"
news_post[created_at]
string <date-time>

News post creation date

news_post[updated_at]
string <date-time>

News post last update date

news_post[subject]
string

Title of the news post

news_post[published_at]
string <date-time>

News post publication date

news_post[feedable_at]
string <date-time>

News post feedable date (if scheduled for later)

news_post[content]
string

Content of the News post

news_post[published]
boolean

Is the News post published ?

news_post[public]
boolean

Is the News post public ?

news_post[visible_on_index_page]
boolean

Is the News post visible in the index page ?

news_post[visible_on_feed]
boolean

Is the News post visible in the live feed ?

news_post[pinned]
boolean

Is the News post pinned in the feed ?

news_post[seo_title]
string

SEO Customization of the news post

news_post[seo_description]
string

SEO Customization of the news post

news_post[canonical_url]
string

Canonical URL of the news post

news_post[network_category_ids][]
Array of integers <int32> [ items <int32 > ]

Network categories linked to the news post

news_post[topic_ids][]
Array of integers <int32> [ items <int32 > ]

Topics linked to the news post

news_post[network_event_ids][]
Array of integers <int32> [ items <int32 > ]

Events linked to the news post

news_post[publish_on_network]
boolean

If the news is linked to a group: is it also published for the network ?

news_post[cover_picture]
string <binary>

Cover picture of the news post

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "subject": "string",
  • "published_at": "2019-08-24T14:15:22Z",
  • "feedable_at": "2019-08-24T14:15:22Z",
  • "content": "string",
  • "published": true,
  • "public": true,
  • "visible_on_index_page": true,
  • "visible_on_feed": true,
  • "pinned": true,
  • "seo_title": "string",
  • "seo_description": "string",
  • "canonical_url": "string",
  • "network_category_ids": 0,
  • "topic_ids": 0,
  • "network_event_ids": 0,
  • "publish_on_network": true,
  • "cover_picture": {
    }
}

Delete news post

Delete the news post based on its ID

path Parameters
id
required
string

Responses

Duplicate news post

Return the duplicated news post.

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "subject": "string",
  • "published_at": "2019-08-24T14:15:22Z",
  • "feedable_at": "2019-08-24T14:15:22Z",
  • "content": "string",
  • "published": true,
  • "public": true,
  • "visible_on_index_page": true,
  • "visible_on_feed": true,
  • "pinned": true,
  • "seo_title": "string",
  • "seo_description": "string",
  • "canonical_url": "string",
  • "network_category_ids": 0,
  • "topic_ids": 0,
  • "network_event_ids": 0,
  • "publish_on_network": true,
  • "cover_picture": {
    }
}

roles

Operations about roles

Get Roles

Return this network Roles.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "default": true,
  • "rights": [
    ]
}

Get Role

Return this Role.

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "default": true,
  • "rights": [
    ]
}

business_opportunities

Operations about business_opportunities

Get all business opportunities

Return an array of business opportunities with basic information

Pagination information are stored in the response header as defined by RFC-5988 http://tools.ietf.org/html/rfc5988

Example:

{
"link": "<https://hivebrite.com/api/admin/v1/business_opportunities?page=1&per_page=30>; rel=\"first\", <https://hivebrite.com/api/admin/v1/business_opportunities?page=3&per_page=30>; rel=\"prev\", <https://hivebrite.com/api/admin/v1/business_opportunities?page=2041&per_page=30>; rel=\"last\", <https://hivebrite.com/api/admin/v1/business_opportunities?page=30&per_page=30>; rel=\"next\"",
"x-per-page": "30",
"x-total": "10201",
"x-page": "4"
}
query Parameters
page
integer <int32>
Default: 1

Page of results to fetch.

per_page
integer <int32>
Default: null

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "title": "string",
  • "description": "string",
  • "yearly_salary": 0,
  • "monthly_salary": 0,
  • "daily_salary": 0,
  • "currency": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "expires_at": "2019-08-24T14:15:22Z",
  • "renewed_at": "2019-08-24T14:15:22Z",
  • "start_date": "2019-08-24T14:15:22Z",
  • "duration": "string",
  • "company_name": "string",
  • "company_id": 0,
  • "url": "string",
  • "email": "string",
  • "kind": "full_time_job",
  • "contract_type": "permanent",
  • "experience_type": "between_0_and_2",
  • "status": "pending",
  • "apply_by": "nothing",
  • "location": {
    },
  • "creator_id": 0,
  • "creator_type": "string",
  • "salary": "string",
  • "external_provider_ref": "string",
  • "external_provider": "string",
  • "public": true,
  • "custom_attributes": [
    ],
  • "topic_ids": 0,
  • "industry_ids": 0,
  • "draft": true,
  • "pinned_on_index_page": true,
  • "external_recruiter": {
    },
  • "remote": true
}

Add a new business opportunity

Return the created business opportunity.

Request Body schema: application/x-www-form-urlencoded
required
business_opportunity[title]
required
string

Business opportunity title

business_opportunity[company_id]
string

Identifier of company offering the business opportunity (required if no company name is provided)

business_opportunity[company_name]
string

Company offering the business opportunity (required if no company Id is provided)

business_opportunity[email]
required
string

Business Opportunity contact email

business_opportunity[description]
string

Business Opportunity description

business_opportunity[kind]
required
string

Business kind of opportunity

business_opportunity[location]
string

Business opportunity address location

business_opportunity[yearly_salary]
integer <int32>

Business Opportunity yearly salary

business_opportunity[monthly_salary]
integer <int32>

Business Opportunity monthly salary

business_opportunity[daily_salary]
integer <int32>

Business Opportunity daily salary

business_opportunity[created_at]
string <date-time>

Business Opportunity creation date time - iso8601

business_opportunity[updated_at]
string <date-time>

Business Opportunity last update date time - iso8601

business_opportunity[expires_at]
string <date-time>

Business Opportunity expiration date time - iso8601

business_opportunity[renewed_at]
string <date-time>

Business Opportunity renewal date time - iso8601

business_opportunity[start_date]
string <date-time>

Vacancy starting date

business_opportunity[duration]
string

Business Opportunity duration

business_opportunity[url]
string

URL related to Business Opportunity

business_opportunity[contract_type]
string

Business opportunity contract type

business_opportunity[experience_type]
string

Business opportunity experience needed

business_opportunity[status]
string

Business Opportunity approval status

business_opportunity[apply_by]
string

Business Opportunity apply by method

business_opportunity[external_provider_ref]
string

Business Opportunity reference for external provider

business_opportunity[public]
boolean

Is the Business Opportunity public ?

business_opportunity[custom_attributes][]
Array of objects

Array of customizable attributes with name, value and type

business_opportunity[topic_ids][]
Array of integers <int32> [ items <int32 > ]

Group IDs linked to the Business Opportunity

business_opportunity[industry_ids][]
Array of integers <int32> [ items <int32 > ]

Industries related to the Business Opportunity

business_opportunity[draft]
boolean

Business Opportunity is a draft ? (default to false)

business_opportunity[pinned_on_index_page]
boolean

Is the opportunity pinned in the Opportunities tab ?

business_opportunity[external_recruiter]
BusinessOpportunities_ExternalRecruiterRequest

External recruiter information

business_opportunity[remote]
boolean

Can the opportunity be done remotely ?

business_opportunity[currency]
required
string

Salary currency

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "title": "string",
  • "description": "string",
  • "yearly_salary": 0,
  • "monthly_salary": 0,
  • "daily_salary": 0,
  • "currency": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "expires_at": "2019-08-24T14:15:22Z",
  • "renewed_at": "2019-08-24T14:15:22Z",
  • "start_date": "2019-08-24T14:15:22Z",
  • "duration": "string",
  • "company_name": "string",
  • "company_id": 0,
  • "url": "string",
  • "email": "string",
  • "kind": "full_time_job",
  • "contract_type": "permanent",
  • "experience_type": "between_0_and_2",
  • "status": "pending",
  • "apply_by": "nothing",
  • "location": {
    },
  • "creator_id": 0,
  • "creator_type": "string",
  • "salary": "string",
  • "external_provider_ref": "string",
  • "external_provider": "string",
  • "public": true,
  • "custom_attributes": [
    ],
  • "topic_ids": 0,
  • "industry_ids": 0,
  • "draft": true,
  • "pinned_on_index_page": true,
  • "external_recruiter": {
    },
  • "remote": true
}

Get business opportunity profile

Return the business opportunity profile based on it's ID

Find the business opportunity matching its ID, or use external_id as the key parameter to identify the business opportunity instead of default business opportunity ID.

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "title": "string",
  • "description": "string",
  • "yearly_salary": 0,
  • "monthly_salary": 0,
  • "daily_salary": 0,
  • "currency": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "expires_at": "2019-08-24T14:15:22Z",
  • "renewed_at": "2019-08-24T14:15:22Z",
  • "start_date": "2019-08-24T14:15:22Z",
  • "duration": "string",
  • "company_name": "string",
  • "company_id": 0,
  • "url": "string",
  • "email": "string",
  • "kind": "full_time_job",
  • "contract_type": "permanent",
  • "experience_type": "between_0_and_2",
  • "status": "pending",
  • "apply_by": "nothing",
  • "location": {
    },
  • "creator_id": 0,
  • "creator_type": "string",
  • "salary": "string",
  • "external_provider_ref": "string",
  • "external_provider": "string",
  • "public": true,
  • "custom_attributes": [
    ],
  • "topic_ids": 0,
  • "industry_ids": 0,
  • "draft": true,
  • "pinned_on_index_page": true,
  • "external_recruiter": {
    },
  • "remote": true
}

Update existing business opportunity

Return the updated business opportunity profile based on its ID

Updates the business opportunity matching its ID.

path Parameters
id
required
string

Business Opportunity ID

Request Body schema: application/x-www-form-urlencoded
location
string

Business opportunity address location

business_opportunity[company_name]
string

Company offering the business opportunity

business_opportunity[company_id]
string

Identifier of company offering the business opportunity

business_opportunity[title]
string

Business Opportunity title

business_opportunity[description]
string

Business Opportunity description

business_opportunity[yearly_salary]
integer <int32>

Business Opportunity yearly salary

business_opportunity[monthly_salary]
integer <int32>

Business Opportunity monthly salary

business_opportunity[daily_salary]
integer <int32>

Business Opportunity daily salary

business_opportunity[currency]
string

Business Opportunity salary currency

business_opportunity[created_at]
string <date-time>

Business Opportunity creation date time - iso8601

business_opportunity[updated_at]
string <date-time>

Business Opportunity last update date time - iso8601

business_opportunity[expires_at]
string <date-time>

Business Opportunity expiration date time - iso8601

business_opportunity[renewed_at]
string <date-time>

Business Opportunity renewal date time - iso8601

business_opportunity[start_date]
string <date-time>

Vacancy starting date

business_opportunity[duration]
string

Business Opportunity duration

business_opportunity[url]
string

URL related to Business Opportunity

business_opportunity[email]
string

Business Opportunity contact email

business_opportunity[kind]
string

Business kind of opportunity

business_opportunity[contract_type]
string

Business opportunity contract type

business_opportunity[experience_type]
string

Business opportunity experience needed

business_opportunity[status]
string

Business Opportunity approval status

business_opportunity[apply_by]
string

Business Opportunity apply by method

business_opportunity[external_provider_ref]
string

Business Opportunity reference for external provider

business_opportunity[public]
boolean

Is the Business Opportunity public ?

business_opportunity[custom_attributes][]
Array of objects

Array of customizable attributes with name, value and type

business_opportunity[topic_ids][]
Array of integers <int32> [ items <int32 > ]

Group IDs linked to the Business Opportunity

business_opportunity[industry_ids][]
Array of integers <int32> [ items <int32 > ]

Industries related to the Business Opportunity

business_opportunity[draft]
boolean

Business Opportunity is a draft ? (default to false)

business_opportunity[pinned_on_index_page]
boolean

Is the opportunity pinned in the Opportunities tab ?

business_opportunity[external_recruiter]
BusinessOpportunities_ExternalRecruiterRequest

External recruiter information

business_opportunity[remote]
boolean

Can the opportunity be done remotely ?

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "title": "string",
  • "description": "string",
  • "yearly_salary": 0,
  • "monthly_salary": 0,
  • "daily_salary": 0,
  • "currency": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "expires_at": "2019-08-24T14:15:22Z",
  • "renewed_at": "2019-08-24T14:15:22Z",
  • "start_date": "2019-08-24T14:15:22Z",
  • "duration": "string",
  • "company_name": "string",
  • "company_id": 0,
  • "url": "string",
  • "email": "string",
  • "kind": "full_time_job",
  • "contract_type": "permanent",
  • "experience_type": "between_0_and_2",
  • "status": "pending",
  • "apply_by": "nothing",
  • "location": {
    },
  • "creator_id": 0,
  • "creator_type": "string",
  • "salary": "string",
  • "external_provider_ref": "string",
  • "external_provider": "string",
  • "public": true,
  • "custom_attributes": [
    ],
  • "topic_ids": 0,
  • "industry_ids": 0,
  • "draft": true,
  • "pinned_on_index_page": true,
  • "external_recruiter": {
    },
  • "remote": true
}

Delete business opportunity

Delete the business opportunity based on its ID

Delete the business opportunity matching its ID.

path Parameters
id
required
string

Responses

receipts

Operations about receipts

Get all receipts

Return an array of receipts

Use the param updated_since to fetch all receipts created since this datetime (e.g. created_since=2017-08-01T00:00:00)

Use the param order to choose on which criterias the results should be ordered (e.g. order=created_at to order by created_at descending, use the minus operator to order by ascending value e.g. order=-created_at).

Pagination information are stored in the response header as defined by RFC-5988 http://tools.ietf.org/html/rfc5988

Example:

{
"link": "<https://hivebrite.com/api/admin/v1/receipts?page=1&per_page=30>; rel=\"first\", <https://hivebrite.com/api/admin/v1/receipts?page=3&per_page=30>; rel=\"prev\", <https://hivebrite.com/api/admin/v1/receipts?page=2041&per_page=30>; rel=\"last\", <https://hivebrite.com/api/admin/v1/receipts?page=30&per_page=30>; rel=\"next\"",
"x-per-page": "30",
"x-total": "10201",
"x-page": "4"
}
query Parameters
page
integer <int32>
Default: 1

Page of results to fetch.

per_page
integer <int32>
Default: null

Number of results to return per page.

created_since
string <date-time>
order
string
Enum: "id" "-id" "receipt_number" "-receipt_number" "total_excl_tax" "-total_excl_tax" "created_at" "-created_at" "firstname" "-firstname" "lastname" "-lastname" "email" "-email" "payment_status" "-payment_status" "updated_at" "-updated_at"
filter[product_type]
string
Enum: "event" "membership" "donation"

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "external_id": "string",
  • "receipt_items": [
    ],
  • "receipt_number": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "vat_amount": 0.1,
  • "total_excl_tax": 0.1,
  • "total_incl_tax": 0.1,
  • "billing_address": {
    },
  • "shipping_address": {
    },
  • "firstname": "string",
  • "lastname": "string",
  • "email": "string",
  • "payment_status": "paid",
  • "user_id": 0,
  • "payment_gateway_informations": "string",
  • "payment_account_id": 0
}

Get receipt

Return the receipt based on its ID

Find the receipt matching its ID.

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "external_id": "string",
  • "receipt_items": [
    ],
  • "receipt_number": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "vat_amount": 0.1,
  • "total_excl_tax": 0.1,
  • "total_incl_tax": 0.1,
  • "billing_address": {
    },
  • "shipping_address": {
    },
  • "firstname": "string",
  • "lastname": "string",
  • "email": "string",
  • "payment_status": "paid",
  • "user_id": 0,
  • "payment_gateway_informations": "string",
  • "payment_account_id": 0
}

Update receipt

Update the receipt

Find the receipt matching its ID and update its payment parameter, external_id.

path Parameters
id
required
string
Request Body schema: application/x-www-form-urlencoded
receipt[payment_status]
string
Enum: "paid" "not_paid" "pending" "failed" "canceled"
receipt[external_id]
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "external_id": "string",
  • "receipt_items": [
    ],
  • "receipt_number": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "vat_amount": 0.1,
  • "total_excl_tax": 0.1,
  • "total_incl_tax": 0.1,
  • "billing_address": {
    },
  • "shipping_address": {
    },
  • "firstname": "string",
  • "lastname": "string",
  • "email": "string",
  • "payment_status": "paid",
  • "user_id": 0,
  • "payment_gateway_informations": "string",
  • "payment_account_id": 0
}

pages_customizable

Operations about pages_customizables

Get Pages Customizable

Return this network Customizable Page.

query Parameters
owner
string
Default: "network"
Enum: "network" "topic"
owner_id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "pages_customizable": [
    ]
}

Create Page Customizable

Create a network Customizable Page.

Request Body schema: application/x-www-form-urlencoded
locale
string
Enum: "en" "en-GB" "fr" "he" "de" "es" "it" "da" "nl" "pt" "ru" "deepbloo" "zh-Hans" "zh-Hant" "af" "pl" "fi" "nl-BE" "nb" "ja" "lt" "hu" "vi" "sv" "ko" "pt-BR" "el" "cy" "hi" "id"
owner
string
Default: "network"
Enum: "network" "topic"
owner_id
required
integer <int32>
page_customizable[menu_name]
string

Name of the tab

page_customizable[external]
boolean

Is the Customizable Page an external link ?

page_customizable[url]
required
string
page_customizable[slug]
string

short name to access Customizable Page

page_customizable[identifier]
string

Defines feature page

page_customizable[created_at]
string <date-time>

Customizable Page creation date

page_customizable[updated_at]
string <date-time>

Customizable Page last update date

page_customizable[title]
string

Title of the Customizable Page

page_customizable[short_description]
string

Short Description of the Customizable Page

page_customizable[content]
string

Content of the Customizable Page

page_customizable[seo_title]
string

SEO Title of the Customizable Page

page_customizable[seo_description]
string

SEO Description of the Cutomizable Page

page_customizable[enable_emphasize]
boolean

Dim the banner

page_customizable[open_in_new_tab]
boolean

Does the link opens in a new tab ?

page_customizable[draft]
boolean

Is the Customizable Page in draft mode or not

page_customizable[display_public]
boolean

Tab is displayed on public pages

page_customizable[display_private]
boolean

Tab is displayed on private pages

page_customizable[accessible_status]
string
Enum: "access_public" "access_private" "access_restricted"

Who can access the Customizable Page via URL; value 'access_restricted' enables filtering parameters

page_customizable[sub_network_ids][]
Array of integers <int32> [ items <int32 > ]

Filtering parameter: people belonging to these clusters / sub networks

page_customizable[memberships_type_ids][]
Array of integers <int32> [ items <int32 > ]

Filtering parameter: people having these kinds of memberships

page_customizable[role_ids][]
Array of integers <int32> [ items <int32 > ]

Filtering parameter: people having these role

page_customizable[filter_type_is_and]
boolean

Filtering parameters are using a OR logic if this param is FALSE. a AND logic is used if set to true

page_customizable[page_customizable_ids][]
Array of integers <int32> [ items <int32 > ]

IDs of child Customizable pages

page_customizable[cover_picture]
string <binary>

Cover picture of the Customizable page

page_customizable[delete_picture]
boolean

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "slug": "string",
  • "identifier": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "menu_name": "string",
  • "title": "string",
  • "short_description": "string",
  • "content": "string",
  • "url": "string",
  • "external": true,
  • "seo_title": "string",
  • "seo_description": "string",
  • "enable_emphasize": true,
  • "open_in_new_tab": true,
  • "draft": true,
  • "display_public": true,
  • "display_private": true,
  • "accessible_status": "access_public",
  • "cover_picture": {
    },
  • "sub_network_ids": 0,
  • "memberships_type_ids": 0,
  • "role_ids": 0,
  • "filter_type_is_and": true,
  • "page_customizable_ids": 0
}

Get Page Customizable

Return a network Customizable Page using its id or slug.

path Parameters
id
required
string
query Parameters
locale
string
Enum: "en" "en-GB" "fr" "he" "de" "es" "it" "da" "nl" "pt" "ru" "deepbloo" "zh-Hans" "zh-Hant" "af" "pl" "fi" "nl-BE" "nb" "ja" "lt" "hu" "vi" "sv" "ko" "pt-BR" "el" "cy" "hi" "id"
owner
string
Default: "network"
Enum: "network" "topic"
owner_id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "slug": "string",
  • "identifier": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "menu_name": "string",
  • "title": "string",
  • "short_description": "string",
  • "content": "string",
  • "url": "string",
  • "external": true,
  • "seo_title": "string",
  • "seo_description": "string",
  • "enable_emphasize": true,
  • "open_in_new_tab": true,
  • "draft": true,
  • "display_public": true,
  • "display_private": true,
  • "accessible_status": "access_public",
  • "cover_picture": {
    },
  • "sub_network_ids": 0,
  • "memberships_type_ids": 0,
  • "role_ids": 0,
  • "filter_type_is_and": true,
  • "page_customizable_ids": 0
}

Update Page Customizable

Update a network Customizable Page using its id or slug.

path Parameters
id
required
string
Request Body schema: application/x-www-form-urlencoded
locale
string
Enum: "en" "en-GB" "fr" "he" "de" "es" "it" "da" "nl" "pt" "ru" "deepbloo" "zh-Hans" "zh-Hant" "af" "pl" "fi" "nl-BE" "nb" "ja" "lt" "hu" "vi" "sv" "ko" "pt-BR" "el" "cy" "hi" "id"
owner
string
Default: "network"
Enum: "network" "topic"
owner_id
required
integer <int32>
page_customizable[external]
boolean

Is the Customizable Page an external link ?

page_customizable[url]
required
string
page_customizable[delete_picture]
boolean
page_customizable[slug]
string

short name to access Customizable Page

page_customizable[identifier]
string

Defines feature page

page_customizable[created_at]
string <date-time>

Customizable Page creation date

page_customizable[updated_at]
string <date-time>

Customizable Page last update date

page_customizable[menu_name]
string

Name of the tab

page_customizable[title]
string

Title of the Customizable Page

page_customizable[short_description]
string

Short Description of the Customizable Page

page_customizable[content]
string

Content of the Customizable Page

page_customizable[seo_title]
string

SEO Title of the Customizable Page

page_customizable[seo_description]
string

SEO Description of the Cutomizable Page

page_customizable[enable_emphasize]
boolean

Dim the banner

page_customizable[open_in_new_tab]
boolean

Does the link opens in a new tab ?

page_customizable[draft]
boolean

Is the Customizable Page in draft mode or not

page_customizable[display_public]
boolean

Tab is displayed on public pages

page_customizable[display_private]
boolean

Tab is displayed on private pages

page_customizable[accessible_status]
string
Enum: "access_public" "access_private" "access_restricted"

Who can access the Customizable Page via URL; value 'access_restricted' enables filtering parameters

page_customizable[sub_network_ids][]
Array of integers <int32> [ items <int32 > ]

Filtering parameter: people belonging to these clusters / sub networks

page_customizable[memberships_type_ids][]
Array of integers <int32> [ items <int32 > ]

Filtering parameter: people having these kinds of memberships

page_customizable[role_ids][]
Array of integers <int32> [ items <int32 > ]

Filtering parameter: people having these role

page_customizable[filter_type_is_and]
boolean

Filtering parameters are using a OR logic if this param is FALSE. a AND logic is used if set to true

page_customizable[page_customizable_ids][]
Array of integers <int32> [ items <int32 > ]

IDs of child Customizable pages

page_customizable[cover_picture]
string <binary>

Cover picture of the Customizable page

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "slug": "string",
  • "identifier": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "menu_name": "string",
  • "title": "string",
  • "short_description": "string",
  • "content": "string",
  • "url": "string",
  • "external": true,
  • "seo_title": "string",
  • "seo_description": "string",
  • "enable_emphasize": true,
  • "open_in_new_tab": true,
  • "draft": true,
  • "display_public": true,
  • "display_private": true,
  • "accessible_status": "access_public",
  • "cover_picture": {
    },
  • "sub_network_ids": 0,
  • "memberships_type_ids": 0,
  • "role_ids": 0,
  • "filter_type_is_and": true,
  • "page_customizable_ids": 0
}

Delete Customizable Page

Deletes the specified customizable page

path Parameters
id
required
string

Responses

approvals

Operations about approvals

Get approvals list

Return an array of approvals with basic information

Pagination information are stored in the response header as defined by RFC-5988 http://tools.ietf.org/html/rfc5988

Example:

{
"link": "<https://hivebrite.com/api/admin/v1/approvals?page=1&per_page=30>; rel=\"first\", <https://hivebrite.com/api/admin/v1/approvals?page=3&per_page=30>; rel=\"prev\", <https://hivebrite.com/api/admin/v1/approvals?page=2041&per_page=30>; rel=\"last\", <https://hivebrite.com/api/admin/v1/approvals?page=30&per_page=30>; rel=\"next\"",
"x-per-page": "30",
"x-total": "10201",
"x-page": "4"
}
query Parameters
page
integer <int32>
Default: 1

Page of results to fetch.

per_page
integer <int32>
Default: null

Number of results to return per page.

filter
string
Enum: "pending" "approved" "rejected" "joined" "linked" "open_signup" "manual_archived"

Responses

Response samples

Content type
application/json
{
  • "approvals": [
    ]
}

Get approval detail

Get a specified approval request

path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "email": "string",
  • "lastname": "string",
  • "firstname": "string",
  • "maidenname": "string",
  • "honorary_title": "mr",
  • "gender": "female",
  • "birthday": "2019-08-24",
  • "birthplace": "string",
  • "awards": "string",
  • "mobile_perso": "string",
  • "mobile_pro": "string",
  • "landline_perso": "string",
  • "landline_pro": "string",
  • "headline": "string",
  • "summary": "string",
  • "prefix_name": "string",
  • "suffix_name": "string",
  • "status": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "citizenship_country_codes": [
    ],
  • "sub_networks": [
    ],
  • "industries": {
    },
  • "skills": {
    },
  • "custom_attributes": [
    ],
  • "user": {
    }
}

Delete approval

Delete the specified approval

path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "email": "string",
  • "lastname": "string",
  • "firstname": "string",
  • "maidenname": "string",
  • "honorary_title": "mr",
  • "gender": "female",
  • "birthday": "2019-08-24",
  • "birthplace": "string",
  • "awards": "string",
  • "mobile_perso": "string",
  • "mobile_pro": "string",
  • "landline_perso": "string",
  • "landline_pro": "string",
  • "headline": "string",
  • "summary": "string",
  • "prefix_name": "string",
  • "suffix_name": "string",
  • "status": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "citizenship_country_codes": [
    ],
  • "sub_networks": [
    ],
  • "industries": {
    },
  • "skills": {
    },
  • "custom_attributes": [
    ],
  • "user": {
    }
}

Reject request to join

Reject the approval request

path Parameters
id
required
integer <int32>
Request Body schema: application/x-www-form-urlencoded
send_email
boolean
Default: false

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "email": "string",
  • "lastname": "string",
  • "firstname": "string",
  • "maidenname": "string",
  • "honorary_title": "mr",
  • "gender": "female",
  • "birthday": "2019-08-24",
  • "birthplace": "string",
  • "awards": "string",
  • "mobile_perso": "string",
  • "mobile_pro": "string",
  • "landline_perso": "string",
  • "landline_pro": "string",
  • "headline": "string",
  • "summary": "string",
  • "prefix_name": "string",
  • "suffix_name": "string",
  • "status": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "citizenship_country_codes": [
    ],
  • "sub_networks": [
    ],
  • "industries": {
    },
  • "skills": {
    },
  • "custom_attributes": [
    ],
  • "user": {
    }
}

Approve request to join

Accept the approval request

path Parameters
id
required
integer <int32>
Request Body schema: application/x-www-form-urlencoded
send_email
boolean
Default: false
send_activation
boolean
Default: false

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "email": "string",
  • "lastname": "string",
  • "firstname": "string",
  • "maidenname": "string",
  • "honorary_title": "mr",
  • "gender": "female",
  • "birthday": "2019-08-24",
  • "birthplace": "string",
  • "awards": "string",
  • "mobile_perso": "string",
  • "mobile_pro": "string",
  • "landline_perso": "string",
  • "landline_pro": "string",
  • "headline": "string",
  • "summary": "string",
  • "prefix_name": "string",
  • "suffix_name": "string",
  • "status": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "citizenship_country_codes": [
    ],
  • "sub_networks": [
    ],
  • "industries": {
    },
  • "skills": {
    },
  • "custom_attributes": [
    ],
  • "user": {
    }
}

versions

Operations about versions

Get deleted items

Return an array of deleted items and the person who deleted it

Use the param deleted_since to fetch all users deleted since this datetime (e.g. deleted_since=2017-08-01T00:00:00)

Pagination information are stored in the response header as defined by RFC-5988 http://tools.ietf.org/html/rfc5988

Example:

{
"link": "<https://hivebrite.com/api/admin/v1/versions/deleted?page=1&per_page=30>; rel=\"first\", <https://hivebrite.com/api/admin/v1/versions/deleted?page=3&per_page=30>; rel=\"prev\", <https://hivebrite.com/api/admin/v1/versions/deleted?page=2041&per_page=30>; rel=\"last\", <https://hivebrite.com/api/admin/v1/versions/deleted?page=30&per_page=30>; rel=\"next\"",
"x-per-page": "30",
"x-total": "10201",
"x-page": "4"
}
query Parameters
page
integer <int32>
Default: 1

Page of results to fetch.

per_page
integer <int32>
Default: null

Number of results to return per page.

deleted_since
string <date-time>
item_types[]
Array of strings
Items Enum: "user" "experience" "education" "company"

Responses

Response samples

Content type
application/json
{
  • "item_id": 0,
  • "item_type": "string",
  • "event": "string",
  • "action_by": { },
  • "created_at": "2019-08-24T14:15:22Z"
}

comments

Operations about comments

List of comments

This endpoint lists comments for a specific parent object.

Commentable Parent Types

The parent_type parameter specifies the type of content that can receive comments. Each type represents a different feature or content type in the front office.

article

Relates to: Articles in the Portfolio feature
Required Admin Permission:

  • Global: Module > Portfolio

business_opportunities_request

Relates to: Job postings and business opportunities
Required Admin Permission:

  • Global: Module > Opportunities
  • Group based: Groups > Manage Opportunities

comment

Relates to: Comments on other content. Use this type when creating replies to comments.
Required Admin Permission: Inherits from the parent content type being commented on.

communications_news

Relates to: News posts
Required Admin Permission:

  • Global: Module > News
  • Group based: Groups > Manage news

event

Relates to: User-created events
Required Admin Permission:

  • Global: Module > Events

forums_discussion

Relates to: Forum posts and discussions
Required Admin Permission:

  • Global: Module > Forums
  • Group based: Groups > Manage forums

location

Relates to: Location-based content (e.g check-ins, trips, etc.)
Required Admin Permission:

  • Global: Module > Community > Can access "Community" and user data > Data Management

media_center_file

Relates to: Files in the Media Center
Required Admin Permission:

  • Global: Module > Media Center
  • Group based: Groups > Manage media center

network_event

Relates to: Network-organized events
Required Admin Permission:

  • Global: Module > Events
  • Group based: Groups > Manage Events

post

Relates to: Posts in the Live Feed, or group Feed.
Required Admin Permission:

  • Global: Module > Live Feed
  • Group based: Groups > Can manage group settings

ventures

Relates to: Projects objects
Required Admin Permission:

  • Global: Module > Projects
  • Group based: Groups > Manage projects

user

Relates to: User objects
Required Admin Permission:

  • Global: Module > Users
  • Group based: Groups > Manage users
query Parameters
parent_type
required
string
Enum: "article" "comment" "location" "media_center_file" "post" "user" "business_opportunities_request" "communications_news" "event" "forums_discussion" "network_event" "ventures"

The type of the parent object

parent_id
required
integer <int32>

The ID of the parent object

replies_limit
integer <int32> [ -1 .. 100 ]
Default: 10

The number of replies to return per comment

page
integer <int32>
Default: 1

Page of results to fetch.

per_page
integer <int32>
Default: 20

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "total_count": "string"
}

Create a new comment

This endpoint creates a new comment for a specific parent object.

Commentable Parent Types

The parent_type parameter specifies the type of content that can receive comments. Each type represents a different feature or content type in the front office.

article

Relates to: Articles in the Portfolio feature
Required Admin Permission:

  • Global: Module > Portfolio

business_opportunities_request

Relates to: Job postings and business opportunities
Required Admin Permission:

  • Global: Module > Opportunities
  • Group based: Groups > Manage Opportunities

comment

Relates to: Comments on other content. Use this type when creating replies to comments.
Required Admin Permission: Inherits from the parent content type being commented on.

communications_news

Relates to: News posts
Required Admin Permission:

  • Global: Module > News
  • Group based: Groups > Manage news

event

Relates to: User-created events
Required Admin Permission:

  • Global: Module > Events

forums_discussion

Relates to: Forum posts and discussions
Required Admin Permission:

  • Global: Module > Forums
  • Group based: Groups > Manage forums

location

Relates to: Location-based content (e.g check-ins, trips, etc.)
Required Admin Permission:

  • Global: Module > Community > Can access "Community" and user data > Data Management

media_center_file

Relates to: Files in the Media Center
Required Admin Permission:

  • Global: Module > Media Center
  • Group based: Groups > Manage media center

network_event

Relates to: Network-organized events
Required Admin Permission:

  • Global: Module > Events
  • Group based: Groups > Manage Events

post

Relates to: Posts in the Live Feed, or group Feed.
Required Admin Permission:

  • Global: Module > Live Feed
  • Group based: Groups > Can manage group settings

ventures

Relates to: Projects objects
Required Admin Permission:

  • Global: Module > Projects
  • Group based: Groups > Manage projects

user

Relates to: User objects
Required Admin Permission:

  • Global: Module > Users
  • Group based: Groups > Manage users
Request Body schema: application/x-www-form-urlencoded
required
parent_type
required
string
Enum: "article" "comment" "location" "media_center_file" "post" "user" "business_opportunities_request" "communications_news" "event" "forums_discussion" "network_event" "ventures"

The type of the parent object. Can be a new type or a legacy type.

parent_id
required
integer <int32>

The ID of the parent object

user_id
required
integer <int32>

The ID of the user who is the author of the comment

content
required
string

The content of the comment

created_at
string <date-time>

The time the comment was created

files[]
Array of file

The files attached to the comment. Only 1 file is allowed for now.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "parent_type": "string",
  • "parent_id": "string",
  • "user_id": "string",
  • "content": "string",
  • "uploads": {
    },
  • "attachments": {
    },
  • "embed": "string",
  • "likes": {
    },
  • "likes_count": "string",
  • "votes": {
    },
  • "votes_count": "string",
  • "replies_count": "string",
  • "created_at": "string",
  • "updated_at": "string",
  • "replies": {
    }
}

getAdminV3CommentsCommentId

Show a comment

path Parameters
comment_id
required
integer <int32>
query Parameters
replies_limit
integer <int32> [ -1 .. 100 ]
Default: 10

The number of replies embedded in the comment. -1 for all replies.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "parent_type": "string",
  • "parent_id": "string",
  • "user_id": "string",
  • "content": "string",
  • "uploads": {
    },
  • "attachments": {
    },
  • "embed": "string",
  • "likes": {
    },
  • "likes_count": "string",
  • "votes": {
    },
  • "votes_count": "string",
  • "replies_count": "string",
  • "created_at": "string",
  • "updated_at": "string",
  • "replies": {
    }
}

Update a comment

Update a comment with the specified parameters.

File parameters

When updating a comment, if files[] is empty, nothing will happen to the comment's file (if there is one).
If files[] is not empty :

  • if the comment already has a file, it will be replaced by the new file.
  • if the comment has no file, the new file will be added to the comment.
    If you want to delete the comment's file (without replacing it), you need to use `file_ids_to_delete[]`.
path Parameters
comment_id
required
integer <int32>
Request Body schema: application/x-www-form-urlencoded
content
string

The content of the comment

created_at
string <date-time>

The time the comment was created

updated_at
string <date-time>

The time the comment was last updated

files[]
Array of file

The files attached to the comment. Only 1 file is allowed for now.

file_ids_to_delete[]
Array of integers <int32> [ items <int32 > ]

The IDs of the files to delete

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "parent_type": "string",
  • "parent_id": "string",
  • "user_id": "string",
  • "content": "string",
  • "uploads": {
    },
  • "attachments": {
    },
  • "embed": "string",
  • "likes": {
    },
  • "likes_count": "string",
  • "votes": {
    },
  • "votes_count": "string",
  • "replies_count": "string",
  • "created_at": "string",
  • "updated_at": "string",
  • "replies": {
    }
}

Delete a comment

This endpoint will delete a comment and all its replies.

path Parameters
comment_id
required
integer <int32>

Responses

network_events

Operations about network_events

Ticket Index

Get a paginated list of Ticket for your Network

You can restrict to the list of Tickets of one event using the event_id parameter.

Pagination information are stored in the response header as defined by RFC-5988 http://tools.ietf.org/html/rfc5988

Example:

{
"link": "<https://hivebrite.com/api/admin/v2/network_events/:event_id/tickets?page=1&per_page=30>; rel=\"first\", <https://hivebrite.com/api/admin/v2/network_events/:event_id/tickets?page=3&per_page=30>; rel=\"prev\", <https://hivebrite.com/api/admin/v2/network_events/:event_id/tickets?page=2041&per_page=30>; rel=\"last\", <https://hivebrite.com/api/admin/v2/network_events/:event_id/tickets?page=30&per_page=30>; rel=\"next\"",
"x-per-page": "30",
"x-total": "10201",
"x-page": "4"
}
query Parameters
event_id
integer <int32>
updated_since
string <date-time>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "event_id": 0,
  • "description": "string",
  • "name": "string",
  • "price": 0.1,
  • "number": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "currency": "string",
  • "internal_ticket": true,
  • "maximum_per_person": 0,
  • "expiry_date": "2019-08-24T14:15:22Z",
  • "discarded_at": "2019-08-24T14:15:22Z",
  • "attendee_ids": 0,
  • "customizable_attribute_ids": 0
}

Ticket Details

Get a Ticket

The customizable attributes can be retrieved on the /api/admin/v1/settings/customizable_attributes endpoint. Their IDs are NOT the same one as those of the Events. However, the names are the same and will be used when adding attendees.

path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "event_id": 0,
  • "description": "string",
  • "name": "string",
  • "price": 0.1,
  • "number": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "currency": "string",
  • "internal_ticket": true,
  • "maximum_per_person": 0,
  • "expiry_date": "2019-08-24T14:15:22Z",
  • "discarded_at": "2019-08-24T14:15:22Z",
  • "attendee_ids": 0,
  • "customizable_attribute_ids": 0
}

Ticket Deletion

Discard a Ticket for an Event

The ticket targeted will be discarded and won't appear to the end-users. A timestamp will be set on the :discarded_at field.

path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "event_id": 0,
  • "description": "string",
  • "name": "string",
  • "price": 0.1,
  • "number": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "currency": "string",
  • "internal_ticket": true,
  • "maximum_per_person": 0,
  • "expiry_date": "2019-08-24T14:15:22Z",
  • "discarded_at": "2019-08-24T14:15:22Z",
  • "attendee_ids": 0,
  • "customizable_attribute_ids": 0
}

Ticket Update

Ticket Update

path Parameters
id
required
integer <int32>
Request Body schema: application/x-www-form-urlencoded
ticket[description]
string

Ticket Event Description

ticket[name]
string

Ticket Event Name

ticket[price]
number <float>

Ticket Event price

ticket[number]
integer <int32>

Number of tickets for the event

ticket[currency]
string

ISO code of the Currency of the Ticket Event

ticket[internal_ticket]
boolean

Are visitors restricted from buying this Ticket Event ?

ticket[maximum_per_person]
integer <int32>

Maximum number a user can buy this ticket // does not apply to external people from the platform (0 or nil: unlimited), must be nil or greater than 0

ticket[expiry_date]
string <date-time>

Ticket Event expiration date (people won't be able to buy ) - iso8601

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "event_id": 0,
  • "description": "string",
  • "name": "string",
  • "price": 0.1,
  • "number": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "currency": "string",
  • "internal_ticket": true,
  • "maximum_per_person": 0,
  • "expiry_date": "2019-08-24T14:15:22Z",
  • "discarded_at": "2019-08-24T14:15:22Z",
  • "attendee_ids": 0,
  • "customizable_attribute_ids": 0
}

Customizable Attribute Unlink

The customizable attributes of an event can be retrieved on the /api/admin/v1/settings/customizable_attributes endpoint. The ID of a Customizable Attribute of an Event is not the same as the one that will be linked to the Ticket. BEWARE: This will delete the Attendee's answer to this customizable attribute.

path Parameters
ticket_id
required
integer <int32>
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "customizable_id": 0,
  • "type": "CustomizableAttribute::Boolean",
  • "customizable_type": "bizopp",
  • "name": "string",
  • "display_name": "string",
  • "tooltip": "string",
  • "placeholder": "string",
  • "multi": true,
  • "text_size": 0,
  • "visibility": "admin_only",
  • "user_editable": true,
  • "required": true,
  • "options": [
    ],
  • "json_options": { },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "selected_value": "string"
}

Ticket Creation

Create a Ticket for an Event

You can create a Ticket for the Event designated with the :event_id. Required params are :

  • a name,
  • a price (0.0 if free)
  • a currency ISO code (List is available at /api/admin/v1/settings/currencies)
  • the number of tickets set to sale (0 if unlimited) You can't set a value 'maximum_per_person' greater than 'number'.
path Parameters
event_id
required
integer <int32>
Request Body schema: application/x-www-form-urlencoded
required
ticket[name]
required
string
ticket[price]
required
number <float>
Default: 0
ticket[currency]
required
string
ticket[number]
required
integer <int32>
Default: 0
ticket[description]
string

Ticket Event Description

ticket[internal_ticket]
boolean

Are visitors restricted from buying this Ticket Event ?

ticket[maximum_per_person]
integer <int32>

Maximum number a user can buy this ticket // does not apply to external people from the platform (0 or nil: unlimited), must be nil or greater than 0

ticket[expiry_date]
string <date-time>

Ticket Event expiration date (people won't be able to buy ) - iso8601

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "event_id": 0,
  • "description": "string",
  • "name": "string",
  • "price": 0.1,
  • "number": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "currency": "string",
  • "internal_ticket": true,
  • "maximum_per_person": 0,
  • "expiry_date": "2019-08-24T14:15:22Z",
  • "discarded_at": "2019-08-24T14:15:22Z",
  • "attendee_ids": 0,
  • "customizable_attribute_ids": 0
}

Booking Index

Get a paginated list of Bookings

You can restrict to a certain Network Event with the params :event_id

Pagination information are stored in the response header as defined by RFC-5988 http://tools.ietf.org/html/rfc5988

Example:

{
"link": "<https://hivebrite.com/api/admin/v2/network_events/:event_id/bookings?page=1&per_page=30>; rel=\"first\", <https://hivebrite.com/api/admin/v2/network_events/:event_id/bookings?page=3&per_page=30>; rel=\"prev\", <https://hivebrite.com/api/admin/v2/network_events/:event_id/bookings?page=2041&per_page=30>; rel=\"last\", <https://hivebrite.com/api/admin/v2/network_events/:event_id/bookings?page=30&per_page=30>; rel=\"next\"",
"x-per-page": "30",
"x-total": "10201",
"x-page": "4"
}
query Parameters
event_id
integer <int32>
updated_since
string <date-time>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_id": 0,
  • "receipt_id": 0,
  • "firstname": "string",
  • "lastname": "string",
  • "email": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "payment_status": "paid",
  • "cancelled_at": "2019-08-24T14:15:22Z",
  • "added_by_admin": true,
  • "added_by_admin_id": 0,
  • "attendee_ids": 0
}

Booking Details

Get a booking

Attendees can be retrieved on /api/admin/v2/network_events/attendees

path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_id": 0,
  • "receipt_id": 0,
  • "firstname": "string",
  • "lastname": "string",
  • "email": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "payment_status": "paid",
  • "cancelled_at": "2019-08-24T14:15:22Z",
  • "added_by_admin": true,
  • "added_by_admin_id": 0,
  • "attendee_ids": 0
}

Booking Deletion

Deletes a booking

Deletes the booking object and all the attendees attached to it.

path Parameters
id
required
integer <int32>

Responses

Booking Update

Booking Update

path Parameters
id
required
integer <int32>
Request Body schema: application/x-www-form-urlencoded
required
booking[attendees][][id]
required
Array of integers <int32> [ items <int32 > ]
booking[attendees][][customizable_attributes][]
Array of objects
booking[attendees][][firstname]
Array of strings

Firstname

booking[attendees][][lastname]
Array of strings

Lastname

booking[attendees][][email]
Array of strings

Email

booking[attendees][][company_name]
Array of strings

Organization name

booking[attendees][][mobile_phone]
Array of strings

Phone number

booking[attendees][][custom_field_1]
Array of strings

Ticket custom field 1

booking[attendees][][custom_field_2]
Array of strings

Ticket custom field 2

booking[attendees][][custom_field_3]
Array of strings

Ticket custom field 3

booking[attendees][][participation_status]
Array of strings
Items Enum: "planned" "show" "no_show" "canceled" "cancelled_by_admin" "refunded"

Participation status of the Attendee

booking[attendees][][note]
Array of strings

Note regarding the Attendee

booking[attendees][][booking_id]
Array of integers <int32> [ items <int32 > ]

ID of the booking

booking[user_id]
integer <int32>

User ID for this Booking

booking[firstname]
string

Firstname

booking[lastname]
string

Lastname

booking[email]
string

Email

booking[payment_status]
string
Enum: "paid" "not_paid" "refunded" "cancelled" "cancelled_by_admin"

Payment status of the Booking

booking[added_by_admin]
boolean

Added by an admin

booking[added_by_admin_id]
integer <int32>

ID of the admin who add the user to this booking

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_id": 0,
  • "receipt_id": 0,
  • "firstname": "string",
  • "lastname": "string",
  • "email": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "payment_status": "paid",
  • "cancelled_at": "2019-08-24T14:15:22Z",
  • "added_by_admin": true,
  • "added_by_admin_id": 0,
  • "attendee_ids": 0
}

Booking Creation

Booking creation

Required params are :

  • a user ID OR
  • a Lastname
  • a Firstname
  • an Email

If a user ID is given, associated user will have its lastname / firstname / email extracted to fill those. If Lastname/Firstname/Email is given along with the User ID, those will have precedence over user fields.

The same goes for the the attendees attributes.

To fill the attendees' customizable attributes values, you need to set up a ticket ID. You can set the customizable attributes value that way :

"attendees": [
  {
    "user_id": my_id,
    "ticket_id": my_ticket_id,
    "customizable_attributes": [
      "_are_you_vegetarian": true,
      "_how_many_people_do_you_bring", 3
    ]
  }
]
path Parameters
event_id
required
integer <int32>
Request Body schema: application/x-www-form-urlencoded
booking[user_id]
integer <int32>
booking[firstname]
required
string
booking[lastname]
required
string
booking[email]
required
string
booking[attendees][][user_id]
Array of integers <int32> [ items <int32 > ]
booking[attendees][][firstname]
required
Array of strings
booking[attendees][][lastname]
required
Array of strings
booking[attendees][][email]
required
Array of strings
booking[attendees][][customizable_attributes][]
Array of objects
booking[attendees][][company_name]
Array of strings

Organization name

booking[attendees][][mobile_phone]
Array of strings

Phone number

booking[attendees][][custom_field_1]
Array of strings

Ticket custom field 1

booking[attendees][][custom_field_2]
Array of strings

Ticket custom field 2

booking[attendees][][custom_field_3]
Array of strings

Ticket custom field 3

booking[attendees][][participation_status]
Array of strings
Items Enum: "planned" "show" "no_show" "canceled" "cancelled_by_admin" "refunded"

Participation status of the Attendee

booking[attendees][][note]
Array of strings

Note regarding the Attendee

booking[attendees][][ticket_id]
Array of integers <int32> [ items <int32 > ]

ID of the ticket purchased

booking[attendees][][booking_id]
Array of integers <int32> [ items <int32 > ]

ID of the booking

booking[attendees][][event_id]
Array of integers <int32> [ items <int32 > ]

Event ID attended

booking[payment_status]
string
Enum: "paid" "not_paid" "refunded" "cancelled" "cancelled_by_admin"

Payment status of the Booking

booking[added_by_admin]
boolean

Added by an admin

booking[added_by_admin_id]
integer <int32>

ID of the admin who add the user to this booking

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_id": 0,
  • "receipt_id": 0,
  • "firstname": "string",
  • "lastname": "string",
  • "email": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "payment_status": "paid",
  • "cancelled_at": "2019-08-24T14:15:22Z",
  • "added_by_admin": true,
  • "added_by_admin_id": 0,
  • "attendee_ids": 0
}

Attendees Index

Get a paginated list of Attendees

Can be restricted to a specific booking or event using the parameter :booking_id or :event_id.

          Pagination information are stored in the response header as defined by RFC-5988

http://tools.ietf.org/html/rfc5988 Example:

{
"link": "<https://hivebrite.com/api/admin/v2/network_events/attendees?page=1&per_page=30>; rel=\"first\", <https://hivebrite.com/api/admin/v2/network_events/attendees?page=3&per_page=30>; rel=\"prev\", <https://hivebrite.com/api/admin/v2/network_events/attendees?page=2041&per_page=30>; rel=\"last\", <https://hivebrite.com/api/admin/v2/network_events/attendees?page=30&per_page=30>; rel=\"next\"",
"x-per-page": "30",
"x-total": "10201",
"x-page": "4"
}
query Parameters
event_id
integer <int32>
booking_id
integer <int32>
updated_since
string <date-time>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_id": 0,
  • "firstname": "string",
  • "lastname": "string",
  • "email": "string",
  • "company_name": "string",
  • "mobile_phone": "string",
  • "custom_field_1": "string",
  • "custom_field_2": "string",
  • "custom_field_3": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "participation_status": "planned",
  • "note": "string",
  • "ticket_id": 0,
  • "booking_id": 0,
  • "event_id": 0,
  • "customizable_attributes": [
    ]
}

Attendee Details

Get an Attendee

path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_id": 0,
  • "firstname": "string",
  • "lastname": "string",
  • "email": "string",
  • "company_name": "string",
  • "mobile_phone": "string",
  • "custom_field_1": "string",
  • "custom_field_2": "string",
  • "custom_field_3": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "participation_status": "planned",
  • "note": "string",
  • "ticket_id": 0,
  • "booking_id": 0,
  • "event_id": 0,
  • "customizable_attributes": [
    ]
}

Attendee Deletion

Delete an Attendee

Delete the attendee from the booking.

path Parameters
id
required
integer <int32>

Responses

Attendee Update

Attendee update

You can find the customizable attributes names from the Ticket customizable attributes IDs then on the customizable attributes endpoint, get the 'name' of these customizable attributes. To update the attendee's customizable attributes values, you need to have set up a ticket ID. You can set the customizable attributes value that way :

 "attendee": {
  "customizable_attributes": [
    "_are_you_vegetarian": true,
    "_how_many_people_do_you_bring", 3
  ]
}
path Parameters
id
required
integer <int32>
Request Body schema: application/x-www-form-urlencoded
attendee[customizable_attributes][]
Array of objects
attendee[firstname]
string

Firstname

attendee[lastname]
string

Lastname

attendee[email]
string

Email

attendee[company_name]
string

Organization name

attendee[mobile_phone]
string

Phone number

attendee[custom_field_1]
string

Ticket custom field 1

attendee[custom_field_2]
string

Ticket custom field 2

attendee[custom_field_3]
string

Ticket custom field 3

attendee[participation_status]
string

Participation status of the Attendee

attendee[note]
string

Note regarding the Attendee

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_id": 0,
  • "firstname": "string",
  • "lastname": "string",
  • "email": "string",
  • "company_name": "string",
  • "mobile_phone": "string",
  • "custom_field_1": "string",
  • "custom_field_2": "string",
  • "custom_field_3": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "participation_status": "planned",
  • "note": "string",
  • "ticket_id": 0,
  • "booking_id": 0,
  • "event_id": 0,
  • "customizable_attributes": [
    ]
}

RSVP Index

Get a paginated list of Responses

You can restrict to a certain Network Event with the params :event_id

You can restrict to a certain User with the params :user_id

You can restrict to a certain Status with the params :status

You can restrict to a certain Participation status with the params :participation_status

Pagination information are stored in the response header as defined by RFC-5988 http://tools.ietf.org/html/rfc5988

Example:

{
"link": "<https://hivebrite.com/api/admin/v2/network_events/:event_id/rsvp?page=1&per_page=30>; rel=\"first\", <https://hivebrite.com/api/admin/v2/network_events/:event_id/rsvp?page=3&per_page=30>; rel=\"prev\", <https://hivebrite.com/api/admin/v2/network_events/:event_id/rsvp?page=2041&per_page=30>; rel=\"last\", <https://hivebrite.com/api/admin/v2/network_events/:event_id/rsvp?page=30&per_page=30>; rel=\"next\"",
"x-per-page": "30",
"x-total": "10201",
"x-page": "4"
}
path Parameters
event_id
required
integer <int32>
query Parameters
user_id
integer <int32>
status
string
updated_since
string <date-time>
participation_status
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_id": 0,
  • "visible": true,
  • "status": "attend",
  • "participation_status": "pending",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

RSVP Creation

RSVP creation

Required params are :

  • a user ID
  • rsvp visibility
  • status in [attend maybe_attend cancel cancelled_by_admin]
path Parameters
event_id
required
integer <int32>
Request Body schema: application/x-www-form-urlencoded
required
rsvp[user_id]
required
integer <int32>
rsvp[status]
required
string
Enum: "attend" "maybe_attend" "cancel" "cancelled_by_admin"
rsvp[participation_status]
string
Enum: "pending" "did_not_attend" "attended"
rsvp[visible]
required
boolean

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_id": 0,
  • "visible": true,
  • "status": "attend",
  • "participation_status": "pending",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

RSVP Details

Get a rsvp

path Parameters
event_id
required
integer <int32>
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_id": 0,
  • "visible": true,
  • "status": "attend",
  • "participation_status": "pending",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

RSVP Deletion

Deletes a rsvp

Deletes the rsvp object.

path Parameters
event_id
required
integer <int32>
id
required
integer <int32>

Responses

RSVP Update

RSVP Update

path Parameters
event_id
required
integer <int32>
id
required
integer <int32>
Request Body schema: application/x-www-form-urlencoded
rsvp[status]
string
Enum: "attend" "maybe_attend" "cancel" "cancelled_by_admin"
rsvp[participation_status]
string
Enum: "pending" "did_not_attend" "attended"
rsvp[visibile]
boolean

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_id": 0,
  • "visible": true,
  • "status": "attend",
  • "participation_status": "pending",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Network Event Index

Get a paginated list of Network Events

Use the parent option filtering to retrieve only topic/network events. Use the parent_id option filtering along the topic filtering option to get events from a certain topic.

Pagination information are stored in the response header as defined by RFC-5988 http://tools.ietf.org/html/rfc5988

Example:

{
"link": "<https://hivebrite.com/api/admin/v2/network_events?page=1&per_page=30>; rel=\"first\", <https://hivebrite.com/api/admin/v2/network_events?page=3&per_page=30>; rel=\"prev\", <https://hivebrite.com/api/admin/v2/network_events?page=2041&per_page=30>; rel=\"last\", <https://hivebrite.com/api/admin/v2/network_events?page=30&per_page=30>; rel=\"next\"",
"x-per-page": "30",
"x-total": "10201",
"x-page": "4"
}
query Parameters
parent
string
Default: "all"
Enum: "network" "topic" "all"
registration_type
string
Default: "all"
Enum: "no_participation" "rsvp" "tickets" "all"
parent_id
integer <int32>
updated_since
string <date-time>
start_date_before
string <date-time>
start_date_after
string <date-time>
end_date_before
string <date-time>
end_date_after
string <date-time>
title
string

Filter by title

locale
string
Enum: "en" "en-GB" "fr" "he" "de" "es" "it" "da" "nl" "pt" "ru" "deepbloo" "zh-Hans" "zh-Hant" "af" "pl" "fi" "nl-BE" "nb" "ja" "lt" "hu" "vi" "sv" "ko" "pt-BR" "el" "cy" "hi" "id"

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "title": "string",
  • "venue": "string",
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "registration_type": "string",
  • "location": {
    },
  • "webinar_url": "string",
  • "logo": "string",
  • "contact_email": "string",
  • "contact_phone_number": "string",
  • "published_at": "2019-08-24T14:15:22Z",
  • "feedable_at": "2019-08-24T14:15:22Z",
  • "cancelled": "string",
  • "cancelled_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "public": true,
  • "total_tickets": 0,
  • "tickets_due_date": "2019-08-24T14:15:22Z",
  • "max_tickets_per_user": 0,
  • "cover_picture": "string",
  • "organizer": "string",
  • "timezone": "Africa/Abidjan",
  • "hide_from_general_list": true,
  • "visible_on_index_page": true,
  • "visible_on_livefeed": true,
  • "send_confirmation_email": true,
  • "show_participants": true,
  • "public_show_participants": true,
  • "attendees_can_pay_later": true,
  • "public_attendees_can_pay_later": true,
  • "users_can_cancel_participation": true,
  • "display_price_tag": true,
  • "cancellation_deadline_for_users": 0,
  • "send_cancellation_email": true,
  • "display_refund_policy": true,
  • "refund_policy_content": "string",
  • "receipts_enabled": true,
  • "seo_title": "string",
  • "seo_description": "string",
  • "canonical_url": "string",
  • "ticket_ids": 0,
  • "attendee_ids": 0,
  • "booking_ids": 0,
  • "network_category_ids": 0,
  • "topic_ids": 0,
  • "communication_ids": 0,
  • "customizable_attribute_ids": 0,
  • "parent": {
    },
  • "payment_account": {
    },
  • "payment_flow": "only_pay_now",
  • "display_related_topics": true,
  • "show_webinar_url": true,
  • "pinned_on_index_page": true,
  • "pinned_to_live_feed": true,
  • "is_internal_zoom_meeting": true,
  • "external_api_integration_id": 0,
  • "zoom_meeting_id": "string",
  • "zoom_meeting_password": "string",
  • "zoom_attendance_tracking_enabled": true
}

Network Event Creation

Network Event creation

Required params are :

  • a Title,
  • a Description
  • a Start Date
  • an End Date
  • a Timezone

Logo and cover_picture must be sent as files (URL to files won't work)

The Location can be set using a Hash format. We'll deduce the location from the information input.

Request Body schema: application/x-www-form-urlencoded
locale
string
Enum: "en" "en-GB" "fr" "he" "de" "es" "it" "da" "nl" "pt" "ru" "deepbloo" "zh-Hans" "zh-Hant" "af" "pl" "fi" "nl-BE" "nb" "ja" "lt" "hu" "vi" "sv" "ko" "pt-BR" "el" "cy" "hi" "id"

select a specific locale to edit, if no locale is selected the default network locale will be used.

network_event[title]
required
string
network_event[description]
required
string
network_event[start_date]
required
string <date-time>
network_event[end_date]
required
string <date-time>
network_event[timezone]
required
string
Enum: "Africa/Abidjan" "Africa/Algiers" "Africa/Bissau" "Africa/Cairo" "Africa/Casablanca" "Africa/Ceuta" "Africa/El_Aaiun" "Africa/Johannesburg" "Africa/Juba" "Africa/Khartoum" "Africa/Lagos" "Africa/Maputo" "Africa/Monrovia" "Africa/Nairobi" "Africa/Ndjamena" "Africa/Sao_Tome" "Africa/Tripoli" "Africa/Tunis" "Africa/Windhoek" "America/Adak" "America/Anchorage" "America/Araguaina" "America/Argentina/Buenos_Aires" "America/Argentina/Catamarca" "America/Argentina/Cordoba" "America/Argentina/Jujuy" "America/Argentina/La_Rioja" "America/Argentina/Mendoza" "America/Argentina/Rio_Gallegos" "America/Argentina/Salta" "America/Argentina/San_Juan" "America/Argentina/San_Luis" "America/Argentina/Tucuman" "America/Argentina/Ushuaia" "America/Asuncion" "America/Bahia" "America/Bahia_Banderas" "America/Barbados" "America/Belem" "America/Belize" "America/Boa_Vista" "America/Bogota" "America/Boise" "America/Cambridge_Bay" "America/Campo_Grande" "America/Cancun" "America/Caracas" "America/Cayenne" "America/Chicago" "America/Chihuahua" "America/Ciudad_Juarez" "America/Costa_Rica" "America/Cuiaba" "America/Danmarkshavn" "America/Dawson" "America/Dawson_Creek" "America/Denver" "America/Detroit" "America/Edmonton" "America/Eirunepe" "America/El_Salvador" "America/Fort_Nelson" "America/Fortaleza" "America/Glace_Bay" "America/Goose_Bay" "America/Grand_Turk" "America/Guatemala" "America/Guayaquil" "America/Guyana" "America/Halifax" "America/Havana" "America/Hermosillo" "America/Indiana/Indianapolis" "America/Indiana/Knox" "America/Indiana/Marengo" "America/Indiana/Petersburg" "America/Indiana/Tell_City" "America/Indiana/Vevay" "America/Indiana/Vincennes" "America/Indiana/Winamac" "America/Inuvik" "America/Iqaluit" "America/Jamaica" "America/Juneau" "America/Kentucky/Louisville" "America/Kentucky/Monticello" "America/La_Paz" "America/Lima" "America/Los_Angeles" "America/Maceio" "America/Managua" "America/Manaus" "America/Martinique" "America/Matamoros" "America/Mazatlan" "America/Menominee" "America/Merida" "America/Metlakatla" "America/Mexico_City" "America/Miquelon" "America/Moncton" "America/Monterrey" "America/Montevideo" "America/New_York" "America/Nome" "America/Noronha" "America/North_Dakota/Beulah" "America/North_Dakota/Center" "America/North_Dakota/New_Salem" "America/Nuuk" "America/Ojinaga" "America/Panama" "America/Paramaribo" "America/Phoenix" "America/Port-au-Prince" "America/Porto_Velho" "America/Puerto_Rico" "America/Punta_Arenas" "America/Rankin_Inlet" "America/Recife" "America/Regina" "America/Resolute" "America/Rio_Branco" "America/Santarem" "America/Santiago" "America/Santo_Domingo" "America/Sao_Paulo" "America/Scoresbysund" "America/Sitka" "America/St_Johns" "America/Swift_Current" "America/Tegucigalpa" "America/Thule" "America/Tijuana" "America/Toronto" "America/Vancouver" "America/Whitehorse" "America/Winnipeg" "America/Yakutat" "Antarctica/Casey" "Antarctica/Davis" "Antarctica/Macquarie" "Antarctica/Mawson" "Antarctica/Palmer" "Antarctica/Rothera" "Antarctica/Troll" "Antarctica/Vostok" "Asia/Almaty" "Asia/Amman" "Asia/Anadyr" "Asia/Aqtau" "Asia/Aqtobe" "Asia/Ashgabat" "Asia/Atyrau" "Asia/Baghdad" "Asia/Baku" "Asia/Bangkok" "Asia/Barnaul" "Asia/Beirut" "Asia/Bishkek" "Asia/Chita" "Asia/Colombo" "Asia/Damascus" "Asia/Dhaka" "Asia/Dili" "Asia/Dubai" "Asia/Dushanbe" "Asia/Famagusta" "Asia/Gaza" "Asia/Hebron" "Asia/Ho_Chi_Minh" "Asia/Hong_Kong" "Asia/Hovd" "Asia/Irkutsk" "Asia/Jakarta" "Asia/Jayapura" "Asia/Jerusalem" "Asia/Kabul" "Asia/Kamchatka" "Asia/Karachi" "Asia/Kathmandu" "Asia/Khandyga" "Asia/Kolkata" "Asia/Krasnoyarsk" "Asia/Kuching" "Asia/Macau" "Asia/Magadan" "Asia/Makassar" "Asia/Manila" "Asia/Nicosia" "Asia/Novokuznetsk" "Asia/Novosibirsk" "Asia/Omsk" "Asia/Oral" "Asia/Pontianak" "Asia/Pyongyang" "Asia/Qatar" "Asia/Qostanay" "Asia/Qyzylorda" "Asia/Riyadh" "Asia/Sakhalin" "Asia/Samarkand" "Asia/Seoul" "Asia/Shanghai" "Asia/Singapore" "Asia/Srednekolymsk" "Asia/Taipei" "Asia/Tashkent" "Asia/Tbilisi" "Asia/Tehran" "Asia/Thimphu" "Asia/Tokyo" "Asia/Tomsk" "Asia/Ulaanbaatar" "Asia/Urumqi" "Asia/Ust-Nera" "Asia/Vladivostok" "Asia/Yakutsk" "Asia/Yangon" "Asia/Yekaterinburg" "Asia/Yerevan" "Atlantic/Azores" "Atlantic/Bermuda" "Atlantic/Canary" "Atlantic/Cape_Verde" "Atlantic/Faroe" "Atlantic/Madeira" "Atlantic/South_Georgia" "Atlantic/Stanley" "Australia/Adelaide" "Australia/Brisbane" "Australia/Broken_Hill" "Australia/Darwin" "Australia/Eucla" "Australia/Hobart" "Australia/Lindeman" "Australia/Lord_Howe" "Australia/Melbourne" "Australia/Perth" "Australia/Sydney" "Etc/GMT" "Etc/GMT+1" "Etc/GMT+10" "Etc/GMT+11" "Etc/GMT+12" "Etc/GMT+2" "Etc/GMT+3" "Etc/GMT+4" "Etc/GMT+5" "Etc/GMT+6" "Etc/GMT+7" "Etc/GMT+8" "Etc/GMT+9" "Etc/GMT-1" "Etc/GMT-10" "Etc/GMT-11" "Etc/GMT-12" "Etc/GMT-13" "Etc/GMT-14" "Etc/GMT-2" "Etc/GMT-3" "Etc/GMT-4" "Etc/GMT-5" "Etc/GMT-6" "Etc/GMT-7" "Etc/GMT-8" "Etc/GMT-9" "Etc/UTC" "Europe/Andorra" "Europe/Astrakhan" "Europe/Athens" "Europe/Belgrade" "Europe/Berlin" "Europe/Brussels" "Europe/Bucharest" "Europe/Budapest" "Europe/Chisinau" "Europe/Dublin" "Europe/Gibraltar" "Europe/Helsinki" "Europe/Istanbul" "Europe/Kaliningrad" "Europe/Kirov" "Europe/Kyiv" "Europe/Lisbon" "Europe/London" "Europe/Madrid" "Europe/Malta" "Europe/Minsk" "Europe/Moscow" "Europe/Paris" "Europe/Prague" "Europe/Riga" "Europe/Rome" "Europe/Samara" "Europe/Saratov" "Europe/Simferopol" "Europe/Sofia" "Europe/Tallinn" "Europe/Tirane" "Europe/Ulyanovsk" "Europe/Vienna" "Europe/Vilnius" "Europe/Volgograd" "Europe/Warsaw" "Europe/Zurich" "Factory" "Indian/Chagos" "Indian/Maldives" "Indian/Mauritius" "Pacific/Apia" "Pacific/Auckland" "Pacific/Bougainville" "Pacific/Chatham" "Pacific/Easter" "Pacific/Efate" "Pacific/Fakaofo" "Pacific/Fiji" "Pacific/Galapagos" "Pacific/Gambier" "Pacific/Guadalcanal" "Pacific/Guam" "Pacific/Honolulu" "Pacific/Kanton" "Pacific/Kiritimati" "Pacific/Kosrae" "Pacific/Kwajalein" "Pacific/Marquesas" "Pacific/Nauru" "Pacific/Niue" "Pacific/Norfolk" "Pacific/Noumea" "Pacific/Pago_Pago" "Pacific/Palau" "Pacific/Pitcairn" "Pacific/Port_Moresby" "Pacific/Rarotonga" "Pacific/Tahiti" "Pacific/Tarawa" "Pacific/Tongatapu"
network_event[logo]
string <binary>
network_event[cover_picture]
string <binary>
network_event[registration_type]
string
Enum: "no_participation" "rsvp" "tickets"

Event registration type

network_event[payment_flow]
string
Enum: "only_pay_now" "pay_now_or_later" "only_pay_later"

Payment flow for this Network Event

network_event[location][country]
string
network_event[location][country_code]
string
Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW" "XK"
network_event[location][city]
string
network_event[location][address]
string
network_event[parent_id]
integer <int32>

Group ID. By default, the network is the parent.

network_event[venue]
string

Name of the venue of this Network Event

network_event[webinar_url]
string

This will display a virtual link for registered users at the start time of your event. Please enter http(s):// before the link.

network_event[contact_email]
string

Network Event contact email

network_event[contact_phone_number]
string

Network Event contact phone number

network_event[published_at]
string <date-time>

Network Event publish date - iso8601

network_event[feedable_at]
string <date-time>

Network Event feed date - iso8601 / is used to sort items in a reverse chronological order in the live feed

network_event[cancelled]
string

Network event is cancelled ?

network_event[cancelled_at]
string <date-time>

Date and time the network event was cancelled at - iso8601

network_event[public]
boolean

Network Event is displayed to visitors on public pages ?

network_event[total_tickets]
integer <int32>

Total number of tickets that can be sold. (0 or nil: unlimited), must be nil or greater than 0

network_event[tickets_due_date]
string <date-time>

Network Event tickets due date time - iso8601 / Date after which tickets won't be purchasable

network_event[max_tickets_per_user]
integer <int32>

Maximum number a user can buy of tickets // does not apply to external people from the platform (0 or nil: unlimited), must be nil or greater than 0

network_event[organizer]
string

Network Event organizer name

network_event[hide_from_general_list]
boolean

Hide Group Event from global event list and global live feed

network_event[visible_on_index_page]
boolean

Network Event is visible in global events list

network_event[visible_on_livefeed]
boolean

Network Event is visible in the live feed

network_event[send_confirmation_email]
boolean

Attendees receive a confirmation email after registering?

network_event[show_participants]
boolean

Attendees are displayed on the connected pages?

network_event[public_show_participants]
boolean

Attendees are displayed on the public pages?

network_event[attendees_can_pay_later]
boolean

Attendees can pay later?

network_event[public_attendees_can_pay_later]
boolean

External attendees can pay later?

network_event[users_can_cancel_participation]
boolean

Internal attendees can cancel their participation?

network_event[display_price_tag]
boolean

Display price tag on Event Card and Event Details page?

network_event[cancellation_deadline_for_users]
integer <int32>

Users can cancel their participation up to this number of days before the beginning of the Network Event

network_event[send_cancellation_email]
boolean

Attendees receive a confirmation email after cancellation?

network_event[display_refund_policy]
boolean

Display a refund policy when registering to the Network Event?

network_event[refund_policy_content]
string

Refund policy of the Network Event

network_event[receipts_enabled]
boolean

Send a Receipt to attendees after they bought their tickets for the Network Event

network_event[seo_title]
string

Customizable SEO title for search engine

network_event[seo_description]
string

Customizable SEO description for search engine

network_event[canonical_url]
string

Canonical URL for this Network Event for search engine

network_event[network_category_ids][]
Array of integers <int32> [ items <int32 > ]

Network Categories linked to this Network Event

network_event[topic_ids][]
Array of integers <int32> [ items <int32 > ]

Topics linked to this Network Event

network_event[communication_ids][]
Array of integers <int32> [ items <int32 > ]

Communications linked to this Network Event

network_event[display_related_topics]
boolean

Display this list of groups on the bottom of the event details page

network_event[show_webinar_url]
boolean

Display the webinar URL on the event details page

network_event[pinned_on_index_page]
boolean

Highlight in global Events list

network_event[pinned_to_live_feed]
boolean

Pin to global Live feed

network_event[external_api_integration_id]
integer <int32>

External API integration ID (Zoom account)

network_event[zoom_meeting_id]
string

Zoom meeting ID

network_event[zoom_meeting_password]
string

Zoom meeting password

network_event[zoom_attendance_tracking_enabled]
boolean

Zoom attendance tracking enabled

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "title": "string",
  • "venue": "string",
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "registration_type": "string",
  • "location": {
    },
  • "webinar_url": "string",
  • "logo": "string",
  • "contact_email": "string",
  • "contact_phone_number": "string",
  • "published_at": "2019-08-24T14:15:22Z",
  • "feedable_at": "2019-08-24T14:15:22Z",
  • "cancelled": "string",
  • "cancelled_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "public": true,
  • "total_tickets": 0,
  • "tickets_due_date": "2019-08-24T14:15:22Z",
  • "max_tickets_per_user": 0,
  • "cover_picture": "string",
  • "organizer": "string",
  • "timezone": "Africa/Abidjan",
  • "hide_from_general_list": true,
  • "visible_on_index_page": true,
  • "visible_on_livefeed": true,
  • "send_confirmation_email": true,
  • "show_participants": true,
  • "public_show_participants": true,
  • "attendees_can_pay_later": true,
  • "public_attendees_can_pay_later": true,
  • "users_can_cancel_participation": true,
  • "display_price_tag": true,
  • "cancellation_deadline_for_users": 0,
  • "send_cancellation_email": true,
  • "display_refund_policy": true,
  • "refund_policy_content": "string",
  • "receipts_enabled": true,
  • "seo_title": "string",
  • "seo_description": "string",
  • "canonical_url": "string",
  • "ticket_ids": 0,
  • "attendee_ids": 0,
  • "booking_ids": 0,
  • "network_category_ids": 0,
  • "topic_ids": 0,
  • "communication_ids": 0,
  • "customizable_attribute_ids": 0,
  • "parent": {
    },
  • "payment_account": {
    },
  • "payment_flow": "only_pay_now",
  • "display_related_topics": true,
  • "show_webinar_url": true,
  • "pinned_on_index_page": true,
  • "pinned_to_live_feed": true,
  • "is_internal_zoom_meeting": true,
  • "external_api_integration_id": 0,
  • "zoom_meeting_id": "string",
  • "zoom_meeting_password": "string",
  • "zoom_attendance_tracking_enabled": true
}

Network Event Details

Get a Network Event

The customizable attributes can be retrieved on the /api/admin/v1/settings/customizable_attributes endpoint.

path Parameters
id
required
integer <int32>
query Parameters
locale
string
Enum: "en" "en-GB" "fr" "he" "de" "es" "it" "da" "nl" "pt" "ru" "deepbloo" "zh-Hans" "zh-Hant" "af" "pl" "fi" "nl-BE" "nb" "ja" "lt" "hu" "vi" "sv" "ko" "pt-BR" "el" "cy" "hi" "id"

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "title": "string",
  • "venue": "string",
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "registration_type": "string",
  • "location": {
    },
  • "webinar_url": "string",
  • "logo": "string",
  • "contact_email": "string",
  • "contact_phone_number": "string",
  • "published_at": "2019-08-24T14:15:22Z",
  • "feedable_at": "2019-08-24T14:15:22Z",
  • "cancelled": "string",
  • "cancelled_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "public": true,
  • "total_tickets": 0,
  • "tickets_due_date": "2019-08-24T14:15:22Z",
  • "max_tickets_per_user": 0,
  • "cover_picture": "string",
  • "organizer": "string",
  • "timezone": "Africa/Abidjan",
  • "hide_from_general_list": true,
  • "visible_on_index_page": true,
  • "visible_on_livefeed": true,
  • "send_confirmation_email": true,
  • "show_participants": true,
  • "public_show_participants": true,
  • "attendees_can_pay_later": true,
  • "public_attendees_can_pay_later": true,
  • "users_can_cancel_participation": true,
  • "display_price_tag": true,
  • "cancellation_deadline_for_users": 0,
  • "send_cancellation_email": true,
  • "display_refund_policy": true,
  • "refund_policy_content": "string",
  • "receipts_enabled": true,
  • "seo_title": "string",
  • "seo_description": "string",
  • "canonical_url": "string",
  • "ticket_ids": 0,
  • "attendee_ids": 0,
  • "booking_ids": 0,
  • "network_category_ids": 0,
  • "topic_ids": 0,
  • "communication_ids": 0,
  • "customizable_attribute_ids": 0,
  • "parent": {
    },
  • "payment_account": {
    },
  • "payment_flow": "only_pay_now",
  • "display_related_topics": true,
  • "show_webinar_url": true,
  • "pinned_on_index_page": true,
  • "pinned_to_live_feed": true,
  • "is_internal_zoom_meeting": true,
  • "external_api_integration_id": 0,
  • "zoom_meeting_id": "string",
  • "zoom_meeting_password": "string",
  • "zoom_attendance_tracking_enabled": true
}

Network Event Deletion

Delete a Network Event

Event, its tickets, bookings and attendees will be deleted.

path Parameters
id
required
integer <int32>

Responses

Network Event Update

Network Event Update

Logo and cover_picture must be sent as files (URL to files won't work)

The Location can be set using a Hash format. We'll deduce the location from the information input.

The network_event parameter must be sent using a Hash format, even if you only want to update one attribute.

path Parameters
id
required
integer <int32>
Request Body schema: application/x-www-form-urlencoded
locale
string
Enum: "en" "en-GB" "fr" "he" "de" "es" "it" "da" "nl" "pt" "ru" "deepbloo" "zh-Hans" "zh-Hant" "af" "pl" "fi" "nl-BE" "nb" "ja" "lt" "hu" "vi" "sv" "ko" "pt-BR" "el" "cy" "hi" "id"

select a specific locale to edit, if no locale is selected the default network locale will be used.

network_event[logo]
string <binary>
network_event[cover_picture]
string <binary>
network_event[location][country]
string
network_event[location][country_code]
string
Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW" "XK"
network_event[location][city]
string
network_event[location][address]
string
network_event[registration_type]
string
Enum: "no_participation" "rsvp" "tickets"
network_event[payment_flow]
string
Enum: "only_pay_now" "pay_now_or_later" "only_pay_later"

Payment flow for this Network Event

network_event[title]
string

Title of this Network Event

network_event[venue]
string

Name of the venue of this Network Event

network_event[start_date]
string <date-time>

Network Event start date time - iso8601

network_event[end_date]
string <date-time>

Network Event end date time - iso8601

network_event[description]
string

Network Event Description

network_event[webinar_url]
string

This will display a virtual link for registered users at the start time of your event. Please enter http(s):// before the link.

network_event[contact_email]
string

Network Event contact email

network_event[contact_phone_number]
string

Network Event contact phone number

network_event[published_at]
string <date-time>

Network Event publish date - iso8601

network_event[feedable_at]
string <date-time>

Network Event feed date - iso8601 / is used to sort items in a reverse chronological order in the live feed

network_event[cancelled]
string

Network event is cancelled ?

network_event[cancelled_at]
string <date-time>

Date and time the network event was cancelled at - iso8601

network_event[public]
boolean

Network Event is displayed to visitors on public pages ?

network_event[total_tickets]
integer <int32>

Total number of tickets that can be sold. (0 or nil: unlimited), must be nil or greater than 0

network_event[tickets_due_date]
string <date-time>

Network Event tickets due date time - iso8601 / Date after which tickets won't be purchasable

network_event[max_tickets_per_user]
integer <int32>

Maximum number a user can buy of tickets // does not apply to external people from the platform (0 or nil: unlimited), must be nil or greater than 0

network_event[organizer]
string

Network Event organizer name

network_event[timezone]
string

Network Event in which the timezone applies

network_event[hide_from_general_list]
boolean

Hide Group Event from global event list and global live feed

network_event[visible_on_index_page]
boolean

Network Event is visible in global events list

network_event[visible_on_livefeed]
boolean

Network Event is visible in the live feed

network_event[send_confirmation_email]
boolean

Attendees receive a confirmation email after registering?

network_event[show_participants]
boolean

Attendees are displayed on the connected pages?

network_event[public_show_participants]
boolean

Attendees are displayed on the public pages?

network_event[attendees_can_pay_later]
boolean

Attendees can pay later?

network_event[public_attendees_can_pay_later]
boolean

External attendees can pay later?

network_event[users_can_cancel_participation]
boolean

Internal attendees can cancel their participation?

network_event[display_price_tag]
boolean

Display price tag on Event Card and Event Details page?

network_event[cancellation_deadline_for_users]
integer <int32>

Users can cancel their participation up to this number of days before the beginning of the Network Event

network_event[send_cancellation_email]
boolean

Attendees receive a confirmation email after cancellation?

network_event[display_refund_policy]
boolean

Display a refund policy when registering to the Network Event?

network_event[refund_policy_content]
string

Refund policy of the Network Event

network_event[receipts_enabled]
boolean

Send a Receipt to attendees after they bought their tickets for the Network Event

network_event[seo_title]
string

Customizable SEO title for search engine

network_event[seo_description]
string

Customizable SEO description for search engine

network_event[canonical_url]
string

Canonical URL for this Network Event for search engine

network_event[network_category_ids][]
Array of integers <int32> [ items <int32 > ]

Network Categories linked to this Network Event

network_event[topic_ids][]
Array of integers <int32> [ items <int32 > ]

Topics linked to this Network Event

network_event[communication_ids][]
Array of integers <int32> [ items <int32 > ]

Communications linked to this Network Event

network_event[display_related_topics]
boolean

Display this list of groups on the bottom of the event details page

network_event[show_webinar_url]
boolean

Display the webinar URL on the event details page

network_event[pinned_on_index_page]
boolean

Highlight in global Events list

network_event[pinned_to_live_feed]
boolean

Pin to global Live feed

network_event[external_api_integration_id]
integer <int32>

External API integration ID (Zoom account)

network_event[zoom_meeting_id]
string

Zoom meeting ID

network_event[zoom_meeting_password]
string

Zoom meeting password

network_event[zoom_attendance_tracking_enabled]
boolean

Zoom attendance tracking enabled

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "title": "string",
  • "venue": "string",
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "registration_type": "string",
  • "location": {
    },
  • "webinar_url": "string",
  • "logo": "string",
  • "contact_email": "string",
  • "contact_phone_number": "string",
  • "published_at": "2019-08-24T14:15:22Z",
  • "feedable_at": "2019-08-24T14:15:22Z",
  • "cancelled": "string",
  • "cancelled_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "public": true,
  • "total_tickets": 0,
  • "tickets_due_date": "2019-08-24T14:15:22Z",
  • "max_tickets_per_user": 0,
  • "cover_picture": "string",
  • "organizer": "string",
  • "timezone": "Africa/Abidjan",
  • "hide_from_general_list": true,
  • "visible_on_index_page": true,
  • "visible_on_livefeed": true,
  • "send_confirmation_email": true,
  • "show_participants": true,
  • "public_show_participants": true,
  • "attendees_can_pay_later": true,
  • "public_attendees_can_pay_later": true,
  • "users_can_cancel_participation": true,
  • "display_price_tag": true,
  • "cancellation_deadline_for_users": 0,
  • "send_cancellation_email": true,
  • "display_refund_policy": true,
  • "refund_policy_content": "string",
  • "receipts_enabled": true,
  • "seo_title": "string",
  • "seo_description": "string",
  • "canonical_url": "string",
  • "ticket_ids": 0,
  • "attendee_ids": 0,
  • "booking_ids": 0,
  • "network_category_ids": 0,
  • "topic_ids": 0,
  • "communication_ids": 0,
  • "customizable_attribute_ids": 0,
  • "parent": {
    },
  • "payment_account": {
    },
  • "payment_flow": "only_pay_now",
  • "display_related_topics": true,
  • "show_webinar_url": true,
  • "pinned_on_index_page": true,
  • "pinned_to_live_feed": true,
  • "is_internal_zoom_meeting": true,
  • "external_api_integration_id": 0,
  • "zoom_meeting_id": "string",
  • "zoom_meeting_password": "string",
  • "zoom_attendance_tracking_enabled": true
}

Network Event Cancellation

Cancel a Network Event

Event, its tickets, bookings and attendees will be cancelled.

path Parameters
id
required
integer <int32>

Responses

Network Event Duplicate

Network Event Duplicate

Duplicate a Network Event

path Parameters
id
required
integer <int32>

The ID of the event to duplicate

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "title": "string",
  • "venue": "string",
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "registration_type": "string",
  • "location": {
    },
  • "webinar_url": "string",
  • "logo": "string",
  • "contact_email": "string",
  • "contact_phone_number": "string",
  • "published_at": "2019-08-24T14:15:22Z",
  • "feedable_at": "2019-08-24T14:15:22Z",
  • "cancelled": "string",
  • "cancelled_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "public": true,
  • "total_tickets": 0,
  • "tickets_due_date": "2019-08-24T14:15:22Z",
  • "max_tickets_per_user": 0,
  • "cover_picture": "string",
  • "organizer": "string",
  • "timezone": "Africa/Abidjan",
  • "hide_from_general_list": true,
  • "visible_on_index_page": true,
  • "visible_on_livefeed": true,
  • "send_confirmation_email": true,
  • "show_participants": true,
  • "public_show_participants": true,
  • "attendees_can_pay_later": true,
  • "public_attendees_can_pay_later": true,
  • "users_can_cancel_participation": true,
  • "display_price_tag": true,
  • "cancellation_deadline_for_users": 0,
  • "send_cancellation_email": true,
  • "display_refund_policy": true,
  • "refund_policy_content": "string",
  • "receipts_enabled": true,
  • "seo_title": "string",
  • "seo_description": "string",
  • "canonical_url": "string",
  • "ticket_ids": 0,
  • "attendee_ids": 0,
  • "booking_ids": 0,
  • "network_category_ids": 0,
  • "topic_ids": 0,
  • "communication_ids": 0,
  • "customizable_attribute_ids": 0,
  • "parent": {
    },
  • "payment_account": {
    },
  • "payment_flow": "only_pay_now",
  • "display_related_topics": true,
  • "show_webinar_url": true,
  • "pinned_on_index_page": true,
  • "pinned_to_live_feed": true,
  • "is_internal_zoom_meeting": true,
  • "external_api_integration_id": 0,
  • "zoom_meeting_id": "string",
  • "zoom_meeting_password": "string",
  • "zoom_attendance_tracking_enabled": true
}

Customizable Attribute Creation

Customizable Attribute creation for Event

Required params are :

  • a Type,
  • a Display name
  • a customizable_id (The Event ID)
  • if the Type is a Select, a 'options' array of possible choice
  • if the Type is a DoubleSelect, a 'json_options' hash with values like so : { "options": { "option_1": ["sub_choice_1", "sub_choice_2"], "option_2": ["sub_choice_3", "sub_choice_4"]}, child_label: "Label for sub options"}
Request Body schema: application/x-www-form-urlencoded
required
customizable_attribute[type]
required
string
Enum: "CustomizableAttribute::Boolean" "CustomizableAttribute::Date" "CustomizableAttribute::DoubleSelect" "CustomizableAttribute::Number" "CustomizableAttribute::Select" "CustomizableAttribute::Text"
customizable_attribute[display_name]
required
string
customizable_attribute[customizable_id]
required
integer <int32>
customizable_attribute[options][]
required
Array of strings
customizable_attribute[multi]
boolean
customizable_attribute[text_size]
integer <int32>
customizable_attribute[tooltip]
string

Customizable Attribute tooltip

customizable_attribute[placeholder]
string

Customizable Attribute placeholder

customizable_attribute[visibility]
string

Customizable Attribute visibility

customizable_attribute[required]
boolean

Customizable Attribute required ?

customizable_attribute[selected_value]
string

Customizable Attribute selected value

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "customizable_id": 0,
  • "type": "CustomizableAttribute::Boolean",
  • "customizable_type": "bizopp",
  • "name": "string",
  • "display_name": "string",
  • "tooltip": "string",
  • "placeholder": "string",
  • "multi": true,
  • "text_size": 0,
  • "visibility": "admin_only",
  • "user_editable": true,
  • "required": true,
  • "options": [
    ],
  • "json_options": { },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "selected_value": "string"
}

Customizable Attribute Update

Update a customizable attribute

The customizable attribute can be retrieved on the /api/admin/v1/settings/customizable_attributes endpoint. You can NOT update the possible values of Select and DoubleSelect customizable attributes

path Parameters
id
required
string
Request Body schema: application/x-www-form-urlencoded
customizable_attribute[display_name]
string

Customizable Attribute displayed name

customizable_attribute[tooltip]
string

Customizable Attribute tooltip

customizable_attribute[placeholder]
string

Customizable Attribute placeholder

customizable_attribute[multi]
boolean

Customizable Attribute multi activated ?

customizable_attribute[text_size]
integer <int32>

Customizable Attribute text_size

customizable_attribute[visibility]
string

Customizable Attribute visibility

customizable_attribute[required]
boolean

Customizable Attribute required ?

customizable_attribute[selected_value]
string

Customizable Attribute selected value

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "customizable_id": 0,
  • "type": "CustomizableAttribute::Boolean",
  • "customizable_type": "bizopp",
  • "name": "string",
  • "display_name": "string",
  • "tooltip": "string",
  • "placeholder": "string",
  • "multi": true,
  • "text_size": 0,
  • "visibility": "admin_only",
  • "user_editable": true,
  • "required": true,
  • "options": [
    ],
  • "json_options": { },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "selected_value": "string"
}

Customizable Attribute Deletion

Destroy a Customizable Attribute

The customizable attributes of an event can be retrieved on the /api/admin/v1/settings/customizable_attributes endpoint. BEWARE: This will delete the Attendee's answer to this customizable attribute as well as the customizable attributes linked to the tickets.

path Parameters
id
required
string

Responses

ventures

Operations about ventures

getAdminV2VenturesTeamMembers

Get Team members

query Parameters
venture_id
integer <int32>

Responses

getAdminV2VenturesTeamMembersId

Show a Team member

path Parameters
id
required
integer <int32>

Responses

deleteAdminV2VenturesTeamMembersId

Delete a Team member

path Parameters
id
required
integer <int32>

Responses

putAdminV2VenturesTeamMembersId

Update a team member

path Parameters
id
required
integer <int32>
Request Body schema: application/x-www-form-urlencoded
team_member[role]
string

Role of the Team Member

team_member[status]
string

Approvals::Network status of the Team member in the project

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "company_name": "string",
  • "high_level_pitch": "string",
  • "product": "string",
  • "logo": "string",
  • "company_website": "string",
  • "twitter": "string",
  • "facebook": "string",
  • "angel_list": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "user_id": 0,
  • "currently_fundraising": true,
  • "feedable_at": "2019-08-24T14:15:22Z",
  • "fundraising_at": "2019-08-24T14:15:22Z",
  • "fundraising_amount": 0,
  • "help": "string",
  • "business_stage": "seed_startup",
  • "non_profit": true,
  • "video_html": "string",
  • "created_date": "2019-08-24T14:15:22Z",
  • "cover_picture": "string",
  • "company_size": "only_me",
  • "fundraising_currency": "USD",
  • "linkedin": "string",
  • "tagline": "string",
  • "funding_rounds": {
    },
  • "locations": {
    },
  • "team_members": {
    },
  • "industry_ids": 0,
  • "parent": {
    },
  • "customizable_attributes": [
    ]
}

postAdminV2VenturesIdTeamMembers

Add a team member to a Project

path Parameters
id
required
integer <int32>
Request Body schema: application/x-www-form-urlencoded
required
team_member[user_id]
required
integer <int32>
team_member[role]
string

Role of the Team Member

team_member[status]
string

Approvals::Network status of the Team member in the project

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "company_name": "string",
  • "high_level_pitch": "string",
  • "product": "string",
  • "logo": "string",
  • "company_website": "string",
  • "twitter": "string",
  • "facebook": "string",
  • "angel_list": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "user_id": 0,
  • "currently_fundraising": true,
  • "feedable_at": "2019-08-24T14:15:22Z",
  • "fundraising_at": "2019-08-24T14:15:22Z",
  • "fundraising_amount": 0,
  • "help": "string",
  • "business_stage": "seed_startup",
  • "non_profit": true,
  • "video_html": "string",
  • "created_date": "2019-08-24T14:15:22Z",
  • "cover_picture": "string",
  • "company_size": "only_me",
  • "fundraising_currency": "USD",
  • "linkedin": "string",
  • "tagline": "string",
  • "funding_rounds": {
    },
  • "locations": {
    },
  • "team_members": {
    },
  • "industry_ids": 0,
  • "parent": {
    },
  • "customizable_attributes": [
    ]
}

List of Projects

Get a paginated list of Projects

Pagination information are stored in the response header as defined by RFC-5988 http://tools.ietf.org/html/rfc5988 Example:

{
"link": "<https://hivebrite.com/api/admin/v2/ventures?page=1&per_page=30>; rel=\"first\", <https://hivebrite.com/api/admin/v2/ventures?page=3&per_page=30>; rel=\"prev\", <https://hivebrite.com/api/admin/v2/ventures?page=2041&per_page=30>; rel=\"last\", <https://hivebrite.com/api/admin/v2/ventures?page=30&per_page=30>; rel=\"next\"",
"x-per-page": "30",
"x-total": "10201",
"x-page": "4"
}

By default, retrieve all existing projects (from both group and community)

Use the parent option filtering to retrieve only topic/community/all projects. Use the parent_id option filtering along the topic filtering option to get projects from a certain topic.

query Parameters
parent
string
Default: "all"
Enum: "network" "topic" "all"
parent_id
required
integer <int32>
linked_topic_id
integer <int32>

This parameter is deprecated use the parent filtering

user_id
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "company_name": "string",
  • "high_level_pitch": "string",
  • "product": "string",
  • "logo": "string",
  • "company_website": "string",
  • "twitter": "string",
  • "facebook": "string",
  • "angel_list": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "user_id": 0,
  • "currently_fundraising": true,
  • "feedable_at": "2019-08-24T14:15:22Z",
  • "fundraising_at": "2019-08-24T14:15:22Z",
  • "fundraising_amount": 0,
  • "help": "string",
  • "business_stage": "seed_startup",
  • "non_profit": true,
  • "video_html": "string",
  • "created_date": "2019-08-24T14:15:22Z",
  • "cover_picture": "string",
  • "company_size": "only_me",
  • "fundraising_currency": "USD",
  • "linkedin": "string",
  • "tagline": "string",
  • "funding_rounds": {
    },
  • "locations": {
    },
  • "team_members": {
    },
  • "industry_ids": 0,
  • "parent": {
    },
  • "customizable_attributes": [
    ]
}

Create a Network Project

Create a Network Project

Logo and cover_picture must be sent as files (URL to files won't work).

Request Body schema: application/x-www-form-urlencoded
required
venture[company_name]
required
string
venture[business_stage]
required
string
Enum: "seed_startup" "growing" "established" "unknown"
venture[high_level_pitch]
required
string
venture[product]
required
string
venture[user_id]
required
integer <int32>
venture[customizable_attributes][]
Array of objects
venture[company_size]
string
Enum: "only_me" "2_10" "11_50" "51_200" "201_500" "501_1000" "1001_5000" "5001_10000" "10001_more"
venture[industry_ids][]
Array of integers <int32> [ items <int32 > ]
venture[logo]
string <binary>
venture[cover_picture]
string <binary>
venture[company_website]
string

URL to the website of the project

venture[twitter]
string

Link to the twitter acount of the project

venture[facebook]
string

Link to the facebook acount of the project

venture[angel_list]
string

Link to the angel list acount of the project

venture[currently_fundraising]
boolean

Is the project currently raising fund ?

venture[feedable_at]
string <date-time>

project feed date - iso8601 / is used to sort items in a reverse chronological order in the live feed

venture[fundraising_at]
string <date-time>

project is raising funds for the next date - iso8601

venture[fundraising_amount]
integer <int32>

Amount of find the project is raising

venture[help]
string

What help can be brought to the project

venture[non_profit]
boolean

Is the project non-for profit ?

venture[video_html]
string

Link to a video presenting the project

venture[created_date]
string <date-time>

project creation date - iso8601

venture[fundraising_currency]
string

Currency linked to the fundraising

venture[linkedin]
string

Link to the linkedin account of the company

venture[tagline]
string

Tagline of the project

venture[locations][][address]
Array of strings
venture[locations][][city]
Array of strings
venture[locations][][country_code]
Array of strings
Items Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW" "XK"
venture[funding_rounds][][amount]
Array of integers <int32> [ items <int32 > ]

Amound raised in the Funding round

venture[funding_rounds][][currency]
required
Array of strings
Items Enum: "usd" "eur" "gbp" "aud" "cad" "jpy" "huf" "byr" "syp" "svc" "stn" "std" "ssp" "srd" "sos" "sll" "aed" "szl" "thb" "tjs" "tmt" "tnd" "top" "try" "ttd" "twd" "tzs" "uah" "zmw" "nok" "npr" "nzd" "omr" "pab" "pen" "pgk" "php" "pkr" "pln" "pyg" "qar" "ron" "rsd" "rub" "rwf" "sar" "sbd" "scr" "sdg" "sek" "sgd" "shp" "skk" "sle" "bch" "btc" "jep" "ggp" "imp" "xfu" "gbx" "cnh" "usdc" "eek" "ghs" "hrk" "ltl" "lvl" "mro" "mtl" "tmm" "jpy" "zwd" "zwl" "zwn" "zwr" "vef" "ugx" "uyu" "uzs" "ves" "vnd" "vuv" "wst" "xaf" "xag" "xau" "xba" "xbb" "xbc" "xbd" "xcd" "xdr" "xof" "xpd" "xpf" "xpt" "xts" "yer" "zar" "zmk" "cdf" "chf" "clf" "clp" "cny" "cop" "crc" "cuc" "cup" "cve" "czk" "djf" "dkk" "dop" "dzd" "egp" "ern" "etb" "fjd" "fkp" "gel" "ghs" "gip" "afn" "all" "amd" "ang" "aoa" "ars" "awg" "azn" "bam" "bbd" "bdt" "bgn" "bhd" "bif" "bmd" "bnd" "bob" "brl" "bsd" "btn" "bwp" "byn" "bzd" "gmd" "lak" "lbp" "lkr" "lrd" "lsl" "lyd" "mad" "mdl" "mga" "mkd" "mmk" "mnt" "mop" "mru" "mur" "mvr" "mwk" "mxn" "myr" "mzn" "nad" "ngn" "nio" "gnf" "gtq" "gyd" "hkd" "hnl" "htg" "idr" "ils" "inr" "iqd" "irr" "isk" "jmd" "jod" "kes" "kgs" "khr" "kmf" "kpw" "krw" "kwd" "kyd" "kzt"
venture[funding_rounds][][funding_type]
Array of strings

Type of the Funding Round

venture[funding_rounds][][closed_date]
Array of strings <date-time> [ items <date-time > ]

Funding Round closing date - iso8601

venture[funding_rounds][][press_url]
Array of strings

URL of the press release regarding this Funding Round

venture[funding_rounds][][investors][][name]
required
Array of strings
venture[funding_rounds][][investors][][url]
Array of strings

URL to the website of the Investor

venture[team_members][][user_id]
required
Array of integers <int32> [ items <int32 > ]
venture[team_members][][role]
Array of strings

Role of the Team Member

venture[team_members][][status]
Array of strings

Approvals::Network status of the Team member in the project

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "company_name": "string",
  • "high_level_pitch": "string",
  • "product": "string",
  • "logo": "string",
  • "company_website": "string",
  • "twitter": "string",
  • "facebook": "string",
  • "angel_list": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "user_id": 0,
  • "currently_fundraising": true,
  • "feedable_at": "2019-08-24T14:15:22Z",
  • "fundraising_at": "2019-08-24T14:15:22Z",
  • "fundraising_amount": 0,
  • "help": "string",
  • "business_stage": "seed_startup",
  • "non_profit": true,
  • "video_html": "string",
  • "created_date": "2019-08-24T14:15:22Z",
  • "cover_picture": "string",
  • "company_size": "only_me",
  • "fundraising_currency": "USD",
  • "linkedin": "string",
  • "tagline": "string",
  • "funding_rounds": {
    },
  • "locations": {
    },
  • "team_members": {
    },
  • "industry_ids": 0,
  • "parent": {
    },
  • "customizable_attributes": [
    ]
}

getAdminV2VenturesId

Detail of a Project

path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "company_name": "string",
  • "high_level_pitch": "string",
  • "product": "string",
  • "logo": "string",
  • "company_website": "string",
  • "twitter": "string",
  • "facebook": "string",
  • "angel_list": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "user_id": 0,
  • "currently_fundraising": true,
  • "feedable_at": "2019-08-24T14:15:22Z",
  • "fundraising_at": "2019-08-24T14:15:22Z",
  • "fundraising_amount": 0,
  • "help": "string",
  • "business_stage": "seed_startup",
  • "non_profit": true,
  • "video_html": "string",
  • "created_date": "2019-08-24T14:15:22Z",
  • "cover_picture": "string",
  • "company_size": "only_me",
  • "fundraising_currency": "USD",
  • "linkedin": "string",
  • "tagline": "string",
  • "funding_rounds": {
    },
  • "locations": {
    },
  • "team_members": {
    },
  • "industry_ids": 0,
  • "parent": {
    },
  • "customizable_attributes": [
    ]
}

deleteAdminV2VenturesId

Delete a Project

path Parameters
id
required
integer <int32>

Responses

Update a Project

Update a Project

Logo and cover_picture must be sent as files (URL to files won't work).

By default, the parent is the network.

If you want to change the parent, use the parent option. Use the parent_id option filtering along the topic filtering option to update the project from a certain topic.

path Parameters
id
required
integer <int32>
Request Body schema: application/x-www-form-urlencoded
parent
string
Default: "all"
Enum: "network" "topic" "all"
parent_id
integer <int32>
venture[business_stage]
string
Enum: "seed_startup" "growing" "established" "unknown"
venture[industry_ids][]
Array of integers <int32> [ items <int32 > ]

Get ids from industries endpoint /settings/industries

venture[customizable_attributes][]
Array of objects
venture[user_id]
integer <int32>

User ID corresponding to the owner of the project

venture[company_size]
string
Enum: "only_me" "2_10" "11_50" "51_200" "201_500" "501_1000" "1001_5000" "5001_10000" "10001_more"
venture[logo]
string <binary>
venture[cover_picture]
string <binary>
venture[company_name]
string

Name of the project

venture[high_level_pitch]
string

Pitch of the project

venture[product]
string

Product sold by the project

venture[company_website]
string

URL to the website of the project

venture[twitter]
string

Link to the twitter acount of the project

venture[facebook]
string

Link to the facebook acount of the project

venture[angel_list]
string

Link to the angel list acount of the project

venture[currently_fundraising]
boolean

Is the project currently raising fund ?

venture[feedable_at]
string <date-time>

project feed date - iso8601 / is used to sort items in a reverse chronological order in the live feed

venture[fundraising_at]
string <date-time>

project is raising funds for the next date - iso8601

venture[fundraising_amount]
integer <int32>

Amount of find the project is raising

venture[help]
string

What help can be brought to the project

venture[non_profit]
boolean

Is the project non-for profit ?

venture[video_html]
string

Link to a video presenting the project

venture[created_date]
string <date-time>

project creation date - iso8601

venture[fundraising_currency]
string

Currency linked to the fundraising

venture[linkedin]
string

Link to the linkedin account of the company

venture[tagline]
string

Tagline of the project

venture[locations][][id]
required
Array of integers <int32> [ items <int32 > ]
venture[locations][][address]
Array of strings
venture[locations][][city]
Array of strings
venture[locations][][country_code]
Array of strings
Items Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW" "XK"
venture[funding_rounds][][id]
Array of integers <int32> [ items <int32 > ]

Unique ID of the Project (include to update an existing funding round)

venture[funding_rounds][][amount]
Array of integers <int32> [ items <int32 > ]

Amound raised in the Funding round

venture[funding_rounds][][currency]
required
Array of strings
Items Enum: "usd" "eur" "gbp" "aud" "cad" "jpy" "huf" "byr" "syp" "svc" "stn" "std" "ssp" "srd" "sos" "sll" "aed" "szl" "thb" "tjs" "tmt" "tnd" "top" "try" "ttd" "twd" "tzs" "uah" "zmw" "nok" "npr" "nzd" "omr" "pab" "pen" "pgk" "php" "pkr" "pln" "pyg" "qar" "ron" "rsd" "rub" "rwf" "sar" "sbd" "scr" "sdg" "sek" "sgd" "shp" "skk" "sle" "bch" "btc" "jep" "ggp" "imp" "xfu" "gbx" "cnh" "usdc" "eek" "ghs" "hrk" "ltl" "lvl" "mro" "mtl" "tmm" "jpy" "zwd" "zwl" "zwn" "zwr" "vef" "ugx" "uyu" "uzs" "ves" "vnd" "vuv" "wst" "xaf" "xag" "xau" "xba" "xbb" "xbc" "xbd" "xcd" "xdr" "xof" "xpd" "xpf" "xpt" "xts" "yer" "zar" "zmk" "cdf" "chf" "clf" "clp" "cny" "cop" "crc" "cuc" "cup" "cve" "czk" "djf" "dkk" "dop" "dzd" "egp" "ern" "etb" "fjd" "fkp" "gel" "ghs" "gip" "afn" "all" "amd" "ang" "aoa" "ars" "awg" "azn" "bam" "bbd" "bdt" "bgn" "bhd" "bif" "bmd" "bnd" "bob" "brl" "bsd" "btn" "bwp" "byn" "bzd" "gmd" "lak" "lbp" "lkr" "lrd" "lsl" "lyd" "mad" "mdl" "mga" "mkd" "mmk" "mnt" "mop" "mru" "mur" "mvr" "mwk" "mxn" "myr" "mzn" "nad" "ngn" "nio" "gnf" "gtq" "gyd" "hkd" "hnl" "htg" "idr" "ils" "inr" "iqd" "irr" "isk" "jmd" "jod" "kes" "kgs" "khr" "kmf" "kpw" "krw" "kwd" "kyd" "kzt"
venture[funding_rounds][][funding_type]
Array of strings

Type of the Funding Round

venture[funding_rounds][][closed_date]
Array of strings <date-time> [ items <date-time > ]

Funding Round closing date - iso8601

venture[funding_rounds][][press_url]
Array of strings

URL of the press release regarding this Funding Round

venture[funding_rounds][][investors][][id]
Array of integers <int32> [ items <int32 > ]

Unique ID of the Investor (include to update an existing investor)

venture[funding_rounds][][investors][][name]
Array of strings

Name of the Investor

venture[funding_rounds][][investors][][url]
Array of strings

URL to the website of the Investor

venture[team_members][][id]
required
Array of integers <int32> [ items <int32 > ]
venture[team_members][][role]
Array of strings

Role of the Team Member

venture[team_members][][status]
Array of strings

Approvals::Network status of the Team member in the project

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "company_name": "string",
  • "high_level_pitch": "string",
  • "product": "string",
  • "logo": "string",
  • "company_website": "string",
  • "twitter": "string",
  • "facebook": "string",
  • "angel_list": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "user_id": 0,
  • "currently_fundraising": true,
  • "feedable_at": "2019-08-24T14:15:22Z",
  • "fundraising_at": "2019-08-24T14:15:22Z",
  • "fundraising_amount": 0,
  • "help": "string",
  • "business_stage": "seed_startup",
  • "non_profit": true,
  • "video_html": "string",
  • "created_date": "2019-08-24T14:15:22Z",
  • "cover_picture": "string",
  • "company_size": "only_me",
  • "fundraising_currency": "USD",
  • "linkedin": "string",
  • "tagline": "string",
  • "funding_rounds": {
    },
  • "locations": {
    },
  • "team_members": {
    },
  • "industry_ids": 0,
  • "parent": {
    },
  • "customizable_attributes": [
    ]
}

memberships

Operations about memberships

Payment Options update

Update a payment option for the given Membership type

path Parameters
membership_type_id
required
integer <int32>

Membership type ID

id
required
integer <int32>

Payment Option ID

Request Body schema: application/x-www-form-urlencoded
payment_option[periodicity]
string
Enum: "none" "week" "two_weeks" "fifteen_days" "month" "two_months" "three_months" "six_months" "year" "two_years" "three_years" "four_years" "five_years"

Duration of membership purchase

payment_option[recurring_mode]
string
Enum: "no_recurring" "recurring_allowed" "recurring_only"

Description of the payment option

payment_option[name]
string

Name of the payment option

payment_option[description]
string

Description of the payment option

payment_option[renewal_period]
integer <int32>

Duration (in days) of renewal period

payment_option[grace_period]
integer <int32>

Duration (in days) of renewal grace period

payment_option[price]
number <float>

Payment option price

payment_option[has_free_trial]
boolean

Does the Payment option offer a free trial?

payment_option[free_trial_period_periodicity]
integer <int32>

Duration (in days) of membership free trial period

payment_option[enable_expire_month]
boolean

Does the Payment option expire in a set month?

payment_option[expire_month]
integer <int32>

Calendar number of expiration Month

payment_option[vat_name]
string

VAT name

payment_option[vat_rate]
number <float>

VAT rate

payment_option[is_active]
boolean

Is the Payment option active?

payment_option[is_default]
boolean

Is the default Payment option?

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "membership_type_id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "periodicity": "none",
  • "recurring_mode": "no_recurring",
  • "renewal_period": 0,
  • "grace_period": 0,
  • "price": 0.1,
  • "currency": "string",
  • "has_free_trial": true,
  • "free_trial_period_periodicity": 0,
  • "enable_expire_month": true,
  • "expire_month": "none",
  • "vat_name": "string",
  • "vat_rate": 0.1,
  • "is_active": true,
  • "is_default": true
}

Payment Options create

Create a new payment option for the given Membership type

path Parameters
membership_type_id
required
integer <int32>

Membership type ID

Request Body schema: application/x-www-form-urlencoded
required
payment_option[name]
required
string
payment_option[periodicity]
required
string
Enum: "none" "week" "two_weeks" "fifteen_days" "month" "two_months" "three_months" "six_months" "year" "two_years" "three_years" "four_years" "five_years"

Duration of membership purchase

payment_option[recurring_mode]
string
Enum: "no_recurring" "recurring_allowed" "recurring_only"

Description of the payment option

payment_option[description]
string

Description of the payment option

payment_option[renewal_period]
integer <int32>

Duration (in days) of renewal period

payment_option[grace_period]
integer <int32>

Duration (in days) of renewal grace period

payment_option[price]
number <float>

Payment option price

payment_option[has_free_trial]
boolean

Does the Payment option offer a free trial?

payment_option[free_trial_period_periodicity]
integer <int32>

Duration (in days) of membership free trial period

payment_option[enable_expire_month]
boolean

Does the Payment option expire in a set month?

payment_option[expire_month]
integer <int32>

Calendar number of expiration Month

payment_option[vat_name]
string

VAT name

payment_option[vat_rate]
number <float>

VAT rate

payment_option[is_active]
boolean

Is the Payment option active?

payment_option[is_default]
boolean

Is the default Payment option?

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "membership_type_id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "periodicity": "none",
  • "recurring_mode": "no_recurring",
  • "renewal_period": 0,
  • "grace_period": 0,
  • "price": 0.1,
  • "currency": "string",
  • "has_free_trial": true,
  • "free_trial_period_periodicity": 0,
  • "enable_expire_month": true,
  • "expire_month": "none",
  • "vat_name": "string",
  • "vat_rate": 0.1,
  • "is_active": true,
  • "is_default": true
}

Payment Options Details

Get a Membership Type's payment options and their details

path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "membership_type_id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "periodicity": "none",
  • "recurring_mode": "no_recurring",
  • "renewal_period": 0,
  • "grace_period": 0,
  • "price": 0.1,
  • "currency": "string",
  • "has_free_trial": true,
  • "free_trial_period_periodicity": 0,
  • "enable_expire_month": true,
  • "expire_month": "none",
  • "vat_name": "string",
  • "vat_rate": 0.1,
  • "is_active": true,
  • "is_default": true
}

List of Memberships Types

Get a paginated list of Memberships Types

Pagination information are stored in the response header as defined by RFC-5988 http://tools.ietf.org/html/rfc5988 Example:

{
"link": "<https://hivebrite.com/api/admin/v2/membhersips/types?page=1&per_page=30>; rel=\"first\", <https://hivebrite.com/api/admin/v2/membhersips/types?page=3&per_page=30>; rel=\"prev\", <https://hivebrite.com/api/admin/v2/membhersips/types?page=2041&per_page=30>; rel=\"last\", <https://hivebrite.com/api/admin/v2/membhersips/types?page=30&per_page=30>; rel=\"next\"",
"x-per-page": "30",
"x-total": "10201",
"x-page": "4"
}

By default, retrieve all existing types (from both group and community)

Use the parent option filtering to retrieve only topic/community/all types.
Use the parent_id option filtering along the topic filtering option to get types from a certain topic.
query Parameters
parent
string
Default: "all"
Enum: "network" "topic" "all"
parent_id
integer <int32>
updated_since
string <date-time>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "external_id": "string",
  • "name": "string",
  • "description": "string",
  • "active": true,
  • "restriction_enabled": true,
  • "discharged": true,
  • "recurring_payment_enabled": true,
  • "until_year_end": true,
  • "enable_expire_month": true,
  • "expire_month": 0,
  • "price": 0.1,
  • "currency": "string",
  • "periodicity": "none",
  • "recurring_mode": "no_recurring",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "payment_account_id": 0,
  • "parent": {
    }
}

Add a new Memberships Type

Required parameters

  • currency
  • periodicity
  • price

Optional parameters

  • name
  • description
  • sso_identifier
  • external_id
  • active
  • restriction_enabled
  • discharged
  • recurring_payment_enabled
  • until_year_end
  • enable_expire_month
  • expire_month
  • recurring_mode
  • payment_account_id
    • Be careful when switching between payment accounts that have a different Currency type than the Membership
Request Body schema: application/x-www-form-urlencoded
required
type[currency]
required
string
type[periodicity]
required
string
Enum: "none" "week" "fifteen_days" "month" "two_months" "three_months" "six_months" "year" "two_years" "three_years" "four_years" "five_years"
type[price]
required
number <float>
Default: 0
type[external_id]
string

External ID of the Memberships Type (ID in your system)

type[name]
string

Memberships Type Name

type[description]
string

Memberships Type Description

type[active]
boolean

Memberships Type active ?

type[restriction_enabled]
boolean

Memberships Type restriction enabled ?

type[discharged]
boolean

Memberships Type discharged ?

type[recurring_payment_enabled]
boolean

Memberships Type recurring payment enabled ? (deprecated)

type[until_year_end]
boolean

Memberships Type valid until year end ?

type[enable_expire_month]
boolean

Memberships Type expire month ?

type[expire_month]
integer <int32>

Month when the Memberships Type expires

type[recurring_mode]
string

Automatic renewal for memberships ?

type[payment_account_id]
integer <int32>

ID of associated payment account

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "external_id": "string",
  • "name": "string",
  • "description": "string",
  • "active": true,
  • "restriction_enabled": true,
  • "discharged": true,
  • "recurring_payment_enabled": true,
  • "until_year_end": true,
  • "enable_expire_month": true,
  • "expire_month": 0,
  • "price": 0.1,
  • "currency": "string",
  • "periodicity": "none",
  • "recurring_mode": "no_recurring",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "payment_account_id": 0,
  • "parent": {
    }
}

Type Details

Get a Membership Type details

path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "external_id": "string",
  • "name": "string",
  • "description": "string",
  • "active": true,
  • "restriction_enabled": true,
  • "discharged": true,
  • "recurring_payment_enabled": true,
  • "until_year_end": true,
  • "enable_expire_month": true,
  • "expire_month": 0,
  • "price": 0.1,
  • "currency": "string",
  • "periodicity": "none",
  • "recurring_mode": "no_recurring",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "payment_account_id": 0,
  • "parent": {
    }
}

Type Deletion

Remove a Membership Type

path Parameters
id
required
integer <int32>

Responses

Update an existing Memberships Type

Optional parameters

  • name
  • description
  • sso_identifier
  • currency
  • periodicity
  • price
  • external_id
  • active
  • restriction_enabled
  • discharged
  • recurring_payment_enabled
  • until_year_end
  • enable_expire_month
  • expire_month
  • recurring_mode
  • payment_account_id
    • Be careful when switching between payment accounts that have a different Currency type than the Membership
path Parameters
id
required
integer <int32>
Request Body schema: application/x-www-form-urlencoded
type[periodicity]
string
Enum: "none" "week" "fifteen_days" "month" "two_months" "three_months" "six_months" "year" "two_years" "three_years" "four_years" "five_years"
type[external_id]
string

External ID of the Memberships Type (ID in your system)

type[name]
string

Memberships Type Name

type[description]
string

Memberships Type Description

type[active]
boolean

Memberships Type active ?

type[restriction_enabled]
boolean

Memberships Type restriction enabled ?

type[discharged]
boolean

Memberships Type discharged ?

type[recurring_payment_enabled]
boolean

Memberships Type recurring payment enabled ? (deprecated)

type[until_year_end]
boolean

Memberships Type valid until year end ?

type[enable_expire_month]
boolean

Memberships Type expire month ?

type[expire_month]
integer <int32>

Month when the Memberships Type expires

type[price]
number <float>

Memberships Type price

type[currency]
string

ISO code of the Currency of the Memberships Type

type[recurring_mode]
string

Automatic renewal for memberships ?

type[payment_account_id]
integer <int32>

ID of associated payment account

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "external_id": "string",
  • "name": "string",
  • "description": "string",
  • "active": true,
  • "restriction_enabled": true,
  • "discharged": true,
  • "recurring_payment_enabled": true,
  • "until_year_end": true,
  • "enable_expire_month": true,
  • "expire_month": 0,
  • "price": 0.1,
  • "currency": "string",
  • "periodicity": "none",
  • "recurring_mode": "no_recurring",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "payment_account_id": 0,
  • "parent": {
    }
}

List of User Memberships Subscriptions

Get a paginated list of User Memberships Subscriptions

Pagination information are stored in the response header as defined by RFC-5988 http://tools.ietf.org/html/rfc5988 Example:

{
  "link": "<https://hivebrite.com/api/admin/v3/memberships/subscriptions?page=1&per_page=30>; rel=\"first\", <https://hivebrite.com/api/admin/v3/memberships/subscriptions?page=3&per_page=30>; rel=\"prev\", <https://hivebrite.com/api/admin/v3/memberships/subscriptions?page=2041&per_page=30>; rel=\"last\", <https://hivebrite.com/api/admin/v3/memberships/subscriptions?page=30&per_page=30>; rel=\"next\"",
  "x-per-page": "30",
  "x-total": "10201",
  "x-page": "4"
}

By default, retrieve all existing memberships subscriptions (from both group and community)

Use the parent option filtering to retrieve only topic/community/all memberships subscriptions. Use the parent_id option filtering along the topic filtering option to get memberships subscriptions from a certain topic. Use the user_id option filtering to get memberships subscriptions from a certain user.

query Parameters
parent
string
Default: "all"
Enum: "network" "topic" "all"
parent_id
integer <int32>
updated_since
string <date-time>
user_id
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "membership_type_id": 0,
  • "user_id": 0,
  • "payment_method_type": "string",
  • "payment_method": "string",
  • "expires_at": "2019-08-24T14:15:22Z",
  • "canceled_at": "2019-08-24T14:15:22Z",
  • "notes": "string",
  • "created_by_admin": true,
  • "is_recurring": true,
  • "number_of_user_renewals": 0,
  • "number_of_admin_renewals": 0,
  • "manual_transactions_ids": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "payment_option_id": 0
}

Add a new Memberships Subscription

Create a Memberships Subscription

Required parameters are :

  • User Id
  • Membership Type Id
  • Payment Method Type (cash, card, check, direct_debit, bank_transfer, external_institution, sepa_debit, ideal, bancontact)

All membership subscriptions added to a user by an admin are not recurring.

Request Body schema: application/x-www-form-urlencoded
required
subscription[user_id]
required
integer <int32>
subscription[membership_type_id]
required
integer <int32>
subscription[payment_method_type]
required
string
Enum: "cash" "card" "check" "direct_debit" "bank_transfer" "external_institution" "sepa_debit" "ideal" "bancontact"
subscription[notes]
string
subscription[send_confirmation_email]
boolean
subscription[expires_at]
string <date-time>
subscription[payment_option_id]
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "membership_type_id": 0,
  • "user_id": 0,
  • "payment_method_type": "string",
  • "payment_method": "string",
  • "expires_at": "2019-08-24T14:15:22Z",
  • "canceled_at": "2019-08-24T14:15:22Z",
  • "notes": "string",
  • "created_by_admin": true,
  • "is_recurring": true,
  • "number_of_user_renewals": 0,
  • "number_of_admin_renewals": 0,
  • "manual_transactions_ids": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "payment_option_id": 0
}

Memberships Subscription Cancellation

Cancel a Memberships Subscription

Required parameters are :

  • User Id,
path Parameters
id
required
integer <int32>
Request Body schema: application/x-www-form-urlencoded
required
subscription[user_id]
required
integer <int32>
subscription[send_email]
boolean

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "membership_type_id": 0,
  • "user_id": 0,
  • "payment_method_type": "string",
  • "payment_method": "string",
  • "expires_at": "2019-08-24T14:15:22Z",
  • "canceled_at": "2019-08-24T14:15:22Z",
  • "notes": "string",
  • "created_by_admin": true,
  • "is_recurring": true,
  • "number_of_user_renewals": 0,
  • "number_of_admin_renewals": 0,
  • "manual_transactions_ids": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "payment_option_id": 0
}

Memberships subscription Details

Get a Memberships Subscription details

path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "membership_type_id": 0,
  • "user_id": 0,
  • "payment_method_type": "string",
  • "payment_method": "string",
  • "expires_at": "2019-08-24T14:15:22Z",
  • "canceled_at": "2019-08-24T14:15:22Z",
  • "notes": "string",
  • "created_by_admin": true,
  • "is_recurring": true,
  • "number_of_user_renewals": 0,
  • "number_of_admin_renewals": 0,
  • "manual_transactions_ids": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "payment_option_id": 0
}

Memberships Subscription Renewal

Renew a Memberships Subscription

Required parameters are :

  • User Id,
path Parameters
id
required
integer <int32>
Request Body schema: application/x-www-form-urlencoded
required
subscription[user_id]
required
integer <int32>
subscription[notes]
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "membership_type_id": 0,
  • "user_id": 0,
  • "payment_method_type": "string",
  • "payment_method": "string",
  • "expires_at": "2019-08-24T14:15:22Z",
  • "canceled_at": "2019-08-24T14:15:22Z",
  • "notes": "string",
  • "created_by_admin": true,
  • "is_recurring": true,
  • "number_of_user_renewals": 0,
  • "number_of_admin_renewals": 0,
  • "manual_transactions_ids": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "payment_option_id": 0
}

Memberships Subscription Destroy

Destroy Memberships Subscription by ID

Only subscriptions added by admin are allowed

Required parameters are :

  • Memberships Subscription ID,
query Parameters
memberships_subscription_id
required
integer <int32>

Responses

engagement_scoring

Operations about engagement_scorings

Get all rankings

Get the full list of users rankings

Return user_id with the rank and current score for each users.

Use the params scope with different value to either scope at global or group level:

scope = "Network" # global level scope = "Topic" # group level

Careful: You can't scope at group level and send start_date/end_date params

query Parameters
scope
required
string
Enum: "Network" "Topic"
start_date
string <date>
end_date
string <date>

Responses

Response samples

Content type
application/json
{
  • "user_id": 0,
  • "topic_id": 0,
  • "rank": 0,
  • "current_score": 0
}

Get a user rank

Get the rank and the details of a user engagement scoring

Return the rank and each cumulated scores per rule for the specified user id.

Use the topic_id (optional) params to get the ranking of the user inside the given group.

path Parameters
user_id
required
integer <int32>
query Parameters
topic_id
integer <int32>
start_date
string <date>
end_date
string <date>

Responses

Response samples

Content type
application/json
{
  • "user_id": 0,
  • "topic_id": 0,
  • "rank": 0,
  • "current_score": 0,
  • "scores": {
    }
}

payment_accounts

Operations about payment_accounts

List of Payment Accounts

Get a paginated list of Payment Accounts

Pagination information are stored in the response header as defined by RFC-5988 http://tools.ietf.org/html/rfc5988 Example:

{
"link": "<https://hivebrite.com/api/admin/v2/payment_accounts?page=1&per_page=30>; rel=\"first\", <https://hivebrite.com/api/admin/v2/payment_accounts?page=3&per_page=30>; rel=\"prev\", <https://hivebrite.com/api/admin/v2/payment_accounts?page=2041&per_page=30>; rel=\"last\", <https://hivebrite.com/api/admin/v2/payment_accounts?page=30&per_page=30>; rel=\"next\"",
"x-per-page": "30",
"x-total": "10201",
"x-page": "4"
}

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "account_type": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "available_for_all_groups": true,
  • "groups": {
    }
}

getAdminV2PaymentAccountsId

Detail of a Payment Account

path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "account_type": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "available_for_all_groups": true,
  • "groups": {
    }
}

categories

Operations about categories

List of Categories

Get a paginated list of Categories

Pagination information are stored in the response header as defined by RFC-5988 http://tools.ietf.org/html/rfc5988 Example:

{
"link": "<https://hivebrite.com/api/admin/v2/categories?page=1&per_page=30>; rel=\"first\", <https://hivebrite.com/api/admin/v2/categories?page=3&per_page=30>; rel=\"prev\", <https://hivebrite.com/api/admin/v2/categories?page=2041&per_page=30>; rel=\"last\", <https://hivebrite.com/api/admin/v2/categories?page=30&per_page=30>; rel=\"next\"",
"x-per-page": "30",
"x-total": "10201",
"x-page": "4"
}
query Parameters
categorized_types
string
Enum: "emailing" "news" "events" "donations_campaign" "donations_fund" "media_center_file" "portfolio" "discussion" "journey"
[String, [String]]
string
Enum: "emailing" "news" "events" "donations_campaign" "donations_fund" "media_center_file" "portfolio" "discussion" "journey"

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "categorized_type": "emailing",
  • "available_for_network": true,
  • "available_for_all_topics": true,
  • "topic_ids": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Create a Category

For each Category, you can link or unlink groups to it.

To do so, you need to send a list of groups ids (topic_ids) to link or unlink them to the category. You can make the category available for features at the network level. You can make the category available for features at the group level and for all groups.

If you decide to pass available_for_all_topics at true, it will clear the topic_ids list. Both boolean attributes (available_for_network and available_for_all_topics) can be at true or false at the same time.

{
  category: {
    name: "Category name",
    categorized_type: "Category type",
    available_for_network: false,
    available_for_all_topics: false,
    topic_ids: [1, 2, 3],
  }
}
Request Body schema: application/x-www-form-urlencoded
required
category[name]
required
string

Name of the Category

category[categorized_type]
required
string
Enum: "emailing" "news" "events" "donations_campaign" "donations_fund" "media_center_file" "portfolio" "discussion" "journey"

Type of items Categorized

category[available_for_network]
boolean

Category available at the network level

category[available_for_all_topics]
boolean

Category available for all groups

category[topic_ids][]
Array of integers <int32> [ items <int32 > ]

Linked group ids to the category

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "categorized_type": "emailing",
  • "available_for_network": true,
  • "available_for_all_topics": true,
  • "topic_ids": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

getAdminV2CategoriesId

Get a Category information

path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "categorized_type": "emailing",
  • "available_for_network": true,
  • "available_for_all_topics": true,
  • "topic_ids": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

deleteAdminV2CategoriesId

Delete a Category

path Parameters
id
required
integer <int32>

Responses

Update an existing Category

For each Category, you can link or unlink groups to it.

To do so, you need to send a list of groups ids (topic_ids) to link or unlink them to the category. You can make the category available for features at the network level. You can make the category available for features at the group level and for all groups.

If you decide to pass available_for_all_topics at true, it will clear the topic_ids list. Both boolean attributes (available_for_network and available_for_all_topics) can be at true or false at the same time.

{
  category: {
    name: "Category name",
    categorized_type: "Category type",
    available_for_network: false,
    available_for_all_topics: false,
    topic_ids: [1, 2, 3],
  }
}
path Parameters
id
required
integer <int32>

ID of the Category

Request Body schema: application/x-www-form-urlencoded
category[name]
string

Name of the Category

category[available_for_network]
boolean

Category available at the network level

category[available_for_all_topics]
boolean

Category available for all groups

category[topic_ids][]
Array of integers <int32> [ items <int32 > ]

Linked group ids to the category

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "categorized_type": "emailing",
  • "available_for_network": true,
  • "available_for_all_topics": true,
  • "topic_ids": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

current_locations

Operations about current_locations

Get all user check-in/current locations

Return an array of current locations (check-in) with basic informations

Use the parameter updated_since or created_sinceto fetch all current locations updated/created since this datetime (e.g. updated_since=2017-08-01T00:00:00 or created_since=2017-08-01T00:00:00` )

Use the parameter order to choose on which criterias the results should be ordered (e.g. order=updated_at to order by updated_at descending, use the minus operator to order by ascending value e.g. order=-updated_at).

Pagination information are stored in the response header as defined by RFC-5988 http://tools.ietf.org/html/rfc5988

Example:

{
"link": "<https://hivebrite.com/api/admin/v2/current_locations?page=1&per_page=30>; rel=\"first\", <https://hivebrite.com/api/admin/v2/current_locations?page=3&per_page=30>; rel=\"prev\", <https://hivebrite.com/api/admin/v2//current_locations?page=2041&per_page=30>; rel=\"last\", <https://hivebrite.com/api/admin/v2/current_locations?page=30&per_page=30>; rel=\"next\"",
"x-per-page": "30",
"x-total": "10201",
"x-page": "4"
}
query Parameters
page
integer <int32>
Default: 1

Page of results to fetch.

per_page
integer <int32>
Default: null

Number of results to return per page.

created_since
string <date-time>
updated_since
string <date-time>
order
string
Enum: "id" "-id" "user_id" "-user_id" "created_at" "-created_at" "updated_at" "-updated_at" "city" "-city" "country" "-country" "country_code" "-country_code" "timezone" "-timezone"
filter[user_id]
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "user_id": "string",
  • "location_type": "string",
  • "address": "string",
  • "city": "string",
  • "country": "string",
  • "country_code": "string",
  • "administrative_area_level_1": "string",
  • "administrative_area_level_2": "string",
  • "timezone": "string",
  • "content": "string",
  • "feedable_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Get user check-in/current location

Return the user check-in/current location

Find the user current location matching the current location ID

path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "user_id": "string",
  • "location_type": "string",
  • "address": "string",
  • "city": "string",
  • "country": "string",
  • "country_code": "string",
  • "administrative_area_level_1": "string",
  • "administrative_area_level_2": "string",
  • "timezone": "string",
  • "content": "string",
  • "feedable_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

media_center

Operations about media_centers

Update a file

Updates a file with the provided information

thumbnail_image must be sent as a file (URL to files won't work)

path Parameters
id
required
integer <int32>
Request Body schema: application/x-www-form-urlencoded
file[name]
string

Name of the file

file[description]
string

File description

file[network_category_ids][]
Array of integers <int32> [ items <int32 > ]

IDs list of the file categories

file[external_url]
string

external link URL

file[is_downloadable]
boolean

True/False is the file download button enabled?

file[downloads_count]
integer <int32>

File downloads count

file[views_count]
integer <int32>

File view count

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "uuid": "string",
  • "name": "string",
  • "description": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "folder_id": 0,
  • "network_category_ids": [
    ],
  • "content_type": "string",
  • "url": "string",
  • "external_link": true,
  • "external_url": "string",
  • "is_downloadable": true,
  • "pinned_on_index_page": true,
  • "popularity_score": 0,
  • "comments_count": 0,
  • "likes_count": 0,
  • "downloads_count": 0,
  • "views_count": 0,
  • "owner": {
    }
}

Remove a File

Delete a File

path Parameters
id
required
integer <int32>

Responses

File Details

Get a file's information

path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "uuid": "string",
  • "name": "string",
  • "description": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "folder_id": 0,
  • "network_category_ids": [
    ],
  • "content_type": "string",
  • "url": "string",
  • "external_link": true,
  • "external_url": "string",
  • "is_downloadable": true,
  • "pinned_on_index_page": true,
  • "popularity_score": 0,
  • "comments_count": 0,
  • "likes_count": 0,
  • "downloads_count": 0,
  • "views_count": 0,
  • "owner": {
    }
}

Create a File

Creates a file inside the folder with the provided ID

attachment and thumbnail_image must be sent as a file (URL to files won't work)

To add to a user portfolio ensure that the folder_id is a folder that belongs to that user

Required parameters are :

name and folder_id

NOTE: Maximum total payload size is 500MB

Request Body schema: application/x-www-form-urlencoded
required
file[name]
required
string

Name of the file

file[folder_id]
required
integer <int32>

ID of the parent folder

file[attachment]
string <binary>

Primary attachment of the item

file[description]
string

File description

file[network_category_ids][]
Array of integers <int32> [ items <int32 > ]

IDs list of the file categories

file[external_url]
string

external link URL

file[is_downloadable]
boolean

True/False is the file download button enabled?

file[thumbnail_image]
string <binary>

Image file for item thumbnail

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "uuid": "string",
  • "name": "string",
  • "description": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "folder_id": 0,
  • "network_category_ids": [
    ],
  • "content_type": "string",
  • "url": "string",
  • "external_link": true,
  • "external_url": "string",
  • "is_downloadable": true,
  • "pinned_on_index_page": true,
  • "popularity_score": 0,
  • "comments_count": 0,
  • "likes_count": 0,
  • "downloads_count": 0,
  • "views_count": 0,
  • "owner": {
    }
}

Move a File to a new location

Moves a file inside the folder with the provided ID

path Parameters
id
required
integer <int32>
Request Body schema: application/x-www-form-urlencoded
required
folder_id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "uuid": "string",
  • "name": "string",
  • "description": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "folder_id": 0,
  • "network_category_ids": [
    ],
  • "content_type": "string",
  • "url": "string",
  • "external_link": true,
  • "external_url": "string",
  • "is_downloadable": true,
  • "pinned_on_index_page": true,
  • "popularity_score": 0,
  • "comments_count": 0,
  • "likes_count": 0,
  • "downloads_count": 0,
  • "views_count": 0,
  • "owner": {
    }
}

File Download URL

Get a file's download URL

path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "url": "string"
}

Get a list of files

Get a paginated list files in the given source

linked_to=group&linked_to_id={group_id} all of that group's media center files

linked_to=user&linked_to_id={user_id} all of that user's portfolio files

if no linked_to value is provided network level Media Center files will be returned

Example:

{
"x-per-page": "30",
"x-total": "10201",
"x-page": "4"
}
query Parameters
page
integer <int32>
Default: 1

Page of results to fetch.

per_page
integer <int32> [ 1 .. 100 ]
Default: null

Number of results to return per page.

linked_to
string
Default: "network"
Enum: "network" "group" "user"
linked_to_id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "uuid": "string",
  • "name": "string",
  • "description": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "folder_id": 0,
  • "network_category_ids": [
    ],
  • "content_type": "string",
  • "url": "string",
  • "external_link": true,
  • "external_url": "string",
  • "is_downloadable": true,
  • "pinned_on_index_page": true,
  • "popularity_score": 0,
  • "comments_count": 0,
  • "likes_count": 0,
  • "downloads_count": 0,
  • "views_count": 0,
  • "owner": {
    }
}

Update a Folder

Updates a folder with the provided information

cover_picture must be sent as a file (URL to files won't work)

To add to a user portfolio ensure that the parent_id is a folder that belongs to that user

path Parameters
id
required
integer <int32>
Request Body schema: application/x-www-form-urlencoded
folder[name]
string
folder[description]
string
folder[cover_picture]
string <binary>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "uuid": "string",
  • "parent_id": 0,
  • "name": "string",
  • "description": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "child_files_count": 0,
  • "files": {
    },
  • "child_folders_count": 0,
  • "folders": {
    },
  • "cover_picture": "string",
  • "owner": {
    }
}

Folder Details

Get a folder

Additional information on files in this folder can be retrieved on /api/admin/v2/media_center/{folder_id}/files

path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "uuid": "string",
  • "parent_id": 0,
  • "name": "string",
  • "description": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "child_files_count": 0,
  • "files": {
    },
  • "child_folders_count": 0,
  • "folders": {
    },
  • "cover_picture": "string",
  • "owner": {
    }
}

Remove a Folder

Delete a folder and it's contents

path Parameters
id
required
integer <int32>

Responses

Create a Folder

Creates a child folder inside the folder with the provided parent_id

cover_picture must be sent as a file (URL to files won't work)

To add to a user portfolio ensure that the parent_id is a folder that belongs to that user

Request Body schema: application/x-www-form-urlencoded
required
folder[name]
required
string
folder[parent_id]
required
integer <int32>
folder[description]
string
folder[cover_picture]
string <binary>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "uuid": "string",
  • "parent_id": 0,
  • "name": "string",
  • "description": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "child_files_count": 0,
  • "files": {
    },
  • "child_folders_count": 0,
  • "folders": {
    },
  • "cover_picture": "string",
  • "owner": {
    }
}

Get a list of files in a folder

Get a paginated list of files in the given folder

Example:

{
"x-per-page": "30",
"x-total": "10201",
"x-page": "4"
}
path Parameters
id
required
integer <int32>
query Parameters
page
integer <int32>
Default: 1

Page of results to fetch.

per_page
integer <int32> [ 1 .. 100 ]
Default: null

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "uuid": "string",
  • "name": "string",
  • "description": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "folder_id": 0,
  • "network_category_ids": [
    ],
  • "content_type": "string",
  • "url": "string",
  • "external_link": true,
  • "external_url": "string",
  • "is_downloadable": true,
  • "pinned_on_index_page": true,
  • "popularity_score": 0,
  • "comments_count": 0,
  • "likes_count": 0,
  • "downloads_count": 0,
  • "views_count": 0,
  • "owner": {
    }
}

Move a Folder to a new location

Moves a child folder inside the folder with the provided parent_id

path Parameters
id
required
integer <int32>
Request Body schema: application/x-www-form-urlencoded
required
parent_id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "uuid": "string",
  • "parent_id": 0,
  • "name": "string",
  • "description": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "child_files_count": 0,
  • "files": {
    },
  • "child_folders_count": 0,
  • "folders": {
    },
  • "cover_picture": "string",
  • "owner": {
    }
}

Root Folder

Get the root folder of the Network/Group/User portfolio

use linked_to=group and linked_to_id={group_id} to retrieve a group's root folder and its children folders/files

use linked_to=user and linked_to_id={user_id} to retrieve a user's portfolio root folder and its children folders/files

Additional information on files in this folder can be retrieved on /api/admin/v2/media_center/{folder_id}/files

query Parameters
linked_to
string
Default: "network"
Enum: "network" "group" "user"
linked_to_id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "uuid": "string",
  • "parent_id": 0,
  • "name": "string",
  • "description": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "child_files_count": 0,
  • "files": {
    },
  • "child_folders_count": 0,
  • "folders": {
    },
  • "cover_picture": "string",
  • "owner": {
    }
}

audit_logs

Operations about audit_logs

List of Audit logs

Returns a list of Audit Logs based on the optional parameters.

Audit log feature is currently only available to a limited number of customers for beta testing.

This endpoint will return a list of audit logs, for example:

[
  {
    "thread_id": "",
    "group_id": "",
    "user_id": "1",
    "user_type": "user",
    "user_email": "[email protected]",
    "user_external_id": "",
    "user_ip": "127.0.0.1",
    "entity_id": "",
    "entity_type": "user",
    "event_type": "custom_action",
    "audience": "full_network",
    "action": "search_people_directory",
    "event_origin": "frontoffice",
    "created_at": "2023-11-06T09:10:51.762660Z"
  },
  {
    "thread_id": "",
    "group_id": "",
    "user_id": "1",
    "user_type": "user",
    "user_email": "[email protected]",
    "user_external_id": "",
    "user_ip": "127.0.0.1",
    "entity_id": "",
    "entity_type": "user",
    "event_type": "custom_action",
    "audience": "full_network",
    "action": "search_people_directory",
    "event_origin": "frontoffice",
    "created_at": "2023-11-06T09:10:53.561373Z"
  }
]

Pagination information is stored in the response header as defined by RFC-5988

http://tools.ietf.org/html/rfc5988

Example:

{
  "link": "<https://hivebrite.com/api/admin/v3/audit_logs/logs?page=1&per_page=30>; rel=\"first\",
  <https://hivebrite.com/api/admin/v3/audit_logs/logs?page=3&per_page=30>; rel=\"prev\"",
  "x-per-page": "30",
  "x-total": "10201",
  "x-page": "4"
}

Mandatory parameters

(none)

Example of Audit Logs queries

Show me all the audit logs that have delete actions between 13/11/2023 and 14/11/2023.

/api/admin/v3/audit_logs/logs?actions=delete&created_at[from]=13/11/2023&created_at[until]=14/11/2023

Show me all the audit logs where user 1 searched in the people directory.

api/admin/v3/audit_logs/logs?actions=search_people_directory&user=1

Show me all the audit logs where user 2 wrote a feed post on 13/11/2023 (hint: to include a whole day you need to provide both created_at[from/until]).

api/admin/v3/audit_logs/logs?actions=create&user_ids=2&entity_type=posts/feed_post&created_at[from]=13/11/2023&created_at[until]=14/11/2023
query Parameters
group_ids
string

search by group ids. Use comma separated values if more than one value is provided. Example: group_ids=1,2,3

group_id_is_null
boolean

search where group_id is null. Accepts true or false. Example: group_id_is_null=true

user_types
string

search by user types. Use comma separated values if more than one value is provided. Example: user_type=user

user_ids
string

search by user ids. Use comma separated values if more than one value is provided. Example: user_ids=1,2,3

user_emails
string

search by user emails. Use comma separators for multiple values. Example: user_emails=us1@mail.com,us2@mail.com,us3@mail.com

user_external_ids
string

search by user external ids. Use comma separators for multiple values. Example: user_external_ids=ext-1,ext-2,ext-3

user_ips
string

search by user ips. Use comma separators for multiple values. Example: user_ips=127.0.0.1,192.168.1.1

entity_types
string

search by entity types. Use comma separated values if more than one value is provided. Example: entity_types=posts/feed_post

entity_ids
string

search by entity ids. Use comma separated values if more than one value is provided. Example: group_ids=1,2,3

event_origins
string

search by event origins. Use comma separated values if more than one value is provided. Example: event_origins=frontoffice,mobile,backoffice,api,internal

event_types
string

search by event types. Use comma separated values if more than one value is provided. Example: event_types=standard

audiences
string

search by audiences. Use comma separated values if more than one value is provided. Example: audiences=full_network

actions
string

search by actions. Use comma separated values if more than one value is provided. Example: actions=create,update,delete

parent_ids
string

search by parent ids (use comma separated values)

parent_types
string

search by parent types (use comma separated values)

parent_type_is_null
boolean

search where parent_type is null. Accepts true or false. Example: parent_type_is_null=true

parent_id_is_null
boolean

search where parent_id is null. Accepts true or false. Example: parent_id_is_null=true

impersonator_ids
string

search by impersonator ids (use comma separated values)

impersonator_types
string

search by impersonator types (use comma separated values)

created_at[from]
string <date-time>

search from a given date time (using date format: DD/MM/YYYY), e.g. 03/11/2023 or 03/11/2023 8:50:00 AM

created_at[until]
string <date-time>

search until a given date time (using date format: DD/MM/YYYY), e.g. 03/11/2023 or 03/11/2023 8:50:00 AM

page
integer <int32>
Default: 1

Page of results to fetch.

per_page
integer <int32>
Default: 20

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "thread_id": "string",
  • "group_id": "string",
  • "user_id": "string",
  • "user_type": "string",
  • "user_email": "string",
  • "user_external_id": "string",
  • "user_ip": "string",
  • "impersonator_id": "string",
  • "impersonator_type": "string",
  • "entity_id": "string",
  • "entity_type": "string",
  • "event_type": "string",
  • "audience": "string",
  • "action": "string",
  • "event_origin": "string",
  • "created_at": "string",
  • "content": {
    }
}

admins

Operations about admins

Update an Admin account by ID

Allows for basic updates of admin info fields

Optional parameters

name String - the name of the admin

email String - the email address of the admin, will be used for admin communications

sso_identifier String - an SSO identifier unique to this admin account for sign in verification

user_id Integer - the user ID of the user account associated with this admin

path Parameters
id
required
integer <int32>

ID of the admin to update

Request Body schema: application/x-www-form-urlencoded
admin[name]
string

Name of the admin

admin[email]
string

Admin email

admin[sso_identifier]
string

SSO ID of the Admin account

admin[user_id]
integer <int32>

ID of the user to link to the admin account

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "email": "string",
  • "name": "string",
  • "admin_type": "global",
  • "created_at": "2019-08-24T14:15:22Z"
}

Show an Admin account by ID

path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "email": "string",
  • "name": "string",
  • "admin_type": "global",
  • "created_at": "2019-08-24T14:15:22Z"
}

Delete an Admin account by ID

path Parameters
id
required
integer <int32>

ID of the admin to be deleted

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "errors": "string"
}

List of Admin accounts

Use the network filter type to retrieve only network admins Use the topic filter type to retrieve only group level admins.

Use the managed_topic_id filter to retrieve only admins with 'specific group' access to group with the supplied ID.

query Parameters
type
string
Default: "all"
Enum: "network" "topic" "all"

Admin access level

managed_topic_id
integer <int32>

Group/Topic ID that the Admins have access

page
integer <int32>
Default: 1

Page of results to fetch.

per_page
integer <int32>
Default: 20

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "email": "string",
  • "name": "string",
  • "admin_type": "global",
  • "created_at": "2019-08-24T14:15:22Z"
}

Create a new admin account

Creates an admin account.

Mandatory parameters

name (required) String - the name of the admin

email (required) String - the email address of the admin, will be used for admin communications

Optional parameters

sso_identifier String - an SSO identifier unique to this admin account for sign in verification

user_id Integer - the user ID of the user account associated with this admin

  • If no user_id is provided a new user will be created to link to the admin account
Request Body schema: application/x-www-form-urlencoded
required
admin[name]
required
string

Name of the admin

admin[email]
required
string

Admin email

admin[sso_identifier]
string

SSO ID of the Admin account

admin[user_id]
integer <int32>

ID of the user to link to the admin account

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "email": "string",
  • "name": "string",
  • "admin_type": "global",
  • "created_at": "2019-08-24T14:15:22Z"
}

mentoring

Operations about mentorings

Create a new mentee profile

This endpoint is only available for Admin Match programs.

Required parameters are:

  • program_id: ID of the program.
  • mentee_profile[user_id]: ID of the user’s profile in the network (Not to be confused with the user’s mentee profile in the program).
  • mentee_profile[status]: Status of the mentee profile (pending, accepted, on_pause, rejected_can_reapply, rejected_cannot_reapply, terminated).

Optional parameters are:

  • mentee_profile[send_notification]: Boolean to enable automated email notifications (default: false).
  • mentee_profile[customizable_attributes]: Values for the program's customizable attributes. See format below.

Format: The customizable attribute name on the left (that you can find with the customizable attribute index API endpoint), and the value on the right, with an example of format for each type.

{
  _sample_name_boolean_custom_attribute_1: true,
  _sample_name_date_custom_attribute_2: "2024-07-04",
  _sample_name_double_select_custom_attribute_3: {"root_value": "First answer", "child_value": ["Sub answer"]},
  _sample_name_number_custom_attribute_4: 123,
  _sample_name_select_custom_attribute_5: ["Answer"],
  _sample_name_text_custom_attribute_6: "Answer"
}
Request Body schema: application/x-www-form-urlencoded
required
program_id
required
integer <int32>

ID of the program

mentee_profile[user_id]
required
integer <int32>

ID of the user

mentee_profile[status]
required
string
Enum: "accepted" "pending" "rejected_can_reapply" "rejected_cannot_reapply" "terminated" "on_pause"

Status of the mentee

mentee_profile[send_notification]
boolean

Send automated email notifications

mentee_profile[customizable_attributes]
json

Values for the program's customizable attributes

Responses

Response samples

Content type
application/json
{
  • "mentee_id": 0,
  • "mentoring_program_id": 0,
  • "user_id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "status_transition_dates": { },
  • "status": "string",
  • "location": {
    },
  • "skills": "string",
  • "name": "string",
  • "customizable_attributes": { }
}

List of mentee profiles

Get a paginated list of mentee profiles.

Required parameters are:

  • program_id: ID of the program.

Optional parameters, in order to filter out, are:

  • filters[:statuses]: Status of the mentee.
  • filters[:relationship_statuses]: Status of the associated relationship.
  • filters[:mentee_id]: ID of the user's mentee profile to be used as a filter (Not to be confused with user id on the profile)
  • filters[:check_user_rights]: Return only users who have the mentee right (default to true)
query Parameters
page
integer <int32>
Default: 1

Page of results to fetch.

per_page
integer <int32>
Default: null

Number of results to return per page.

program_id
required
integer <int32>

ID of the program

filters[statuses][]
Array of strings
Items Enum: "accepted" "pending" "rejected_can_reapply" "rejected_cannot_reapply" "terminated" "on_pause"

Status of the mentee

filters[relationship_statuses][]
Array of strings
Items Enum: "accepted" "pending" "rejected" "terminated"

Status of the associated relationship

filters[mentor_id]
integer <int32>

ID of the associated mentor

filters[check_user_rights]
boolean
Default: true

Check user rights (default to true)

Responses

Response samples

Content type
application/json
{
  • "mentee_id": 0,
  • "mentoring_program_id": 0,
  • "user_id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "status_transition_dates": { },
  • "status": "string",
  • "location": {
    },
  • "skills": "string",
  • "name": "string",
  • "customizable_attributes": { }
}

Delete a mentee profile

Required parameters are:

  • program_id: ID of the program.
  • id: ID of the mentee profile to be deleted.
path Parameters
id
required
integer <int32>

ID of the mentee profile

query Parameters
program_id
required
integer <int32>

ID of the program

Responses

Get information on a mentee profile

Required parameters are:

  • program_id: ID of the program.
  • id: Unique ID of the mentee profile.
path Parameters
id
required
integer <int32>

ID of the mentee

query Parameters
program_id
required
integer <int32>

ID of the program

Responses

Response samples

Content type
application/json
{
  • "mentee_id": 0,
  • "mentoring_program_id": 0,
  • "user_id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "status_transition_dates": { },
  • "status": "string",
  • "location": {
    },
  • "skills": "string",
  • "name": "string",
  • "customizable_attributes": { }
}

Update information of a specific mentee profile

Required parameters are:

  • program_id: ID of the program.
  • id: ID of the user's mentee profile to be updated. (Not to be confused with the user's id on the User Profile).
  • mentee_profile[status]: Status of the mentee profile (pending, accepted, on_pause, rejected_can_reapply, rejected_cannot_reapply, terminated).

Optional parameters are:

  • mentee_profile[send_notification]: Boolean to enable automated email notifications (default: false).
  • mentee_profile[customizable_attributes]: Values for the program's customizable attributes. See format below.

Format: The customizable attribute name on the left (that you can find with the customizable attribute index API endpoint), and the value on the right, with an example of format for each type.

{
  _sample_name_boolean_custom_attribute_1: true,
  _sample_name_date_custom_attribute_2: "2024-07-04",
  _sample_name_double_select_custom_attribute_3: {"root_value": "First answer", "child_value": ["Sub answer"]},
  _sample_name_number_custom_attribute_4: 123,
  _sample_name_select_custom_attribute_5: ["Answer"],
  _sample_name_text_custom_attribute_6: "Answer"
}
path Parameters
id
required
integer <int32>

ID of the mentee profile

Request Body schema: application/x-www-form-urlencoded
required
program_id
required
integer <int32>

ID of the program

mentee_profile[status]
string
Enum: "accepted" "pending" "rejected_can_reapply" "rejected_cannot_reapply" "terminated" "on_pause"

Status of the mentee

mentee_profile[send_notification]
boolean

Send automated email notifications

mentee_profile[customizable_attributes]
json

Values for the program's customizable attributes

Responses

Response samples

Content type
application/json
{
  • "mentee_id": 0,
  • "mentoring_program_id": 0,
  • "user_id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "status_transition_dates": { },
  • "status": "string",
  • "location": {
    },
  • "skills": "string",
  • "name": "string",
  • "customizable_attributes": { }
}

Create a new mentor profile

Required parameters are:

  • program_id: ID of the program.
  • mentor_profile[user_id]: ID of the user’s profile in the network (Not to be confused with the user’s mentor profile in the program).
  • mentor_profile[status]: Status of the mentor profile (pending, accepted, on_pause, rejected_can_reapply, rejected_cannot_reapply, terminated).

Optional parameters are:

  • mentor_profile[send_notification]: Boolean to enable automated email notifications (default: false).
  • mentor_profile[customizable_attributes]: Values for the program's customizable attributes. See format below.

Format: The customizable attribute name on the left (that you can find with the customizable attribute index API endpoint), and the value on the right, with an example of format for each type.

{
  _sample_name_boolean_custom_attribute_1: true,
  _sample_name_date_custom_attribute_2: "2024-07-04",
  _sample_name_double_select_custom_attribute_3: {"root_value": "First answer", "child_value": ["Sub answer"]},
  _sample_name_number_custom_attribute_4: 123,
  _sample_name_select_custom_attribute_5: ["Answer"],
  _sample_name_text_custom_attribute_6: "Answer"
}
Request Body schema: application/x-www-form-urlencoded
required
program_id
required
integer <int32>

ID of the program

mentor_profile[user_id]
required
integer <int32>

ID of the user

mentor_profile[status]
required
string
Enum: "accepted" "on_pause" "pending" "rejected_can_reapply" "rejected_cannot_reapply" "terminated"

Status of the mentor

mentor_profile[send_notification]
boolean

Send automated email notifications

mentor_profile[customizable_attributes]
json

Values for the program's customizable attributes

Responses

Response samples

Content type
application/json
{
  • "mentor_id": 0,
  • "mentoring_program_id": 0,
  • "user_id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "accepted_mentees_count": 0,
  • "status_transition_dates": { },
  • "status": "string",
  • "location": {
    },
  • "skills": "string",
  • "name": "string",
  • "customizable_attributes": { }
}

List of mentor profiles

Get a paginated list of mentor profiles.

Required parameters are:

  • program_id: ID of the program.

Optional parameters, in order to filter out, are:

  • filters[:statuses]: Status of the mentor.
  • filters[:relationship_statuses]: Status of the associated relationship.
  • filters[:mentee_id]: ID of the user's mentee profile to be used as a filter (Not to be confused with user id on the profile)
  • filters[:check_user_rights]: Return only users who have the mentor right (default to true)
query Parameters
page
integer <int32>
Default: 1

Page of results to fetch.

per_page
integer <int32>
Default: null

Number of results to return per page.

program_id
required
integer <int32>

ID of the program

filters[statuses][]
Array of strings
Items Enum: "accepted" "on_pause" "pending" "rejected_can_reapply" "rejected_cannot_reapply" "terminated"

Status of the mentor

filters[relationship_statuses][]
Array of strings
Items Enum: "accepted" "pending" "rejected" "terminated"

Status of the associated relationship

filters[mentee_id]
integer <int32>

ID of the associated mentee

filters[check_user_rights]
boolean
Default: true

Check user rights (default to true)

Responses

Response samples

Content type
application/json
{
  • "mentor_id": 0,
  • "mentoring_program_id": 0,
  • "user_id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "accepted_mentees_count": 0,
  • "status_transition_dates": { },
  • "status": "string",
  • "location": {
    },
  • "skills": "string",
  • "name": "string",
  • "customizable_attributes": { }
}

Delete a mentor profile

Required parameters are:

  • program_id: ID of the program.
  • id: ID of the mentor profile to be deleted.
path Parameters
id
required
integer <int32>

ID of the mentor profile

query Parameters
program_id
required
integer <int32>

ID of the program

Responses

Get information on a mentor profile

Required parameters are:

  • program_id: ID of the program.
  • id: Unique ID of the mentor profile.
path Parameters
id
required
integer <int32>

ID of the mentor

query Parameters
program_id
required
integer <int32>

ID of the program

Responses

Response samples

Content type
application/json
{
  • "mentor_id": 0,
  • "mentoring_program_id": 0,
  • "user_id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "accepted_mentees_count": 0,
  • "status_transition_dates": { },
  • "status": "string",
  • "location": {
    },
  • "skills": "string",
  • "name": "string",
  • "customizable_attributes": { }
}

Update information of a specific mentor profile

Required parameters are:

  • program_id: ID of the program.
  • id: ID of the user's mentor profile to be updated. (Not to be confused with the user's id on the User Profile).
  • mentor_profile[status]: Status of the mentor profile (pending, accepted, on_pause, rejected_can_reapply, rejected_cannot_reapply, terminated).

Optional parameters are:

  • mentor_profile[send_notification]: Boolean to enable automated email notifications (default: false).
  • mentor_profile[customizable_attributes]: Values for the program's customizable attributes. See format below.

Format: The customizable attribute name on the left (that you can find with the customizable attribute index API endpoint), and the value on the right, with an example of format for each type.

{
  _sample_name_boolean_custom_attribute_1: true,
  _sample_name_date_custom_attribute_2: "2024-07-04",
  _sample_name_double_select_custom_attribute_3: {"root_value": "First answer", "child_value": ["Sub answer"]},
  _sample_name_number_custom_attribute_4: 123,
  _sample_name_select_custom_attribute_5: ["Answer"],
  _sample_name_text_custom_attribute_6: "Answer"
}
path Parameters
id
required
integer <int32>

ID of the mentor profile

Request Body schema: application/x-www-form-urlencoded
required
program_id
required
integer <int32>

ID of the program

mentor_profile[status]
string
Enum: "accepted" "on_pause" "pending" "rejected_can_reapply" "rejected_cannot_reapply" "terminated"

Status of the mentor

mentor_profile[send_notification]
boolean

Send automated email notifications

mentor_profile[customizable_attributes]
json

Values for the program's customizable attributes

Responses

Response samples

Content type
application/json
{
  • "mentor_id": 0,
  • "mentoring_program_id": 0,
  • "user_id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "accepted_mentees_count": 0,
  • "status_transition_dates": { },
  • "status": "string",
  • "location": {
    },
  • "skills": "string",
  • "name": "string",
  • "customizable_attributes": { }
}

Create a new mentoring program

Required parameters are:

  • mode: Program type or how matches are created in the program. Possible values are user_match for programs where mentees apply directly to mentors, and admin_match for programs where admins create matches between mentors and mentees.
  • name: Title of the program.
  • parent_type: Type of the parent or creator of the program. Possible values are Network for the network created programs, and Topics::Topic for group created programs. This field is required if you are getting information on a program created in a group. If left blank, the system will assume that you are looking for a program created by the network/global level.
  • parent_id: ID of the parent network or group. This field is required if you are getting information on a program created in a group. If left blank, the system will assume that you are looking for a program created by the network/global level.

Optional parameters are:

  • description: The description of the program.
  • cover_picture: The cover picture of the program.
  • mentee_label: Mentee custom label. How mentees are referred to in the Front Office pages of this program.
  • mentor_label: Mentor custom label. How mentors are referred to in the Front Office pages of this program.
  • maximum_mentees: Maximum number of mentees allowed per mentor. This setting is program based, and all mentors will have this limit. This limit cannot be set per mentor.
  • applied_to_be_mentee_text: Text displayed at the top of the mentee application form. This is usually defined in the Application forms tab in the Back Office.
  • applied_to_be_mentor_text: Text displayed at the top of the mentor application form. This is usually defined in the Application forms tab in the Back Office.
  • manager_ids: Admin IDs set to be "program managers". These admins receive all automated admin related emails of this specific program.
  • published_at: Date when the program was published.
Request Body schema: application/x-www-form-urlencoded
required
program[mode]
required
string
Enum: "user_match" "admin_match"

Program type/ how matches are created

program[name]
required
string

Title of the program

program[parent_type]
string
Enum: "Network" "Topics::Topic"

Program creator type

program[parent_id]
integer <int32>

Program creator ID

program[description]
string

Description of the program

program[cover_picture]
string <binary>

Cover picture of the program

program[mentee_label]
string

Mentee custom label

program[mentor_label]
string

Mentor custom label

program[maximum_mentees]
integer <int32>

Maximum number of mentees allowed per mentor

program[applied_to_be_mentee_text]
string

Text displayed at the top of the mentee application form

program[applied_to_be_mentor_text]
string

Text displayed at the top of the mentor application form

program[manager_ids][]
Array of integers <int32> [ items <int32 > ]

IDs of admins to get automated emails about this program

program[published_at]
string <date-time>

Date when the program was published

Responses

Response samples

Content type
application/json
{
  • "applied_to_be_mentee_text": "string",
  • "applied_to_be_mentor_text": "string",
  • "cover_picture": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "id": 0,
  • "manager_ids": 0,
  • "maximum_mentees": 0,
  • "mentee_label": "string",
  • "mentor_label": "string",
  • "mode": "string",
  • "name": "string",
  • "parent_type": "string",
  • "parent_id": 0,
  • "published_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

List of mentoring programs

Get a paginated list of programs.

Pagination information are stored in the response header as defined by RFC-5988 http://tools.ietf.org/html/rfc5988 Example:

{
  "link": "<https://hivebrite.com/api/admin/v3/mentoring/programs?page=1&per_page=30>; rel=\"first\", <https://hivebrite.com/api/admin/v3/mentoring/programs?page=3&per_page=30>; rel=\"prev\", <https://hivebrite.com/api/admin/v3/mentoring/programs?page=2041&per_page=30>; rel=\"last\", <https://hivebrite.com/api/admin/v3/mentoring/programs?page=30&per_page=30>; rel=\"next\"",
  "x-per-page": "30",
  "x-total": "10201",
  "x-page": "4"
}

Optional parameters are:

  • parent_type: Type of the parent or creator of the program. Possible values are Network for the network created programs, and Topics::Topic for group created programs. This field is required if you are getting information on a program created in a group. If left blank, the system will assume that you are looking for a program created by the network.
  • parent_id: ID of the parent network or group. This field is required if you are getting information on a program created in a group. If left blank, the system will assume that you are looking for a program created by the network/global level.
  • modes: Program type or how matches are created in the program. Possible values are user_match for programs where mentees apply directly to mentors, and admin_match for programs where admins create matches between mentors and mentees.
  • published: Publication status of the program.
query Parameters
page
integer <int32>
Default: 1

Page of results to fetch.

per_page
integer <int32>
Default: null

Number of results to return per page.

program[parent_type]
string
Enum: "Network" "Topics::Topic"

Program creator type

program[parent_id]
integer <int32>

Program creator ID

program[modes][]
Array of strings
Items Enum: "user_match" "admin_match"

Program type/ how matches are created

program[published]
boolean

Publication status of the program

Responses

Response samples

Content type
application/json
{
  • "applied_to_be_mentee_text": "string",
  • "applied_to_be_mentor_text": "string",
  • "cover_picture": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "id": 0,
  • "manager_ids": 0,
  • "maximum_mentees": 0,
  • "mentee_label": "string",
  • "mentor_label": "string",
  • "mode": "string",
  • "name": "string",
  • "parent_type": "string",
  • "parent_id": 0,
  • "published_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Get information on a mentoring program

Required parameters are:

  • id: Unique ID of the program.

Optional parameters are:

  • parent_type: Type of the parent or creator of the program. Possible values are Network for the network created programs, and Topics::Topic for group created programs. This field is required if you are getting information on a program created in a group. If left blank, the system will assume that you are looking for a program created by the network/global level.
  • parent_id: ID of the parent network or group. This field is required if you are getting information on a program created in a group. If left blank, the system will assume that you are looking for a program created by the network/global level.

Gets general information about your program. Most of this information can be found on the “General Information” tab in the Back Office with the addition of more information on the cover image, and the creation and publication dates.

path Parameters
id
required
integer <int32>

ID of the program

query Parameters
program[parent_type]
string
Enum: "Network" "Topics::Topic"

Program creator type

program[parent_id]
integer <int32>

Program creator ID

Responses

Response samples

Content type
application/json
{
  • "applied_to_be_mentee_text": "string",
  • "applied_to_be_mentor_text": "string",
  • "cover_picture": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "id": 0,
  • "manager_ids": 0,
  • "maximum_mentees": 0,
  • "mentee_label": "string",
  • "mentor_label": "string",
  • "mode": "string",
  • "name": "string",
  • "parent_type": "string",
  • "parent_id": 0,
  • "published_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update information of a specific mentoring program

Required parameters are:

  • id: ID of the program to be updated.

Optional parameters are:

  • parent_type: Type of the parent or creator of the program. Possible values are Network for the network created programs, and Topics::Topic for group created programs. This field is required if you are getting information on a program created in a group. If left blank, the system will assume that you are looking for a program created by the network/global level.
  • parent_id: ID of the parent network or group. This field is required if you are getting information on a program created in a group. If left blank, the system will assume that you are looking for a program created by the network/global level.
  • name: Title of the program.
  • mode: Program type or how matches are created in the program. Possible values are user_match for programs where mentees apply directly to mentors, and admin_match for programs where admins create matches between mentors and mentees.
  • description: Description of the program.
  • cover_picture: The cover picture of the program.
  • mentee_label: Mentee custom label. How mentees are referred to in the Front Office pages of this program.
  • mentor_label: Mentor custom label. How mentors are referred to in the Front Office pages of this program.
  • maximum_mentees: Maximum number of mentees allowed per mentor. This setting is program based, and all mentors will have this limit. This limit cannot be set per mentor.
  • applied_to_be_mentee_text: Text displayed at the top of the mentee application form. This is usually defined in the Application forms tab in the Back Office.
  • applied_to_be_mentor_text: Text displayed at the top of the mentor application form. This is usually defined in the Application forms tab in the Back Office.
  • manager_ids: Admin ID set to be “program managers”. These admins receive all automated admin related emails of this specific program.
  • published_at: Date when the program was published.
path Parameters
id
required
integer <int32>

ID of the program to be updated

Request Body schema: application/x-www-form-urlencoded
program[parent_type]
string
Enum: "Network" "Topics::Topic"

Program creator type

program[parent_id]
integer <int32>

Program creator ID

program[name]
string

Title of the program

program[description]
string

Description of the program

program[cover_picture]
string <binary>

Cover picture of the program

program[mentee_label]
string

Mentee custom label

program[mentor_label]
string

Mentor custom label

program[maximum_mentees]
integer <int32>

Maximum number of mentees allowed per mentor

program[applied_to_be_mentee_text]
string

Text displayed at the top of the mentee application form

program[applied_to_be_mentor_text]
string

Text displayed at the top of the mentor application form

program[manager_ids][]
Array of integers <int32> [ items <int32 > ]

IDs of admins to get automated emails about this program

program[published_at]
string <date-time>

Date when the program was published

Responses

Response samples

Content type
application/json
{
  • "applied_to_be_mentee_text": "string",
  • "applied_to_be_mentor_text": "string",
  • "cover_picture": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "id": 0,
  • "manager_ids": 0,
  • "maximum_mentees": 0,
  • "mentee_label": "string",
  • "mentor_label": "string",
  • "mode": "string",
  • "name": "string",
  • "parent_type": "string",
  • "parent_id": 0,
  • "published_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Duplicate a program

Required parameters are:

  • id: ID of the program to be duplicated.

Optional parameters are:

  • parent_type: Type of the parent or creator of the program. Possible values are Network for the network created programs, and Topics::Topic for group created programs. This field is required if you are getting information on a program created in a group. If left blank, the system will assume that you are looking for a program created by the network/global level.
  • parent_id: ID of the parent network or group. This field is required if you are getting information on a program created in a group. If left blank, the system will assume that you are looking for a program created by the network/global level.
path Parameters
id
required
integer <int32>

ID of the program to be duplicated

Request Body schema: application/x-www-form-urlencoded
program[parent_type]
string
Enum: "Network" "Topics::Topic"

Program creator type

program[parent_id]
integer <int32>

Program creator ID

Responses

Response samples

Content type
application/json
{
  • "applied_to_be_mentee_text": "string",
  • "applied_to_be_mentor_text": "string",
  • "cover_picture": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "id": 0,
  • "manager_ids": 0,
  • "maximum_mentees": 0,
  • "mentee_label": "string",
  • "mentor_label": "string",
  • "mode": "string",
  • "name": "string",
  • "parent_type": "string",
  • "parent_id": 0,
  • "published_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Create a new relationship

Required parameters are:

  • program_id: ID of the program.
  • relationship[status]: Status of the relationship (pending, accepted, rejected, terminated).
  • relationship[mentee_id]: ID of the mentee.
  • relationship[mentor_id]: ID of the mentor.

Optional parameters are:

  • relationship[send_notification]: Boolean to enable automated email notifications (default: false).
  • relationship[application_message]: Message of the mentee application.
Request Body schema: application/x-www-form-urlencoded
required
program_id
required
integer <int32>

ID of the program

relationship[status]
required
string
Enum: "accepted" "pending" "rejected" "terminated"

Status of the relationship

relationship[mentee_id]
required
integer <int32>

ID of the mentee

relationship[mentor_id]
required
integer <int32>

ID of the mentor

relationship[send_notification]
boolean

Send automated email notifications

relationship[application_message]
string

Message of the mentee application

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "status": "string",
  • "ended_relationship_message": "string",
  • "application_message": "string",
  • "mentoring_program_id": 0,
  • "mentor_id": 0,
  • "mentee_id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "rejection_message": "string",
  • "status_transition_dates": { },
  • "mentor_user_id": 0,
  • "mentee_user_id": 0,
  • "mentor_name": "string",
  • "mentee_name": "string"
}

List of relationships

Get a paginated list of relationships.

Required parameters are:

  • program_id: ID of the program.

Optional parameters, in order to filter out, are:

  • filters[:statuses]: Status of the relationship.
query Parameters
page
integer <int32>
Default: 1

Page of results to fetch.

per_page
integer <int32>
Default: null

Number of results to return per page.

program_id
required
integer <int32>

ID of the program

filters[statuses][]
Array of strings
Items Enum: "accepted" "pending" "rejected" "terminated"

Status of the relationship

filters[mentee_id]
integer <int32>

ID of the associated mentee

filters[mentor_id]
integer <int32>

ID of the associated mentor

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "status": "string",
  • "ended_relationship_message": "string",
  • "application_message": "string",
  • "mentoring_program_id": 0,
  • "mentor_id": 0,
  • "mentee_id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "rejection_message": "string",
  • "status_transition_dates": { },
  • "mentor_user_id": 0,
  • "mentee_user_id": 0,
  • "mentor_name": "string",
  • "mentee_name": "string"
}

Get information on a relationship

Required parameters are:

  • program_id: ID of the program.
  • id: Unique ID of the mentor profile.
path Parameters
id
required
integer <int32>

ID of the relationship

query Parameters
program_id
required
integer <int32>

ID of the program

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "status": "string",
  • "ended_relationship_message": "string",
  • "application_message": "string",
  • "mentoring_program_id": 0,
  • "mentor_id": 0,
  • "mentee_id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "rejection_message": "string",
  • "status_transition_dates": { },
  • "mentor_user_id": 0,
  • "mentee_user_id": 0,
  • "mentor_name": "string",
  • "mentee_name": "string"
}

Update information of a specific relationship

Required parameters are:

  • program_id: ID of the program.
  • id: ID of the relationship
  • relationship[status]: Status of the relationship (pending, accepted, rejected, terminated). The transition from one status to another is specific. Allowed transitions are specified below.

Optional parameters are:

  • relationship[send_notification]: Boolean to enable automated email notifications (default: false).
  • relationship[status]: Status of the relationship (pending, accepted, rejected, terminated). The transition from one status to another is specific. Allowed transitions are specified below.
  • relationship[application_message]: Message of the mentee application (only for pending relationships).
  • relationship[ended_relationship_message]: Message of the ended relationship (only for terminated relationships).
  • relationship[rejection_message]: Message of the rejection (only for rejected relationships).

Allowed status transitions: User Match programs: * pending -> accepted, rejected, terminated * accepted -> terminated Admin Match programs: * accepted -> terminated * terminated -> accepted

path Parameters
id
required
integer <int32>

ID of the relationship

Request Body schema: application/x-www-form-urlencoded
required
program_id
required
integer <int32>

ID of the program

relationship[send_notification]
boolean

Send automated email notifications

relationship[status]
string
Enum: "accepted" "pending" "rejected" "terminated"

Status of the relationship

relationship[application_message]
string

Message of the mentee application

relationship[ended_relationship_message]
string

Message of the ended relationship

relationship[rejection_message]
string

Message of the rejection

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "status": "string",
  • "ended_relationship_message": "string",
  • "application_message": "string",
  • "mentoring_program_id": 0,
  • "mentor_id": 0,
  • "mentee_id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "rejection_message": "string",
  • "status_transition_dates": { },
  • "mentor_user_id": 0,
  • "mentee_user_id": 0,
  • "mentor_name": "string",
  • "mentee_name": "string"
}

Delete a relationship

Required parameters are:

  • program_id: ID of the program.
  • id: ID of the relationship to be deleted.
path Parameters
id
required
integer <int32>

ID of the relationship

query Parameters
program_id
required
integer <int32>

ID of the program

Responses

Create a new customizable attribute

Required parameters are:

  • program_id: ID of the program.
  • customizable_attribute[type]: Type of the customizable attribute. Can be one of the following: CustomizableAttribute::Boolean, CustomizableAttribute::Date, CustomizableAttribute::DoubleSelect, CustomizableAttribute::Number, CustomizableAttribute::Select, CustomizableAttribute::Text.
  • customizable_attribute[customizable_type]: Type of the customizable attribute. Can be one of the following: mentoring_program_mentee, mentoring_program_mentor.
  • customizable_attribute[display_name]: Display name of the customizable attribute.

Optional parameters are:

  • customizable_attribute[required]: Whether the customizable attribute is required or not.
  • customizable_attribute[placeholder]: Placeholder for the customizable attribute.
  • customizable_attribute[tooltip]: Tooltip for the customizable attribute.
  • customizable_attribute[config]: Configuration for the customizable attribute (Display options).
  • customizable_attribute[text_size]: For Text customizable attribute, the size of the text.
  • customizable_attribute[options]: For Select customizable attribute, the array of options.
  • customizable_attribute[multi]: For Select customizable attribute, whether it is multi select or not.
  • customizable_attribute[json_options]: For DoubleSelect customizable attribute, the json options. Format: { "options": { "option_1": ["sub_choice_1", "sub_choice_2"], "option_2": ["sub_choice_3", "sub_choice_4"]}, child_label: "Label for sub options"}.
Request Body schema: application/x-www-form-urlencoded
required
program_id
required
integer <int32>

ID of the program

customizable_attribute[type]
required
string
Enum: "CustomizableAttribute::Boolean" "CustomizableAttribute::Date" "CustomizableAttribute::DoubleSelect" "CustomizableAttribute::Number" "CustomizableAttribute::Select" "CustomizableAttribute::Text"

Type of the customizable attribute

customizable_attribute[customizable_type]
required
string
Enum: "mentoring_program_mentee" "mentoring_program_mentor"

Mentee or Mentor customizable attribute

customizable_attribute[display_name]
required
string

Name of the label

customizable_attribute[required]
boolean

Whether the customizable attribute is required or not

customizable_attribute[placeholder]
string

Placeholder for the customizable attribute

customizable_attribute[tooltip]
string

Tooltip for the customizable attribute

customizable_attribute[config][is_displayed_in_mentoring_card]
boolean

Whether the customizable attribute is displayed in the mentoring card

customizable_attribute[config][is_displayed_in_mentoring_form]
boolean

Whether the customizable attribute is displayed in the mentoring form

customizable_attribute[config][is_displayed_in_search_filters]
boolean

For Select customizable attribute. Whether the customizable attribute is displayed in the search filters

customizable_attribute[text_size]
integer <int32>

For Text customizable attribute, the size of the text (optional)

customizable_attribute[options][]
Array of strings

For Select customizable attribute, the array of options (required if type is select)

customizable_attribute[multi]
boolean

For Select customizable attribute, whether it is multi select or not (optional)

customizable_attribute[json_options]
json

For DoubleSelect customizable attribute, the json options (required if type is double_select)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "customizable_id": 0,
  • "type": "CustomizableAttribute::Boolean",
  • "customizable_type": "bizopp",
  • "name": "string",
  • "display_name": "string",
  • "tooltip": "string",
  • "placeholder": "string",
  • "multi": true,
  • "text_size": 0,
  • "visibility": "admin_only",
  • "user_editable": true,
  • "required": true,
  • "options": [
    ],
  • "json_options": { },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "selected_value": "string"
}

List of customizable attributes

Get a paginated list of customizable attributes.

Required parameters are:

  • program_id: ID of the program.
  • customizable_attribute[profile_type]: Type of the customizable attribute. Can be one of the following: CustomizableAttribute::Boolean, CustomizableAttribute::Date, CustomizableAttribute::DoubleSelect, CustomizableAttribute::Number, CustomizableAttribute::Select, CustomizableAttribute::Text.
query Parameters
page
integer <int32>
Default: 1

Page of results to fetch.

per_page
integer <int32>
Default: null

Number of results to return per page.

program_id
required
integer <int32>

ID of the program

customizable_attribute[profile_type]
string
Enum: "mentor_customizable_attributes" "mentee_customizable_attributes"

Mentee or Mentor customizable attributes

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "customizable_id": 0,
  • "type": "CustomizableAttribute::Boolean",
  • "customizable_type": "bizopp",
  • "name": "string",
  • "display_name": "string",
  • "tooltip": "string",
  • "placeholder": "string",
  • "multi": true,
  • "text_size": 0,
  • "visibility": "admin_only",
  • "user_editable": true,
  • "required": true,
  • "options": [
    ],
  • "json_options": { },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "selected_value": "string"
}

Update information of a specific customizable attribute

Required parameters are:

  • id: ID of the customizable attribute.
  • program_id: ID of the program.

Optional parameters are:

  • customizable_attribute[display_name]: Display name of the customizable attribute.
  • customizable_attribute[required]: Whether the customizable attribute is required or not.
  • customizable_attribute[placeholder]: Placeholder for the customizable attribute.
  • customizable_attribute[tooltip]: Tooltip for the customizable attribute.
  • customizable_attribute[config]: Configuration for the customizable attribute (Display options).
  • customizable_attribute[text_size]: For Text customizable attribute, the size of the text.
  • customizable_attribute[options]: For Select customizable attribute, the array of options.
  • customizable_attribute[multi]: For Select customizable attribute, whether it is multi select or not.
  • customizable_attribute[json_options]: For DoubleSelect customizable attribute, the json options. Format: { "options": { "option_1": ["sub_choice_1", "sub_choice_2"], "option_2": ["sub_choice_3", "sub_choice_4"]}, child_label: "Label for sub options"}.
path Parameters
id
required
integer <int32>

ID of the customizable attribute

Request Body schema: application/x-www-form-urlencoded
required
program_id
required
integer <int32>

ID of the program

customizable_attribute[display_name]
string

Name of the label

customizable_attribute[required]
boolean

Whether the customizable attribute is required or not

customizable_attribute[placeholder]
string

Placeholder for the customizable attribute

customizable_attribute[tooltip]
string

Tooltip for the customizable attribute

customizable_attribute[config][is_displayed_in_mentoring_card]
boolean

Whether the customizable attribute is displayed in the mentoring card

customizable_attribute[config][is_displayed_in_mentoring_form]
boolean

Whether the customizable attribute is displayed in the mentoring form

customizable_attribute[config][is_displayed_in_search_filterslti]
boolean

For Select customizable attribute. Whether the customizable attribute is displayed in the search filters

customizable_attribute[text_size]
integer <int32>

For Text customizable attribute, the size of the text

customizable_attribute[options][]
Array of strings

For Select customizable attribute, the array of options

customizable_attribute[multi]
boolean

For Select customizable attribute, whether it is multi select or not

customizable_attribute[json_options]
json

For DoubleSelect customizable attribute, the json options

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "customizable_id": 0,
  • "type": "CustomizableAttribute::Boolean",
  • "customizable_type": "bizopp",
  • "name": "string",
  • "display_name": "string",
  • "tooltip": "string",
  • "placeholder": "string",
  • "multi": true,
  • "text_size": 0,
  • "visibility": "admin_only",
  • "user_editable": true,
  • "required": true,
  • "options": [
    ],
  • "json_options": { },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "selected_value": "string"
}

Delete a customizable attribute

Required parameters are:

  • id: ID of the customizable attribute.
  • program_id: ID of the program.
path Parameters
id
required
integer <int32>

ID of the customizable attribute

query Parameters
program_id
required
integer <int32>

ID of the program

Responses

order_management

Operations about order_managements

Manual Transaction Creation

Create a new Manual Transaction

Required parameters are :

  • Subscription Id,
  • price,
  • payment_method_type,
  • currency_id,
Request Body schema: application/x-www-form-urlencoded
required
manual_transaction[subscription_id]
required
integer <int32>
manual_transaction[price]
required
integer <int32>
manual_transaction[payment_method_type]
required
string
manual_transaction[currency_id]
required
integer <int32>
manual_transaction[notes]
string
manual_transaction[date]
string <date-time>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "total_in_cents": 0,
  • "notes": "string",
  • "status": "string",
  • "currency": "string",
  • "parent": {
    },
  • "date": "2019-08-24T14:15:22Z",
  • "payment_method_type": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Manual Transaction Update

Update a Manual Transaction

Required parameters are :

  • Manual Transaction Id
path Parameters
id
required
integer <int32>
Request Body schema: application/x-www-form-urlencoded
required
manual_transaction[manual_transaction_id]
required
integer <int32>
manual_transaction[price]
integer <int32>
manual_transaction[payment_method_type]
string
manual_transaction[currency_id]
integer <int32>
manual_transaction[notes]
string
manual_transaction[date]
string <date-time>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "total_in_cents": 0,
  • "notes": "string",
  • "status": "string",
  • "currency": "string",
  • "parent": {
    },
  • "date": "2019-08-24T14:15:22Z",
  • "payment_method_type": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Manual Transaction Deletion

Destroy a Manual Transaction

Required parameters are :

  • Manual Transaction Id,
path Parameters
id
required
integer <int32>
query Parameters
manual_transaction_id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "total_in_cents": 0,
  • "notes": "string",
  • "status": "string",
  • "currency": "string",
  • "parent": {
    },
  • "date": "2019-08-24T14:15:22Z",
  • "payment_method_type": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

email_analytics_v2

Operations about email_analytics_v2s

List of Email Analytics Deliveries v2

Get a paginated list of Email Analytics Deliveries

Pagination information are stored in the response header as defined by RFC-5988

http://tools.ietf.org/html/rfc5988

Example:

{
  "link": "<https://hivebrite.com/api/admin/v3/email_analytics_v2/deliveries?page=1&per_page=30>; rel=\"first\", <https://hivebrite.com/api/admin/v3/email_analytics_v2/deliveries?page=3&per_page=30>; rel=\"prev\"",
  "x-per-page": "30",
  "x-page": "4"
}

Use the user_id option filtering to get email analytics deliveries from a certain user.

Use the start_date filtering to get email analytics deliveries from a certain date.

Use the end_date filtering to get email analytics deliveries until a certain date.

Use the status filtering option to get email analytics deliveries from emails with a certain status (sent, delivered, opened, bounced, dropped, clicked).

Use the subject filtering option to get email analytics from email campaigns with a certain subject. (Only for email campaigns)

Use the campaign_id filtering option to get email analytics deliveries from email campaigns with a certain ID. (Only for email campaigns)

query Parameters
start_date
string <date-time>
end_date
string <date-time>
user_id
integer <int32>
page
integer <int32>
Default: 1
per_page
integer <int32> [ 5 .. 30 ]
Default: 20
email
string
user_type
string
subject
string
campaign_id
integer <int32>
status
string
Enum: "sent" "delivered" "opened" "clicked" "bounced" "dropped" "spam_reported"

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "email": "string",
  • "user_type": 0,
  • "user_id": 0,
  • "subject": "string",
  • "campaign_id": 0,
  • "sent_at": "2019-08-24T14:15:22Z",
  • "delivered_at": "2019-08-24T14:15:22Z",
  • "opened_at": "2019-08-24T14:15:22Z",
  • "clicked_at": "2019-08-24T14:15:22Z",
  • "bounced_at": "2019-08-24T14:15:22Z",
  • "dropped_at": "2019-08-24T14:15:22Z",
  • "spam_reported_at": "2019-08-24T14:15:22Z"
}

forums

Operations about forums

Create a new forum discussion

This endpoint creates a new forum discussion.

Mandatory parameters

user_id, the user ID which can be found in the BO or through the API User endpoint.

title, the title of the discussion, up to 255 characters.

content, the HTML content of the discussion.

Optional parameters

external_id, the external identifier for forum discussions from imported data or third-party systems.

pinned_on_index_page, to pin the discussion on index page (default: false).

cover_picture, to add a cover picture to the discussion.

storage_attachments to add attachments to the discussion.

category_ids to attach the discussion to the specified categories.

topic_id to add the discussion to a group (default: the discussion will be attached to the network).

feedable_at to choose the publication date of the discussion (it impacts the sorting on the index page).

embed_options to select which association will be embedded in the response body.

Use embed_options as such:

embed_options[embed_likes]: true to embed the number of likes.

embed_options[embed_comments]: true to embed the number of comments.

embed_options[embed_user]: true to embed the information about the user who created the discussion.

embed_options[embed_stripped_content]: true to display the line breaks in the content.

embed_options[embed_categories]: true to embed the categories associated to the discussion.

embed_options[embed_attachments]: true to embed the attachments and uploads of the discussion.

Request Body schema: application/x-www-form-urlencoded
required
user_id
required
integer <int32>

User ID

title
required
string

Title of the discussion

content
required
string

HTML content of the discussion

external_id
string

External identifier for forum discussions from imported data or third-party systems

pinned_on_index_page
boolean

Whether or not the discussion should be pinned on the index page

cover_picture
string <binary>

Direct upload of the picture which will serve as a cover for the discussion

storage_attachments[]
Array of file

Direct upload of several files which will be attached to the discussion

category_ids[]
Array of strings

List of category IDs

topic_id
integer <int32>

ID of the related group if it's not a network discussion

feedable_at
string <date-time>

Datetime of the publication

embed_options[embed_likes]
boolean
embed_options[embed_comments]
boolean
embed_options[embed_user]
boolean
embed_options[embed_stripped_content]
boolean
embed_options[embed_categories]
boolean
embed_options[embed_attachments]
boolean

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "external_id": "string",
  • "title": "string",
  • "content": "string",
  • "pinned_on_index_page": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "user_id": 0,
  • "feedable_at": "2019-08-24T14:15:22Z",
  • "categories": [
    ],
  • "comments_count": 0,
  • "likes_count": 0,
  • "cover_picture_url": "string",
  • "storage_attachments": "string",
  • "storage_uploads": "string",
  • "user": {
    }
}

List forum discussions

This endpoint lists forum discussions.

Optional parameters

topic_id, to list discussion of a specific group (default: when empty, the discussions from the network will be listed).

external_id, to get one discussion from a specific external identifier.

page, the current page (defaut: first page).

per_page, the number of items to display per page (default: 10)

sort_by, the way to sort between popularity, updated_at, and created_at (default: created_at).

order, the direction to order between asc and desc.

keyword, a keyword the title or content should contain.

category_ids, the categories the discussions should be associated to.

pinned_on_index_page, to filter discussions pinned on the index page (default: both).

embed_options, to select which association will be embedded in the response body.

Use embed_options as such:

embed_options[embed_likes]: true to embed the number of likes.

embed_options[embed_comments]: true to embed the number of comments.

embed_options[embed_user]: true to embed the information about the user who created the discussion.

embed_options[embed_stripped_content]: true to display the line breaks in the content.

embed_options[embed_categories]: true to embed the categories associated to the discussion.

embed_options[embed_attachments]: true to embed the attachments and uploads of the discussion.

query Parameters
topic_id
integer <int32>

ID of the group

external_id
string

External identifier for forum discussions from imported data or third-party systems

page
integer <int32>

Page number (default: 1)

per_page
integer <int32>

Results per page (default: 10)

sort_by
string
Enum: "popularity" "updated_at" "created_at"

Way to sort

order
string
Enum: "asc" "desc"

Direction to sort

keyword
string

Keyword contained in the title or the content

category_ids[]
Array of strings

List of category IDs

pinned_on_index_page
boolean

Whether the discussions are pinned on the index page or not

embed_options[embed_likes]
boolean
embed_options[embed_comments]
boolean
embed_options[embed_user]
boolean
embed_options[embed_stripped_content]
boolean
embed_options[embed_categories]
boolean
embed_options[embed_attachments]
boolean

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "external_id": "string",
  • "title": "string",
  • "content": "string",
  • "pinned_on_index_page": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "user_id": 0,
  • "feedable_at": "2019-08-24T14:15:22Z",
  • "categories": [
    ],
  • "comments_count": 0,
  • "likes_count": 0,
  • "cover_picture_url": "string",
  • "storage_attachments": "string",
  • "storage_uploads": "string",
  • "user": {
    }
}

Delete a forum discussion

This endpoint deletes a forum discussion.

Mandatory parameter

id, the ID of the discussion to delete

query Parameters
id
required
integer <int32>

ID of the discussion to delete

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "errors": "string"
}

Show a forum discussion

This endpoint display one forum discussion.

Mandatory parameter

id, the ID of the discussion to show.

Optional parameter

embed_options, to select which association will be embedded in the response body.

Use embed_options as such:

embed_options[embed_likes]: true to embed the number of likes.

embed_options[embed_comments]: true to embed the number of comments.

embed_options[embed_user]: true to embed the information about the user who created the discussion.

embed_options[embed_stripped_content]: true to display the line breaks in the content.

embed_options[embed_categories]: true to embed the categories associated to the discussion.

embed_options[embed_attachments]: true to embed the attachments and uploads of the discussion.

path Parameters
id
required
integer <int32>

ID of the discussion to show

query Parameters
embed_options[embed_likes]
boolean
embed_options[embed_comments]
boolean
embed_options[embed_user]
boolean
embed_options[embed_stripped_content]
boolean
embed_options[embed_categories]
boolean
embed_options[embed_attachments]
boolean

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "external_id": "string",
  • "title": "string",
  • "content": "string",
  • "pinned_on_index_page": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "user_id": 0,
  • "feedable_at": "2019-08-24T14:15:22Z",
  • "categories": [
    ],
  • "comments_count": 0,
  • "likes_count": 0,
  • "cover_picture_url": "string",
  • "storage_attachments": "string",
  • "storage_uploads": "string",
  • "user": {
    }
}

Update a forum discussion

This endpoint updates an existing forum discussion.

Mandatory parameter

id, the ID of the discussion to update.

Optional parameters

title, the title of the discussion, up to 255 characters.

content, the HTML content of the discussion.

external_id, the external identifier for forum discussions from imported data or third-party systems.

pinned_on_index_page, to pin the discussion on index page (default: false).

cover_picture, to add a cover picture to the discussion.

storage_attachments to add attachments to the discussion.

category_ids to attach the discussion to the specified categories.

feedable_at to choose the publication date of the discussion (it impacts the sorting on the index page).

embed_options to select which association will be embedded in the response body.

Use embed_options as such:

embed_options[embed_likes]: true to embed the number of likes.

embed_options[embed_comments]: true to embed the number of comments.

embed_options[embed_user]: true to embed the information about the user who created the discussion.

embed_options[embed_stripped_content]: true to display the line breaks in the content.

embed_options[embed_categories]: true to embed the categories associated to the discussion.

embed_options[embed_attachments]: true to embed the attachments and uploads of the discussion.

path Parameters
id
required
integer <int32>

ID of the discussion to update

Request Body schema: application/x-www-form-urlencoded
title
string

Title of the discussion

content
string

HTML content of the discussion

external_id
string

External identifier for forum discussions from imported data or third-party systems

pinned_on_index_page
boolean

Whether or not the discussion should be pinned on the index page

cover_picture
string <binary>

Direct upload of the picture which will serve as a cover for the discussion

storage_attachments[]
Array of file

Direct upload of several files which will be attached to the discussion

category_ids[]
Array of strings

List of category IDs

feedable_at
string <date-time>

Datetime of the publication

embed_options[embed_likes]
boolean
embed_options[embed_comments]
boolean
embed_options[embed_user]
boolean
embed_options[embed_stripped_content]
boolean
embed_options[embed_categories]
boolean
embed_options[embed_attachments]
boolean

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "external_id": "string",
  • "title": "string",
  • "content": "string",
  • "pinned_on_index_page": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "user_id": 0,
  • "feedable_at": "2019-08-24T14:15:22Z",
  • "categories": [
    ],
  • "comments_count": 0,
  • "likes_count": 0,
  • "cover_picture_url": "string",
  • "storage_attachments": "string",
  • "storage_uploads": "string",
  • "user": {
    }
}

notifications

Operations about notifications

Get a list of notifications

This endpoint returns a list of notifications for every users.

Pagination information are stored in the response header as defined by RFC-5988 http://tools.ietf.org/html/rfc5988

By default, retrieves all existing notifications

Use the updated_since option to filter notifications by the datetime they were last updated (e.g. updated_since=2017-08-01T00:00:00).

Use the type option to filter notifications by the target they were created for (default: user, e.g. type=user).

query Parameters
updated_since
string <date-time>

Datetime notification was last updated

type
string
Default: "user"
Enum: "user" "admin"

Notification target

page
integer <int32>
Default: 1

Page of results to fetch.

per_page
integer <int32> [ 0 .. 30 ]
Default: 10

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "url": "string",
  • "notified_type": "User",
  • "notified_id": 0,
  • "notification_type": "comment",
  • "notifier": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

sub_networks

Operations about sub_networks

List of Clusters

Returns a list of clusters for your network.

Optional Parameters

  • title - Filter by cluster title.
query Parameters
title
string

Cluster title

page
integer <int32>
Default: 1

Page of results to fetch.

per_page
integer <int32>
Default: null

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "title": "string"
}

user_data_fields

Operations about user_data_fields

Get user data fields

This endpoint returns information about all user data available fields on the user profile for a specific network (excluding the user's membership status, experiences and educations).

Returns both predefined fields (firstname, lastname...) and custom fields created by the network admin.

For each field, the response includes:

  • Name: Field identifier (column name for predefined fields, custom name for custom fields)
  • Display name: The customizable display name as configured by the network admin
  • Type: The field type (string, boolean, date, select, relation, attachment)
  • Options: Available options for select fields or validation constraints
  • Customizable: Boolean indicating whether this is a custom field (true) or predefined field (false)
  • Multiple options allowed: Boolean indicating whether this field allows multiple options to be selected (true) or not (false)
  • Created at / Updated at: Timestamps for custom fields (null for predefined fields)

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "display_name": "string",
  • "type": "string",
  • "options": "string",
  • "customizable": true,
  • "read_only": true,
  • "multiple_options_allowed": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}