Hivebrite Admin API
API Endpoint
https://example.org/apiHere 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 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
POST /api/oauth/token
Requests
Body
{
"grant_type": "Hello, world!",
"scope": "Hello, world!",
"admin_email": "Hello, world!",
"password": "Hello, world!",
"client_id": "Hello, world!",
"client_secret": "Hello, world!",
"refresh_token": "Hello, world!",
"redirect_uri": "Hello, world!"
}Schema
{
"type": "object",
"properties": {
"grant_type": {
"type": "string"
},
"scope": {
"type": "string"
},
"admin_email": {
"type": "string"
},
"password": {
"type": "string"
},
"client_id": {
"type": "string"
},
"client_secret": {
"type": "string"
},
"refresh_token": {
"type": "string"
},
"redirect_uri": {
"type": "string",
"default": "urn:ietf:wg:oauth:2.0:oob"
}
},
"required": [
"grant_type",
"scope"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
OAuth2 Authentication
OAuth2 AuthenticationPOST/api/oauth/token
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
donations ¶
Operations about donations
GET /api/admin/v2/donations/funds?updated_since=
Responses
List of Funds for Donations
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Fund ID"
},
"external_id": {
"type": "string",
"description": "Fund External ID"
},
"title": {
"type": "string",
"description": "Title of the Donation Fund"
},
"description": {
"type": "string",
"description": "Description of the Donation Fund"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Donation Fund creation date - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Donation Fund update date - iso8601"
},
"discarded_at": {
"type": "string",
"format": "date-time",
"description": "Donation Fund deletion date - iso8601"
},
"start_date": {
"type": "string",
"format": "date-time",
"description": "Period of availability of the Fund (start) - iso8601"
},
"end_date": {
"type": "string",
"format": "date-time",
"description": "Period of availability of the Fund (end) - iso8601"
},
"campaign_ids": {
"type": "integer",
"format": "int32",
"description": "Donation Campaigns associated to this Donation Fund"
},
"network_category_id": {
"type": "integer",
"format": "int32",
"description": "Network Category associated to this Donation Fund"
},
"payment_account_id": {
"type": "integer",
"format": "int32",
"description": "Payment Account associated to this Donation Fund"
}
},
"description": "FundEntity model"
}List of Funds for DonationsGET/api/admin/v2/donations/funds{?updated_since}
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"
}URI Parameters
- updated_since
string(required)
POST /api/admin/v2/donations/funds
Requests
Body
{
"fund[external_id]": "Hello, world!",
"fund[title]": "Hello, world!",
"fund[description]": "Hello, world!",
"fund[start_date]": "Hello, world!",
"fund[end_date]": "Hello, world!",
"fund[campaign_ids][]": [
1
],
"fund[network_category_id]": 1,
"fund[payment_account_id]": 1
}Schema
{
"type": "object",
"properties": {
"fund[external_id]": {
"type": "string",
"description": "Fund External ID"
},
"fund[title]": {
"type": "string",
"description": "Title of the Donation Fund"
},
"fund[description]": {
"type": "string",
"description": "Description of the Donation Fund"
},
"fund[start_date]": {
"type": "string",
"description": "Period of availability of the Fund (start) - iso8601"
},
"fund[end_date]": {
"type": "string",
"description": "Period of availability of the Fund (end) - iso8601"
},
"fund[campaign_ids][]": {
"type": "array",
"items": {
"type": "number"
},
"description": "Donation Campaigns associated to this Donation Fund"
},
"fund[network_category_id]": {
"type": "number",
"description": "Network Category associated to this Donation Fund"
},
"fund[payment_account_id]": {
"type": "number",
"description": "Payment Account associated to this Donation Fund"
}
},
"required": [
"fund[title]",
"fund[description]"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Create a Donation fund
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Fund ID"
},
"external_id": {
"type": "string",
"description": "Fund External ID"
},
"title": {
"type": "string",
"description": "Title of the Donation Fund"
},
"description": {
"type": "string",
"description": "Description of the Donation Fund"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Donation Fund creation date - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Donation Fund update date - iso8601"
},
"discarded_at": {
"type": "string",
"format": "date-time",
"description": "Donation Fund deletion date - iso8601"
},
"start_date": {
"type": "string",
"format": "date-time",
"description": "Period of availability of the Fund (start) - iso8601"
},
"end_date": {
"type": "string",
"format": "date-time",
"description": "Period of availability of the Fund (end) - iso8601"
},
"campaign_ids": {
"type": "integer",
"format": "int32",
"description": "Donation Campaigns associated to this Donation Fund"
},
"network_category_id": {
"type": "integer",
"format": "int32",
"description": "Network Category associated to this Donation Fund"
},
"payment_account_id": {
"type": "integer",
"format": "int32",
"description": "Payment Account associated to this Donation Fund"
}
},
"description": "FundEntity model"
}Create a Donation fundPOST/api/admin/v2/donations/funds
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_dateandend_dateattributes.
GET /api/admin/v2/donations/funds/id
Responses
Get a Fund information
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Fund ID"
},
"external_id": {
"type": "string",
"description": "Fund External ID"
},
"title": {
"type": "string",
"description": "Title of the Donation Fund"
},
"description": {
"type": "string",
"description": "Description of the Donation Fund"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Donation Fund creation date - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Donation Fund update date - iso8601"
},
"discarded_at": {
"type": "string",
"format": "date-time",
"description": "Donation Fund deletion date - iso8601"
},
"start_date": {
"type": "string",
"format": "date-time",
"description": "Period of availability of the Fund (start) - iso8601"
},
"end_date": {
"type": "string",
"format": "date-time",
"description": "Period of availability of the Fund (end) - iso8601"
},
"campaign_ids": {
"type": "integer",
"format": "int32",
"description": "Donation Campaigns associated to this Donation Fund"
},
"network_category_id": {
"type": "integer",
"format": "int32",
"description": "Network Category associated to this Donation Fund"
},
"payment_account_id": {
"type": "integer",
"format": "int32",
"description": "Payment Account associated to this Donation Fund"
}
},
"description": "FundEntity model"
}Get a Fund informationGET/api/admin/v2/donations/funds/{id}
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.
URI Parameters
- id
number(required)
DELETE /api/admin/v2/donations/funds/id
Responses
Delete a donation fund
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Fund ID"
},
"external_id": {
"type": "string",
"description": "Fund External ID"
},
"title": {
"type": "string",
"description": "Title of the Donation Fund"
},
"description": {
"type": "string",
"description": "Description of the Donation Fund"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Donation Fund creation date - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Donation Fund update date - iso8601"
},
"discarded_at": {
"type": "string",
"format": "date-time",
"description": "Donation Fund deletion date - iso8601"
},
"start_date": {
"type": "string",
"format": "date-time",
"description": "Period of availability of the Fund (start) - iso8601"
},
"end_date": {
"type": "string",
"format": "date-time",
"description": "Period of availability of the Fund (end) - iso8601"
},
"campaign_ids": {
"type": "integer",
"format": "int32",
"description": "Donation Campaigns associated to this Donation Fund"
},
"network_category_id": {
"type": "integer",
"format": "int32",
"description": "Network Category associated to this Donation Fund"
},
"payment_account_id": {
"type": "integer",
"format": "int32",
"description": "Payment Account associated to this Donation Fund"
}
},
"description": "FundEntity model"
}Delete a donation fundDELETE/api/admin/v2/donations/funds/{id}
Delete a Donation Fund
Will delete the donation Fund. Will be removed from the Donation Campaigns associated.
URI Parameters
- id
number(required)
PUT /api/admin/v2/donations/funds/id
Requests
Body
{
"fund[external_id]": "Hello, world!",
"fund[title]": "Hello, world!",
"fund[description]": "Hello, world!",
"fund[start_date]": "Hello, world!",
"fund[end_date]": "Hello, world!",
"fund[campaign_ids][]": [
1
],
"fund[network_category_id]": 1,
"fund[payment_account_id]": 1
}Schema
{
"type": "object",
"properties": {
"fund[external_id]": {
"type": "string",
"description": "Fund External ID"
},
"fund[title]": {
"type": "string",
"description": "Title of the Donation Fund"
},
"fund[description]": {
"type": "string",
"description": "Description of the Donation Fund"
},
"fund[start_date]": {
"type": "string",
"description": "Period of availability of the Fund (start) - iso8601"
},
"fund[end_date]": {
"type": "string",
"description": "Period of availability of the Fund (end) - iso8601"
},
"fund[campaign_ids][]": {
"type": "array",
"items": {
"type": "number"
},
"description": "Donation Campaigns associated to this Donation Fund"
},
"fund[network_category_id]": {
"type": "number",
"description": "Network Category associated to this Donation Fund"
},
"fund[payment_account_id]": {
"type": "number",
"description": "Payment Account associated to this Donation Fund"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Update an existing Donation fund
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Fund ID"
},
"external_id": {
"type": "string",
"description": "Fund External ID"
},
"title": {
"type": "string",
"description": "Title of the Donation Fund"
},
"description": {
"type": "string",
"description": "Description of the Donation Fund"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Donation Fund creation date - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Donation Fund update date - iso8601"
},
"discarded_at": {
"type": "string",
"format": "date-time",
"description": "Donation Fund deletion date - iso8601"
},
"start_date": {
"type": "string",
"format": "date-time",
"description": "Period of availability of the Fund (start) - iso8601"
},
"end_date": {
"type": "string",
"format": "date-time",
"description": "Period of availability of the Fund (end) - iso8601"
},
"campaign_ids": {
"type": "integer",
"format": "int32",
"description": "Donation Campaigns associated to this Donation Fund"
},
"network_category_id": {
"type": "integer",
"format": "int32",
"description": "Network Category associated to this Donation Fund"
},
"payment_account_id": {
"type": "integer",
"format": "int32",
"description": "Payment Account associated to this Donation Fund"
}
},
"description": "FundEntity model"
}Update an existing Donation fundPUT/api/admin/v2/donations/funds/{id}
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.
URI Parameters
- id
number(required)ID of the fund
POST /api/admin/v2/donations/campaigns/customizable_attributes
Requests
Body
{
"customizable_attribute[type]": "Hello, world!",
"customizable_attribute[display_name]": "Hello, world!",
"customizable_attribute[text_size]": 1,
"customizable_attribute[tooltip]": "Hello, world!",
"customizable_attribute[placeholder]": "Hello, world!",
"customizable_attribute[visibility]": "Hello, world!",
"customizable_attribute[required]": true,
"customizable_attribute[selected_value]": "Hello, world!"
}Schema
{
"type": "object",
"properties": {
"customizable_attribute[type]": {
"type": "string"
},
"customizable_attribute[display_name]": {
"type": "string"
},
"customizable_attribute[text_size]": {
"type": "number"
},
"customizable_attribute[tooltip]": {
"type": "string",
"description": "Customizable Attribute tooltip"
},
"customizable_attribute[placeholder]": {
"type": "string",
"description": "Customizable Attribute placeholder"
},
"customizable_attribute[visibility]": {
"type": "string",
"description": "Customizable Attribute visibility"
},
"customizable_attribute[required]": {
"type": "boolean",
"description": "Customizable Attribute required ?"
},
"customizable_attribute[selected_value]": {
"type": "string",
"description": "Customizable Attribute selected value"
}
},
"required": [
"customizable_attribute[type]",
"customizable_attribute[display_name]"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Customizable Attribute Creation
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"customizable_id": {
"type": "integer",
"format": "int32",
"description": "Customizable ID"
},
"type": {
"type": "string",
"enum": [
"CustomizableAttribute::Boolean",
"CustomizableAttribute::Date",
"CustomizableAttribute::DoubleSelect",
"CustomizableAttribute::Number",
"CustomizableAttribute::Select",
"CustomizableAttribute::Text"
],
"description": "Customizable Attribute type"
},
"customizable_type": {
"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",
"mentorships",
"mentorships_mentee",
"mentorships_mentor",
"ne_event",
"ne_ticket",
"topic_approval",
"topic_mentorships",
"topic_mentorships_mentee",
"topic_mentorships_mentor",
"user",
"ventures_venture"
],
"description": "Customizable Attribute associated model (User, Experience)"
},
"name": {
"type": "string",
"description": "Customizable Attribute name"
},
"display_name": {
"type": "string",
"description": "Customizable Attribute displayed name"
},
"tooltip": {
"type": "string",
"description": "Customizable Attribute tooltip"
},
"placeholder": {
"type": "string",
"description": "Customizable Attribute placeholder"
},
"multi": {
"type": "boolean",
"description": "Customizable Attribute multi activated ?"
},
"text_size": {
"type": "integer",
"format": "int32",
"description": "Customizable Attribute text_size"
},
"visibility": {
"type": "string",
"enum": [
"admin_only",
"tagged_user",
"everybody",
"not_visible"
],
"description": "Customizable Attribute visibility"
},
"user_editable": {
"type": "boolean",
"description": "Customizable Attribute editable by the user ?"
},
"required": {
"type": "boolean",
"description": "Customizable Attribute required ?"
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "Customizable Attribute array of options"
},
"json_options": {
"type": "object",
"description": "Customizable Attribute json options (for double select)"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Customizable Attribute creation date"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Customizable Attribute last update date"
},
"selected_value": {
"type": "string",
"description": "Customizable Attribute selected value"
}
},
"description": "CustomizableAttribute model"
}Customizable Attribute CreationPOST/api/admin/v2/donations/campaigns/customizable_attributes
Customizable Attribute creation for Donation Campaign
Required params are :
a Type,
a Display name
PUT /api/admin/v2/donations/campaigns/customizable_attributes/id
Requests
Body
{
"customizable_attribute[display_name]": "Hello, world!",
"customizable_attribute[tooltip]": "Hello, world!",
"customizable_attribute[placeholder]": "Hello, world!",
"customizable_attribute[multi]": true,
"customizable_attribute[text_size]": 1,
"customizable_attribute[visibility]": "Hello, world!",
"customizable_attribute[required]": true,
"customizable_attribute[selected_value]": "Hello, world!"
}Schema
{
"type": "object",
"properties": {
"customizable_attribute[display_name]": {
"type": "string",
"description": "Customizable Attribute displayed name"
},
"customizable_attribute[tooltip]": {
"type": "string",
"description": "Customizable Attribute tooltip"
},
"customizable_attribute[placeholder]": {
"type": "string",
"description": "Customizable Attribute placeholder"
},
"customizable_attribute[multi]": {
"type": "boolean",
"description": "Customizable Attribute multi activated ?"
},
"customizable_attribute[text_size]": {
"type": "number",
"description": "Customizable Attribute text_size"
},
"customizable_attribute[visibility]": {
"type": "string",
"description": "Customizable Attribute visibility"
},
"customizable_attribute[required]": {
"type": "boolean",
"description": "Customizable Attribute required ?"
},
"customizable_attribute[selected_value]": {
"type": "string",
"description": "Customizable Attribute selected value"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Customizable Attribute Update
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"customizable_id": {
"type": "integer",
"format": "int32",
"description": "Customizable ID"
},
"type": {
"type": "string",
"enum": [
"CustomizableAttribute::Boolean",
"CustomizableAttribute::Date",
"CustomizableAttribute::DoubleSelect",
"CustomizableAttribute::Number",
"CustomizableAttribute::Select",
"CustomizableAttribute::Text"
],
"description": "Customizable Attribute type"
},
"customizable_type": {
"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",
"mentorships",
"mentorships_mentee",
"mentorships_mentor",
"ne_event",
"ne_ticket",
"topic_approval",
"topic_mentorships",
"topic_mentorships_mentee",
"topic_mentorships_mentor",
"user",
"ventures_venture"
],
"description": "Customizable Attribute associated model (User, Experience)"
},
"name": {
"type": "string",
"description": "Customizable Attribute name"
},
"display_name": {
"type": "string",
"description": "Customizable Attribute displayed name"
},
"tooltip": {
"type": "string",
"description": "Customizable Attribute tooltip"
},
"placeholder": {
"type": "string",
"description": "Customizable Attribute placeholder"
},
"multi": {
"type": "boolean",
"description": "Customizable Attribute multi activated ?"
},
"text_size": {
"type": "integer",
"format": "int32",
"description": "Customizable Attribute text_size"
},
"visibility": {
"type": "string",
"enum": [
"admin_only",
"tagged_user",
"everybody",
"not_visible"
],
"description": "Customizable Attribute visibility"
},
"user_editable": {
"type": "boolean",
"description": "Customizable Attribute editable by the user ?"
},
"required": {
"type": "boolean",
"description": "Customizable Attribute required ?"
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "Customizable Attribute array of options"
},
"json_options": {
"type": "object",
"description": "Customizable Attribute json options (for double select)"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Customizable Attribute creation date"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Customizable Attribute last update date"
},
"selected_value": {
"type": "string",
"description": "Customizable Attribute selected value"
}
},
"description": "CustomizableAttribute model"
}Customizable Attribute UpdatePUT/api/admin/v2/donations/campaigns/customizable_attributes/{id}
Update a customizable attribute
The customizable attribute can be retrieved on the /api/admin/v1/settings/customizable_attributes endpoint.
URI Parameters
- id
string(required)
DELETE /api/admin/v2/donations/campaigns/customizable_attributes/id
Responses
Customizable Attribute Deletion
Customizable Attribute DeletionDELETE/api/admin/v2/donations/campaigns/customizable_attributes/{id}
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.
URI Parameters
- id
string(required)
GET /api/admin/v2/donations/campaigns?updated_since=
Responses
List of Donations Campaigns
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Campaign ID"
},
"title": {
"type": "string",
"description": "Title of the Campaign"
},
"description": {
"type": "string",
"description": "Description of the Campaign"
},
"slug": {
"type": "string",
"description": "Slug to access this Campaign"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Campaign creation date - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Campaign update date - iso8601"
},
"discarded_at": {
"type": "string",
"format": "date-time",
"description": "Campaign deletion date - iso8601"
},
"background_image": {
"type": "string",
"description": "URL of the background image of the Campaign"
},
"card_image": {
"type": "string",
"description": "URL of the card image of the Campaign"
},
"currency": {
"type": "string",
"description": "ISO code of the Currency of this Campaign"
},
"goal_amount": {
"type": "number",
"format": "float",
"description": "Goal amount for this Campaign"
},
"minimum_amount": {
"type": "number",
"format": "float",
"description": "Minimum amount allowed for this Campaign"
},
"amounts": {
"type": "number",
"format": "float",
"description": "Pre defined amounts defined for this Campaign (must be more than two elements)"
},
"enable_dedication": {
"type": "boolean",
"description": "Donors to this campaign can dedicate their Donation?"
},
"recurring_mode": {
"type": "string",
"enum": [
"no_recurring",
"simple_recurring",
"advanced_recurring"
],
"description": "Donations to this Campaign are recurrent?"
},
"public": {
"type": "boolean",
"description": "Is this Donation Campaign public?"
},
"ask_for_tax_number": {
"type": "boolean",
"description": "Donors are asked for their tax number for this Donation Campaign?"
},
"status": {
"type": "string",
"description": "Status of this Donation Campaign"
},
"fund_ids": {
"type": "integer",
"format": "int32",
"description": "Donation Funds associated to this Donation Campaign"
},
"network_category_ids": {
"type": "integer",
"format": "int32",
"description": "Network Categories linked to this Donation Campaign"
},
"customizable_attribute_ids": {
"type": "integer",
"format": "int32",
"description": "Customizable Attributes of type 'donation_campaign' linked to this campaign"
}
},
"description": "CampaignEntity model"
}List of Donations CampaignsGET/api/admin/v2/donations/campaigns{?updated_since}
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"
}URI Parameters
- updated_since
string(required)
POST /api/admin/v2/donations/campaigns
Requests
Body
{
"campaign[title]": "Hello, world!",
"campaign[description]": "Hello, world!",
"campaign[slug]": "Hello, world!",
"campaign[background_image]": "Hello, world!",
"campaign[card_image]": "Hello, world!",
"campaign[currency]": "Hello, world!",
"campaign[goal_amount]": 1,
"campaign[minimum_amount]": 1,
"campaign[amounts][]": [
1
],
"campaign[enable_dedication]": true,
"campaign[recurring_mode]": "Hello, world!",
"campaign[public]": true,
"campaign[ask_for_tax_number]": true,
"campaign[status]": "Hello, world!",
"campaign[fund_ids][]": [
1
],
"campaign[network_category_ids][]": [
1
]
}Schema
{
"type": "object",
"properties": {
"campaign[title]": {
"type": "string",
"description": "Title of the Campaign"
},
"campaign[description]": {
"type": "string",
"description": "Description of the Campaign"
},
"campaign[slug]": {
"type": "string",
"description": "Slug to access this Campaign"
},
"campaign[background_image]": {
"type": "string",
"description": "URL of the background image of the Campaign"
},
"campaign[card_image]": {
"type": "string",
"description": "URL of the card image of the Campaign"
},
"campaign[currency]": {
"type": "string",
"description": "ISO code of the Currency of this Campaign"
},
"campaign[goal_amount]": {
"type": "number",
"description": "Goal amount for this Campaign"
},
"campaign[minimum_amount]": {
"type": "number",
"description": "Minimum amount allowed for this Campaign"
},
"campaign[amounts][]": {
"type": "array",
"items": {
"type": "number"
},
"description": "Pre defined amounts defined for this Campaign (must be more than two elements)"
},
"campaign[enable_dedication]": {
"type": "boolean",
"description": "Donors to this campaign can dedicate their Donation?"
},
"campaign[recurring_mode]": {
"type": "string",
"description": "Donations to this Campaign are recurrent?"
},
"campaign[public]": {
"type": "boolean",
"description": "Is this Donation Campaign public?"
},
"campaign[ask_for_tax_number]": {
"type": "boolean",
"description": "Donors are asked for their tax number for this Donation Campaign?"
},
"campaign[status]": {
"type": "string",
"description": "Status of this Donation Campaign"
},
"campaign[fund_ids][]": {
"type": "array",
"items": {
"type": "number"
},
"description": "Donation Funds associated to this Donation Campaign"
},
"campaign[network_category_ids][]": {
"type": "array",
"items": {
"type": "number"
},
"description": "Network Categories linked to this Donation Campaign"
}
},
"required": [
"campaign[title]",
"campaign[description]",
"campaign[currency]"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Create a Donation Campaign
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Campaign ID"
},
"title": {
"type": "string",
"description": "Title of the Campaign"
},
"description": {
"type": "string",
"description": "Description of the Campaign"
},
"slug": {
"type": "string",
"description": "Slug to access this Campaign"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Campaign creation date - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Campaign update date - iso8601"
},
"discarded_at": {
"type": "string",
"format": "date-time",
"description": "Campaign deletion date - iso8601"
},
"background_image": {
"type": "string",
"description": "URL of the background image of the Campaign"
},
"card_image": {
"type": "string",
"description": "URL of the card image of the Campaign"
},
"currency": {
"type": "string",
"description": "ISO code of the Currency of this Campaign"
},
"goal_amount": {
"type": "number",
"format": "float",
"description": "Goal amount for this Campaign"
},
"minimum_amount": {
"type": "number",
"format": "float",
"description": "Minimum amount allowed for this Campaign"
},
"amounts": {
"type": "number",
"format": "float",
"description": "Pre defined amounts defined for this Campaign (must be more than two elements)"
},
"enable_dedication": {
"type": "boolean",
"description": "Donors to this campaign can dedicate their Donation?"
},
"recurring_mode": {
"type": "string",
"enum": [
"no_recurring",
"simple_recurring",
"advanced_recurring"
],
"description": "Donations to this Campaign are recurrent?"
},
"public": {
"type": "boolean",
"description": "Is this Donation Campaign public?"
},
"ask_for_tax_number": {
"type": "boolean",
"description": "Donors are asked for their tax number for this Donation Campaign?"
},
"status": {
"type": "string",
"description": "Status of this Donation Campaign"
},
"fund_ids": {
"type": "integer",
"format": "int32",
"description": "Donation Funds associated to this Donation Campaign"
},
"network_category_ids": {
"type": "integer",
"format": "int32",
"description": "Network Categories linked to this Donation Campaign"
},
"customizable_attribute_ids": {
"type": "integer",
"format": "int32",
"description": "Customizable Attributes of type 'donation_campaign' linked to this campaign"
}
},
"description": "CampaignEntity model"
}Create a Donation CampaignPOST/api/admin/v2/donations/campaigns
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.
GET /api/admin/v2/donations/campaigns/id
Responses
Get a Donation Campaign information
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Campaign ID"
},
"title": {
"type": "string",
"description": "Title of the Campaign"
},
"description": {
"type": "string",
"description": "Description of the Campaign"
},
"slug": {
"type": "string",
"description": "Slug to access this Campaign"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Campaign creation date - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Campaign update date - iso8601"
},
"discarded_at": {
"type": "string",
"format": "date-time",
"description": "Campaign deletion date - iso8601"
},
"background_image": {
"type": "string",
"description": "URL of the background image of the Campaign"
},
"card_image": {
"type": "string",
"description": "URL of the card image of the Campaign"
},
"currency": {
"type": "string",
"description": "ISO code of the Currency of this Campaign"
},
"goal_amount": {
"type": "number",
"format": "float",
"description": "Goal amount for this Campaign"
},
"minimum_amount": {
"type": "number",
"format": "float",
"description": "Minimum amount allowed for this Campaign"
},
"amounts": {
"type": "number",
"format": "float",
"description": "Pre defined amounts defined for this Campaign (must be more than two elements)"
},
"enable_dedication": {
"type": "boolean",
"description": "Donors to this campaign can dedicate their Donation?"
},
"recurring_mode": {
"type": "string",
"enum": [
"no_recurring",
"simple_recurring",
"advanced_recurring"
],
"description": "Donations to this Campaign are recurrent?"
},
"public": {
"type": "boolean",
"description": "Is this Donation Campaign public?"
},
"ask_for_tax_number": {
"type": "boolean",
"description": "Donors are asked for their tax number for this Donation Campaign?"
},
"status": {
"type": "string",
"description": "Status of this Donation Campaign"
},
"fund_ids": {
"type": "integer",
"format": "int32",
"description": "Donation Funds associated to this Donation Campaign"
},
"network_category_ids": {
"type": "integer",
"format": "int32",
"description": "Network Categories linked to this Donation Campaign"
},
"customizable_attribute_ids": {
"type": "integer",
"format": "int32",
"description": "Customizable Attributes of type 'donation_campaign' linked to this campaign"
}
},
"description": "CampaignEntity model"
}Get a Donation Campaign informationGET/api/admin/v2/donations/campaigns/{id}
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.
URI Parameters
- id
number(required)
DELETE /api/admin/v2/donations/campaigns/id
Responses
Delete a Donation Campaign
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Campaign ID"
},
"title": {
"type": "string",
"description": "Title of the Campaign"
},
"description": {
"type": "string",
"description": "Description of the Campaign"
},
"slug": {
"type": "string",
"description": "Slug to access this Campaign"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Campaign creation date - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Campaign update date - iso8601"
},
"discarded_at": {
"type": "string",
"format": "date-time",
"description": "Campaign deletion date - iso8601"
},
"background_image": {
"type": "string",
"description": "URL of the background image of the Campaign"
},
"card_image": {
"type": "string",
"description": "URL of the card image of the Campaign"
},
"currency": {
"type": "string",
"description": "ISO code of the Currency of this Campaign"
},
"goal_amount": {
"type": "number",
"format": "float",
"description": "Goal amount for this Campaign"
},
"minimum_amount": {
"type": "number",
"format": "float",
"description": "Minimum amount allowed for this Campaign"
},
"amounts": {
"type": "number",
"format": "float",
"description": "Pre defined amounts defined for this Campaign (must be more than two elements)"
},
"enable_dedication": {
"type": "boolean",
"description": "Donors to this campaign can dedicate their Donation?"
},
"recurring_mode": {
"type": "string",
"enum": [
"no_recurring",
"simple_recurring",
"advanced_recurring"
],
"description": "Donations to this Campaign are recurrent?"
},
"public": {
"type": "boolean",
"description": "Is this Donation Campaign public?"
},
"ask_for_tax_number": {
"type": "boolean",
"description": "Donors are asked for their tax number for this Donation Campaign?"
},
"status": {
"type": "string",
"description": "Status of this Donation Campaign"
},
"fund_ids": {
"type": "integer",
"format": "int32",
"description": "Donation Funds associated to this Donation Campaign"
},
"network_category_ids": {
"type": "integer",
"format": "int32",
"description": "Network Categories linked to this Donation Campaign"
},
"customizable_attribute_ids": {
"type": "integer",
"format": "int32",
"description": "Customizable Attributes of type 'donation_campaign' linked to this campaign"
}
},
"description": "CampaignEntity model"
}Delete a Donation CampaignDELETE/api/admin/v2/donations/campaigns/{id}
Delete a Donation Campaign
Will delete the donation campaign. Will be removed from the Donation Funds associated.
URI Parameters
- id
number(required)
PUT /api/admin/v2/donations/campaigns/id
Requests
Body
{
"campaign[title]": "Hello, world!",
"campaign[description]": "Hello, world!",
"campaign[slug]": "Hello, world!",
"campaign[background_image]": "Hello, world!",
"campaign[card_image]": "Hello, world!",
"campaign[currency]": "Hello, world!",
"campaign[goal_amount]": 1,
"campaign[minimum_amount]": 1,
"campaign[amounts][]": [
1
],
"campaign[enable_dedication]": true,
"campaign[recurring_mode]": "Hello, world!",
"campaign[public]": true,
"campaign[ask_for_tax_number]": true,
"campaign[status]": "Hello, world!",
"campaign[fund_ids][]": [
1
],
"campaign[network_category_ids][]": [
1
]
}Schema
{
"type": "object",
"properties": {
"campaign[title]": {
"type": "string",
"description": "Title of the Campaign"
},
"campaign[description]": {
"type": "string",
"description": "Description of the Campaign"
},
"campaign[slug]": {
"type": "string",
"description": "Slug to access this Campaign"
},
"campaign[background_image]": {
"type": "string",
"description": "URL of the background image of the Campaign"
},
"campaign[card_image]": {
"type": "string",
"description": "URL of the card image of the Campaign"
},
"campaign[currency]": {
"type": "string",
"description": "ISO code of the Currency of this Campaign"
},
"campaign[goal_amount]": {
"type": "number",
"description": "Goal amount for this Campaign"
},
"campaign[minimum_amount]": {
"type": "number",
"description": "Minimum amount allowed for this Campaign"
},
"campaign[amounts][]": {
"type": "array",
"items": {
"type": "number"
},
"description": "Pre defined amounts defined for this Campaign (must be more than two elements)"
},
"campaign[enable_dedication]": {
"type": "boolean",
"description": "Donors to this campaign can dedicate their Donation?"
},
"campaign[recurring_mode]": {
"type": "string",
"description": "Donations to this Campaign are recurrent?"
},
"campaign[public]": {
"type": "boolean",
"description": "Is this Donation Campaign public?"
},
"campaign[ask_for_tax_number]": {
"type": "boolean",
"description": "Donors are asked for their tax number for this Donation Campaign?"
},
"campaign[status]": {
"type": "string",
"description": "Status of this Donation Campaign"
},
"campaign[fund_ids][]": {
"type": "array",
"items": {
"type": "number"
},
"description": "Donation Funds associated to this Donation Campaign"
},
"campaign[network_category_ids][]": {
"type": "array",
"items": {
"type": "number"
},
"description": "Network Categories linked to this Donation Campaign"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Update an existing Donation Campaign
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Campaign ID"
},
"title": {
"type": "string",
"description": "Title of the Campaign"
},
"description": {
"type": "string",
"description": "Description of the Campaign"
},
"slug": {
"type": "string",
"description": "Slug to access this Campaign"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Campaign creation date - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Campaign update date - iso8601"
},
"discarded_at": {
"type": "string",
"format": "date-time",
"description": "Campaign deletion date - iso8601"
},
"background_image": {
"type": "string",
"description": "URL of the background image of the Campaign"
},
"card_image": {
"type": "string",
"description": "URL of the card image of the Campaign"
},
"currency": {
"type": "string",
"description": "ISO code of the Currency of this Campaign"
},
"goal_amount": {
"type": "number",
"format": "float",
"description": "Goal amount for this Campaign"
},
"minimum_amount": {
"type": "number",
"format": "float",
"description": "Minimum amount allowed for this Campaign"
},
"amounts": {
"type": "number",
"format": "float",
"description": "Pre defined amounts defined for this Campaign (must be more than two elements)"
},
"enable_dedication": {
"type": "boolean",
"description": "Donors to this campaign can dedicate their Donation?"
},
"recurring_mode": {
"type": "string",
"enum": [
"no_recurring",
"simple_recurring",
"advanced_recurring"
],
"description": "Donations to this Campaign are recurrent?"
},
"public": {
"type": "boolean",
"description": "Is this Donation Campaign public?"
},
"ask_for_tax_number": {
"type": "boolean",
"description": "Donors are asked for their tax number for this Donation Campaign?"
},
"status": {
"type": "string",
"description": "Status of this Donation Campaign"
},
"fund_ids": {
"type": "integer",
"format": "int32",
"description": "Donation Funds associated to this Donation Campaign"
},
"network_category_ids": {
"type": "integer",
"format": "int32",
"description": "Network Categories linked to this Donation Campaign"
},
"customizable_attribute_ids": {
"type": "integer",
"format": "int32",
"description": "Customizable Attributes of type 'donation_campaign' linked to this campaign"
}
},
"description": "CampaignEntity model"
}Update an existing Donation CampaignPUT/api/admin/v2/donations/campaigns/{id}
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.
URI Parameters
- id
number(required)ID of the Donation Campaign
POST /api/admin/v2/donations/campaigns/id
Responses
Duplicate a Donation Campaign
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Campaign ID"
},
"title": {
"type": "string",
"description": "Title of the Campaign"
},
"description": {
"type": "string",
"description": "Description of the Campaign"
},
"slug": {
"type": "string",
"description": "Slug to access this Campaign"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Campaign creation date - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Campaign update date - iso8601"
},
"discarded_at": {
"type": "string",
"format": "date-time",
"description": "Campaign deletion date - iso8601"
},
"background_image": {
"type": "string",
"description": "URL of the background image of the Campaign"
},
"card_image": {
"type": "string",
"description": "URL of the card image of the Campaign"
},
"currency": {
"type": "string",
"description": "ISO code of the Currency of this Campaign"
},
"goal_amount": {
"type": "number",
"format": "float",
"description": "Goal amount for this Campaign"
},
"minimum_amount": {
"type": "number",
"format": "float",
"description": "Minimum amount allowed for this Campaign"
},
"amounts": {
"type": "number",
"format": "float",
"description": "Pre defined amounts defined for this Campaign (must be more than two elements)"
},
"enable_dedication": {
"type": "boolean",
"description": "Donors to this campaign can dedicate their Donation?"
},
"recurring_mode": {
"type": "string",
"enum": [
"no_recurring",
"simple_recurring",
"advanced_recurring"
],
"description": "Donations to this Campaign are recurrent?"
},
"public": {
"type": "boolean",
"description": "Is this Donation Campaign public?"
},
"ask_for_tax_number": {
"type": "boolean",
"description": "Donors are asked for their tax number for this Donation Campaign?"
},
"status": {
"type": "string",
"description": "Status of this Donation Campaign"
},
"fund_ids": {
"type": "integer",
"format": "int32",
"description": "Donation Funds associated to this Donation Campaign"
},
"network_category_ids": {
"type": "integer",
"format": "int32",
"description": "Network Categories linked to this Donation Campaign"
},
"customizable_attribute_ids": {
"type": "integer",
"format": "int32",
"description": "Customizable Attributes of type 'donation_campaign' linked to this campaign"
}
},
"description": "CampaignEntity model"
}Duplicate a Donation CampaignPOST/api/admin/v2/donations/campaigns/{id}
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’.
URI Parameters
- id
number(required)
POST /api/admin/v2/donations/campaigns/campaign_id/customizable_attributes/link
Requests
Body
{
"customizable_attribute_id": "Hello, world!"
}Schema
{
"type": "object",
"properties": {
"customizable_attribute_id": {
"type": "string"
}
},
"required": [
"customizable_attribute_id"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Customization Attribute Link
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"customizable_id": {
"type": "integer",
"format": "int32",
"description": "Customizable ID"
},
"type": {
"type": "string",
"enum": [
"CustomizableAttribute::Boolean",
"CustomizableAttribute::Date",
"CustomizableAttribute::DoubleSelect",
"CustomizableAttribute::Number",
"CustomizableAttribute::Select",
"CustomizableAttribute::Text"
],
"description": "Customizable Attribute type"
},
"customizable_type": {
"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",
"mentorships",
"mentorships_mentee",
"mentorships_mentor",
"ne_event",
"ne_ticket",
"topic_approval",
"topic_mentorships",
"topic_mentorships_mentee",
"topic_mentorships_mentor",
"user",
"ventures_venture"
],
"description": "Customizable Attribute associated model (User, Experience)"
},
"name": {
"type": "string",
"description": "Customizable Attribute name"
},
"display_name": {
"type": "string",
"description": "Customizable Attribute displayed name"
},
"tooltip": {
"type": "string",
"description": "Customizable Attribute tooltip"
},
"placeholder": {
"type": "string",
"description": "Customizable Attribute placeholder"
},
"multi": {
"type": "boolean",
"description": "Customizable Attribute multi activated ?"
},
"text_size": {
"type": "integer",
"format": "int32",
"description": "Customizable Attribute text_size"
},
"visibility": {
"type": "string",
"enum": [
"admin_only",
"tagged_user",
"everybody",
"not_visible"
],
"description": "Customizable Attribute visibility"
},
"user_editable": {
"type": "boolean",
"description": "Customizable Attribute editable by the user ?"
},
"required": {
"type": "boolean",
"description": "Customizable Attribute required ?"
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "Customizable Attribute array of options"
},
"json_options": {
"type": "object",
"description": "Customizable Attribute json options (for double select)"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Customizable Attribute creation date"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Customizable Attribute last update date"
},
"selected_value": {
"type": "string",
"description": "Customizable Attribute selected value"
}
},
"description": "CustomizableAttribute model"
}Customization Attribute LinkPOST/api/admin/v2/donations/campaigns/{campaign_id}/customizable_attributes/link
Link
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 that can be linked to a Donation Campaign is not the same as the one that will be linked to the Donation Campaign.
URI Parameters
- campaign_id
string(required)
DELETE /api/admin/v2/donations/campaigns/campaign_id/customizable_attributes/id
Responses
Customizable Attribute Unlink
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"customizable_id": {
"type": "integer",
"format": "int32",
"description": "Customizable ID"
},
"type": {
"type": "string",
"enum": [
"CustomizableAttribute::Boolean",
"CustomizableAttribute::Date",
"CustomizableAttribute::DoubleSelect",
"CustomizableAttribute::Number",
"CustomizableAttribute::Select",
"CustomizableAttribute::Text"
],
"description": "Customizable Attribute type"
},
"customizable_type": {
"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",
"mentorships",
"mentorships_mentee",
"mentorships_mentor",
"ne_event",
"ne_ticket",
"topic_approval",
"topic_mentorships",
"topic_mentorships_mentee",
"topic_mentorships_mentor",
"user",
"ventures_venture"
],
"description": "Customizable Attribute associated model (User, Experience)"
},
"name": {
"type": "string",
"description": "Customizable Attribute name"
},
"display_name": {
"type": "string",
"description": "Customizable Attribute displayed name"
},
"tooltip": {
"type": "string",
"description": "Customizable Attribute tooltip"
},
"placeholder": {
"type": "string",
"description": "Customizable Attribute placeholder"
},
"multi": {
"type": "boolean",
"description": "Customizable Attribute multi activated ?"
},
"text_size": {
"type": "integer",
"format": "int32",
"description": "Customizable Attribute text_size"
},
"visibility": {
"type": "string",
"enum": [
"admin_only",
"tagged_user",
"everybody",
"not_visible"
],
"description": "Customizable Attribute visibility"
},
"user_editable": {
"type": "boolean",
"description": "Customizable Attribute editable by the user ?"
},
"required": {
"type": "boolean",
"description": "Customizable Attribute required ?"
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "Customizable Attribute array of options"
},
"json_options": {
"type": "object",
"description": "Customizable Attribute json options (for double select)"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Customizable Attribute creation date"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Customizable Attribute last update date"
},
"selected_value": {
"type": "string",
"description": "Customizable Attribute selected value"
}
},
"description": "CustomizableAttribute model"
}Customizable Attribute UnlinkDELETE/api/admin/v2/donations/campaigns/{campaign_id}/customizable_attributes/{id}
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.
URI Parameters
- campaign_id
string(required)- id
string(required)
GET /api/admin/v2/donations/orders?updated_since=
Responses
List of Donations made
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Donation Order ID"
},
"external_id": {
"type": "string",
"description": "Donation Order external ID (for external systems)"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "User ID linked to this Donation Order"
},
"campaign_id": {
"type": "integer",
"format": "int32",
"description": "Donation Campaign ID linked to this Donation Order"
},
"receipt_id": {
"type": "integer",
"format": "int32",
"description": "Receipt ID linked to this Donation Order"
},
"gift_ids": {
"type": "integer",
"format": "int32",
"description": "Gifts ID linked to this Donation Order"
},
"parent_id": {
"type": "integer",
"format": "int32",
"description": "In case of a recurring donation, this is the ID of the previous Donation Order ID"
},
"promotion_code": {
"type": "string",
"description": "Promotion code linked to the Donation Order (permit to link to the order which marketing campaign led to the Donation)"
},
"tax_number": {
"type": "string",
"description": "Tax number linked to this Order"
},
"billing_address": {
"description": "Billing address of the Donor",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"address_1": {
"type": "string",
"description": "Address line 1"
},
"address_2": {
"type": "string",
"description": "Address line 2"
},
"address_3": {
"type": "string",
"description": "Address line 3"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "State"
},
"full_name": {
"type": "string",
"description": "Full name"
},
"postal_code": {
"type": "string",
"description": "Zip code"
},
"country": {
"type": "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"
],
"description": "Country"
},
"default_billing_address": {
"type": "boolean",
"description": "is the default billing address for the user ?"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Postal address creation date time - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Postal address last update date time - iso8601"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "User ID linked to postal address"
}
}
},
"firstname": {
"type": "string",
"description": "Firstname of the Donor"
},
"lastname": {
"type": "string",
"description": "Lastname of the Donor"
},
"maidenname": {
"type": "string",
"description": "Maindenname of the Donor"
},
"prefix_name": {
"type": "string",
"description": "Prefix name of the Donor"
},
"mobile_pro": {
"type": "string",
"description": "Professionel mobile phone number of the Donor"
},
"mobile_perso": {
"type": "string",
"description": "Personal mobile phone number of the Donor"
},
"email": {
"type": "string",
"description": "Email of the Donor"
},
"in_memory_of": {
"type": "boolean",
"description": "is the Donation in memory of someone/something ?"
},
"on_behalf_of": {
"type": "boolean",
"description": "is the Donation on behalf of someone/something ?"
},
"in_honor_of": {
"type": "boolean",
"description": "is the Donation in honor of someone/something ?"
},
"dedication_title": {
"type": "string",
"description": "To whom (or what) the Donation is dedicated"
},
"dedication_description": {
"type": "string",
"description": "A description of why/contact information for the Dedication"
},
"amount": {
"type": "number",
"format": "float",
"description": "Amount of the Donation"
},
"currency": {
"type": "string",
"description": "Currency of the Donation"
},
"recurring_payment_enabled": {
"type": "boolean",
"description": "Is the Donation recurrent ?"
},
"lifelong_payment_enabled": {
"type": "boolean",
"description": "Is the Donation a lifelong recurring payment ?"
},
"recurring_payments_left": {
"type": "integer",
"format": "int32",
"description": "How many times it has to be charged again ?"
},
"periodicity": {
"type": "string",
"enum": [
"week",
"two_weeks",
"month",
"three_months",
"six_months",
"year"
],
"description": "Periodicity of the Donation"
},
"send_confirmation_email": {
"type": "boolean",
"description": "Is the confirmation email to be send to the user ?"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Donation Order creation date - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Donation Order update date - iso8601"
},
"discarded_at": {
"type": "string",
"format": "date-time",
"description": "Donation Order deletion date - iso8601"
},
"customizable_attributes": {
"type": "array",
"items": {
"type": "object"
},
"description": "Array of customizable attributes with name and value"
},
"hep_information": {
"type": "object",
"description": "HEP Mapping informations"
},
"payment_status": {
"type": "string",
"description": "Status of the payment (not applicable if recurring)"
},
"submitted_by": {
"description": "Submitter Information",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Submitter ID"
},
"type": {
"type": "string",
"description": "Submitter type"
}
}
}
},
"description": "DonationOrderEntity model"
}List of Donations madeGET/api/admin/v2/donations/orders{?updated_since}
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"
}URI Parameters
- updated_since
string(required)
POST /api/admin/v2/donations/orders
Requests
Body
{
"order[external_id]": "Hello, world!",
"order[user_id]": 1,
"order[campaign_id]": 1,
"order[parent_id]": 1,
"order[promotion_code]": "Hello, world!",
"order[tax_number]": "Hello, world!",
"order[billing_address][address_1]": "Hello, world!",
"order[billing_address][address_2]": "Hello, world!",
"order[billing_address][address_3]": "Hello, world!",
"order[billing_address][city]": "Hello, world!",
"order[billing_address][state]": "Hello, world!",
"order[billing_address][postal_code]": "Hello, world!",
"order[billing_address][country]": "Hello, world!",
"order[maidenname]": "Hello, world!",
"order[prefix_name]": "Hello, world!",
"order[mobile_pro]": "Hello, world!",
"order[mobile_perso]": "Hello, world!",
"order[in_memory_of]": true,
"order[on_behalf_of]": true,
"order[in_honor_of]": true,
"order[dedication_title]": "Hello, world!",
"order[dedication_description]": "Hello, world!",
"order[recurring_payment_enabled]": true,
"order[lifelong_payment_enabled]": true,
"order[recurring_payments_left]": 1,
"order[periodicity]": "Hello, world!",
"order[send_confirmation_email]": true,
"order[payment_status]": "Hello, world!",
"order[firstname]": "Hello, world!",
"order[lastname]": "Hello, world!",
"order[email]": "Hello, world!",
"order[customizable_attributes][]": [],
"order[gifts][][fund_id]": [
1
],
"order[gifts][][amount]": [
1
],
"order[gifts][][custom_fund]": []
}Schema
{
"type": "object",
"properties": {
"order[external_id]": {
"type": "string",
"description": "Donation Order external ID (for external systems)"
},
"order[user_id]": {
"type": "number",
"description": "User ID linked to this Donation Order"
},
"order[campaign_id]": {
"type": "number",
"description": "Donation Campaign ID linked to this Donation Order"
},
"order[parent_id]": {
"type": "number",
"description": "In case of a recurring donation, this is the ID of the previous Donation Order ID"
},
"order[promotion_code]": {
"type": "string",
"description": "Promotion code linked to the Donation Order (permit to link to the order which marketing campaign led to the Donation)"
},
"order[tax_number]": {
"type": "string",
"description": "Tax number linked to this Order"
},
"order[billing_address][address_1]": {
"type": "string",
"description": "Address line 1"
},
"order[billing_address][address_2]": {
"type": "string",
"description": "Address line 2"
},
"order[billing_address][address_3]": {
"type": "string",
"description": "Address line 3"
},
"order[billing_address][city]": {
"type": "string",
"description": "City"
},
"order[billing_address][state]": {
"type": "string",
"description": "State"
},
"order[billing_address][postal_code]": {
"type": "string",
"description": "Zip code"
},
"order[billing_address][country]": {
"type": "string",
"description": "Country"
},
"order[maidenname]": {
"type": "string",
"description": "Maindenname of the Donor"
},
"order[prefix_name]": {
"type": "string",
"description": "Prefix name of the Donor"
},
"order[mobile_pro]": {
"type": "string",
"description": "Professionel mobile phone number of the Donor"
},
"order[mobile_perso]": {
"type": "string",
"description": "Personal mobile phone number of the Donor"
},
"order[in_memory_of]": {
"type": "boolean",
"description": "is the Donation in memory of someone/something ?"
},
"order[on_behalf_of]": {
"type": "boolean",
"description": "is the Donation on behalf of someone/something ?"
},
"order[in_honor_of]": {
"type": "boolean",
"description": "is the Donation in honor of someone/something ?"
},
"order[dedication_title]": {
"type": "string",
"description": "To whom (or what) the Donation is dedicated"
},
"order[dedication_description]": {
"type": "string",
"description": "A description of why/contact information for the Dedication"
},
"order[recurring_payment_enabled]": {
"type": "boolean",
"description": "Is the Donation recurrent ?"
},
"order[lifelong_payment_enabled]": {
"type": "boolean",
"description": "Is the Donation a lifelong recurring payment ?"
},
"order[recurring_payments_left]": {
"type": "number",
"description": "How many times it has to be charged again ?"
},
"order[periodicity]": {
"type": "string",
"description": "Periodicity of the Donation"
},
"order[send_confirmation_email]": {
"type": "boolean",
"description": "Is the confirmation email to be send to the user ?"
},
"order[payment_status]": {
"type": "string",
"description": "Status of the payment (not applicable if recurring)"
},
"order[firstname]": {
"type": "string"
},
"order[lastname]": {
"type": "string"
},
"order[email]": {
"type": "string"
},
"order[customizable_attributes][]": {
"type": "array",
"description": "+"
},
"order[gifts][][fund_id]": {
"type": "array",
"items": {
"type": "number"
},
"description": "Donation Fund ID linked to this Donation Gift"
},
"order[gifts][][amount]": {
"type": "array",
"items": {
"type": "number"
},
"description": "Amount of the Donation"
},
"order[gifts][][custom_fund]": {
"type": "array",
"description": "Name of the \"other\" fund chosen\n\n+"
}
},
"required": [
"order[campaign_id]",
"order[firstname]",
"order[lastname]",
"order[email]",
"order[gifts][][fund_id]",
"order[gifts][][amount]"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Create a Donation
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Donation Order ID"
},
"external_id": {
"type": "string",
"description": "Donation Order external ID (for external systems)"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "User ID linked to this Donation Order"
},
"campaign_id": {
"type": "integer",
"format": "int32",
"description": "Donation Campaign ID linked to this Donation Order"
},
"receipt_id": {
"type": "integer",
"format": "int32",
"description": "Receipt ID linked to this Donation Order"
},
"gift_ids": {
"type": "integer",
"format": "int32",
"description": "Gifts ID linked to this Donation Order"
},
"parent_id": {
"type": "integer",
"format": "int32",
"description": "In case of a recurring donation, this is the ID of the previous Donation Order ID"
},
"promotion_code": {
"type": "string",
"description": "Promotion code linked to the Donation Order (permit to link to the order which marketing campaign led to the Donation)"
},
"tax_number": {
"type": "string",
"description": "Tax number linked to this Order"
},
"billing_address": {
"description": "Billing address of the Donor",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"address_1": {
"type": "string",
"description": "Address line 1"
},
"address_2": {
"type": "string",
"description": "Address line 2"
},
"address_3": {
"type": "string",
"description": "Address line 3"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "State"
},
"full_name": {
"type": "string",
"description": "Full name"
},
"postal_code": {
"type": "string",
"description": "Zip code"
},
"country": {
"type": "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"
],
"description": "Country"
},
"default_billing_address": {
"type": "boolean",
"description": "is the default billing address for the user ?"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Postal address creation date time - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Postal address last update date time - iso8601"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "User ID linked to postal address"
}
}
},
"firstname": {
"type": "string",
"description": "Firstname of the Donor"
},
"lastname": {
"type": "string",
"description": "Lastname of the Donor"
},
"maidenname": {
"type": "string",
"description": "Maindenname of the Donor"
},
"prefix_name": {
"type": "string",
"description": "Prefix name of the Donor"
},
"mobile_pro": {
"type": "string",
"description": "Professionel mobile phone number of the Donor"
},
"mobile_perso": {
"type": "string",
"description": "Personal mobile phone number of the Donor"
},
"email": {
"type": "string",
"description": "Email of the Donor"
},
"in_memory_of": {
"type": "boolean",
"description": "is the Donation in memory of someone/something ?"
},
"on_behalf_of": {
"type": "boolean",
"description": "is the Donation on behalf of someone/something ?"
},
"in_honor_of": {
"type": "boolean",
"description": "is the Donation in honor of someone/something ?"
},
"dedication_title": {
"type": "string",
"description": "To whom (or what) the Donation is dedicated"
},
"dedication_description": {
"type": "string",
"description": "A description of why/contact information for the Dedication"
},
"amount": {
"type": "number",
"format": "float",
"description": "Amount of the Donation"
},
"currency": {
"type": "string",
"description": "Currency of the Donation"
},
"recurring_payment_enabled": {
"type": "boolean",
"description": "Is the Donation recurrent ?"
},
"lifelong_payment_enabled": {
"type": "boolean",
"description": "Is the Donation a lifelong recurring payment ?"
},
"recurring_payments_left": {
"type": "integer",
"format": "int32",
"description": "How many times it has to be charged again ?"
},
"periodicity": {
"type": "string",
"enum": [
"week",
"two_weeks",
"month",
"three_months",
"six_months",
"year"
],
"description": "Periodicity of the Donation"
},
"send_confirmation_email": {
"type": "boolean",
"description": "Is the confirmation email to be send to the user ?"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Donation Order creation date - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Donation Order update date - iso8601"
},
"discarded_at": {
"type": "string",
"format": "date-time",
"description": "Donation Order deletion date - iso8601"
},
"customizable_attributes": {
"type": "array",
"items": {
"type": "object"
},
"description": "Array of customizable attributes with name and value"
},
"hep_information": {
"type": "object",
"description": "HEP Mapping informations"
},
"payment_status": {
"type": "string",
"description": "Status of the payment (not applicable if recurring)"
},
"submitted_by": {
"description": "Submitter Information",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Submitter ID"
},
"type": {
"type": "string",
"description": "Submitter type"
}
}
}
},
"description": "DonationOrderEntity model"
}Create a DonationPOST/api/admin/v2/donations/orders
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.
GET /api/admin/v2/donations/orders/id
Responses
Get a Donation Order
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Donation Order ID"
},
"external_id": {
"type": "string",
"description": "Donation Order external ID (for external systems)"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "User ID linked to this Donation Order"
},
"campaign_id": {
"type": "integer",
"format": "int32",
"description": "Donation Campaign ID linked to this Donation Order"
},
"receipt_id": {
"type": "integer",
"format": "int32",
"description": "Receipt ID linked to this Donation Order"
},
"gift_ids": {
"type": "integer",
"format": "int32",
"description": "Gifts ID linked to this Donation Order"
},
"parent_id": {
"type": "integer",
"format": "int32",
"description": "In case of a recurring donation, this is the ID of the previous Donation Order ID"
},
"promotion_code": {
"type": "string",
"description": "Promotion code linked to the Donation Order (permit to link to the order which marketing campaign led to the Donation)"
},
"tax_number": {
"type": "string",
"description": "Tax number linked to this Order"
},
"billing_address": {
"description": "Billing address of the Donor",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"address_1": {
"type": "string",
"description": "Address line 1"
},
"address_2": {
"type": "string",
"description": "Address line 2"
},
"address_3": {
"type": "string",
"description": "Address line 3"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "State"
},
"full_name": {
"type": "string",
"description": "Full name"
},
"postal_code": {
"type": "string",
"description": "Zip code"
},
"country": {
"type": "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"
],
"description": "Country"
},
"default_billing_address": {
"type": "boolean",
"description": "is the default billing address for the user ?"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Postal address creation date time - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Postal address last update date time - iso8601"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "User ID linked to postal address"
}
}
},
"firstname": {
"type": "string",
"description": "Firstname of the Donor"
},
"lastname": {
"type": "string",
"description": "Lastname of the Donor"
},
"maidenname": {
"type": "string",
"description": "Maindenname of the Donor"
},
"prefix_name": {
"type": "string",
"description": "Prefix name of the Donor"
},
"mobile_pro": {
"type": "string",
"description": "Professionel mobile phone number of the Donor"
},
"mobile_perso": {
"type": "string",
"description": "Personal mobile phone number of the Donor"
},
"email": {
"type": "string",
"description": "Email of the Donor"
},
"in_memory_of": {
"type": "boolean",
"description": "is the Donation in memory of someone/something ?"
},
"on_behalf_of": {
"type": "boolean",
"description": "is the Donation on behalf of someone/something ?"
},
"in_honor_of": {
"type": "boolean",
"description": "is the Donation in honor of someone/something ?"
},
"dedication_title": {
"type": "string",
"description": "To whom (or what) the Donation is dedicated"
},
"dedication_description": {
"type": "string",
"description": "A description of why/contact information for the Dedication"
},
"amount": {
"type": "number",
"format": "float",
"description": "Amount of the Donation"
},
"currency": {
"type": "string",
"description": "Currency of the Donation"
},
"recurring_payment_enabled": {
"type": "boolean",
"description": "Is the Donation recurrent ?"
},
"lifelong_payment_enabled": {
"type": "boolean",
"description": "Is the Donation a lifelong recurring payment ?"
},
"recurring_payments_left": {
"type": "integer",
"format": "int32",
"description": "How many times it has to be charged again ?"
},
"periodicity": {
"type": "string",
"enum": [
"week",
"two_weeks",
"month",
"three_months",
"six_months",
"year"
],
"description": "Periodicity of the Donation"
},
"send_confirmation_email": {
"type": "boolean",
"description": "Is the confirmation email to be send to the user ?"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Donation Order creation date - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Donation Order update date - iso8601"
},
"discarded_at": {
"type": "string",
"format": "date-time",
"description": "Donation Order deletion date - iso8601"
},
"customizable_attributes": {
"type": "array",
"items": {
"type": "object"
},
"description": "Array of customizable attributes with name and value"
},
"hep_information": {
"type": "object",
"description": "HEP Mapping informations"
},
"payment_status": {
"type": "string",
"description": "Status of the payment (not applicable if recurring)"
},
"submitted_by": {
"description": "Submitter Information",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Submitter ID"
},
"type": {
"type": "string",
"description": "Submitter type"
}
}
}
},
"description": "DonationOrderEntity model"
}Get a Donation OrderGET/api/admin/v2/donations/orders/{id}
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.
URI Parameters
- id
number(required)
DELETE /api/admin/v2/donations/orders/id
Responses
Delete a Donation order
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Donation Order ID"
},
"external_id": {
"type": "string",
"description": "Donation Order external ID (for external systems)"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "User ID linked to this Donation Order"
},
"campaign_id": {
"type": "integer",
"format": "int32",
"description": "Donation Campaign ID linked to this Donation Order"
},
"receipt_id": {
"type": "integer",
"format": "int32",
"description": "Receipt ID linked to this Donation Order"
},
"gift_ids": {
"type": "integer",
"format": "int32",
"description": "Gifts ID linked to this Donation Order"
},
"parent_id": {
"type": "integer",
"format": "int32",
"description": "In case of a recurring donation, this is the ID of the previous Donation Order ID"
},
"promotion_code": {
"type": "string",
"description": "Promotion code linked to the Donation Order (permit to link to the order which marketing campaign led to the Donation)"
},
"tax_number": {
"type": "string",
"description": "Tax number linked to this Order"
},
"billing_address": {
"description": "Billing address of the Donor",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"address_1": {
"type": "string",
"description": "Address line 1"
},
"address_2": {
"type": "string",
"description": "Address line 2"
},
"address_3": {
"type": "string",
"description": "Address line 3"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "State"
},
"full_name": {
"type": "string",
"description": "Full name"
},
"postal_code": {
"type": "string",
"description": "Zip code"
},
"country": {
"type": "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"
],
"description": "Country"
},
"default_billing_address": {
"type": "boolean",
"description": "is the default billing address for the user ?"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Postal address creation date time - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Postal address last update date time - iso8601"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "User ID linked to postal address"
}
}
},
"firstname": {
"type": "string",
"description": "Firstname of the Donor"
},
"lastname": {
"type": "string",
"description": "Lastname of the Donor"
},
"maidenname": {
"type": "string",
"description": "Maindenname of the Donor"
},
"prefix_name": {
"type": "string",
"description": "Prefix name of the Donor"
},
"mobile_pro": {
"type": "string",
"description": "Professionel mobile phone number of the Donor"
},
"mobile_perso": {
"type": "string",
"description": "Personal mobile phone number of the Donor"
},
"email": {
"type": "string",
"description": "Email of the Donor"
},
"in_memory_of": {
"type": "boolean",
"description": "is the Donation in memory of someone/something ?"
},
"on_behalf_of": {
"type": "boolean",
"description": "is the Donation on behalf of someone/something ?"
},
"in_honor_of": {
"type": "boolean",
"description": "is the Donation in honor of someone/something ?"
},
"dedication_title": {
"type": "string",
"description": "To whom (or what) the Donation is dedicated"
},
"dedication_description": {
"type": "string",
"description": "A description of why/contact information for the Dedication"
},
"amount": {
"type": "number",
"format": "float",
"description": "Amount of the Donation"
},
"currency": {
"type": "string",
"description": "Currency of the Donation"
},
"recurring_payment_enabled": {
"type": "boolean",
"description": "Is the Donation recurrent ?"
},
"lifelong_payment_enabled": {
"type": "boolean",
"description": "Is the Donation a lifelong recurring payment ?"
},
"recurring_payments_left": {
"type": "integer",
"format": "int32",
"description": "How many times it has to be charged again ?"
},
"periodicity": {
"type": "string",
"enum": [
"week",
"two_weeks",
"month",
"three_months",
"six_months",
"year"
],
"description": "Periodicity of the Donation"
},
"send_confirmation_email": {
"type": "boolean",
"description": "Is the confirmation email to be send to the user ?"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Donation Order creation date - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Donation Order update date - iso8601"
},
"discarded_at": {
"type": "string",
"format": "date-time",
"description": "Donation Order deletion date - iso8601"
},
"customizable_attributes": {
"type": "array",
"items": {
"type": "object"
},
"description": "Array of customizable attributes with name and value"
},
"hep_information": {
"type": "object",
"description": "HEP Mapping informations"
},
"payment_status": {
"type": "string",
"description": "Status of the payment (not applicable if recurring)"
},
"submitted_by": {
"description": "Submitter Information",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Submitter ID"
},
"type": {
"type": "string",
"description": "Submitter type"
}
}
}
},
"description": "DonationOrderEntity model"
}Delete a Donation orderDELETE/api/admin/v2/donations/orders/{id}
Deletes a Donation Order and the gifts linked.
URI Parameters
- id
number(required)
PUT /api/admin/v2/donations/orders/id
Requests
Body
{
"order[external_id]": "Hello, world!",
"order[user_id]": 1,
"order[campaign_id]": 1,
"order[parent_id]": 1,
"order[promotion_code]": "Hello, world!",
"order[tax_number]": "Hello, world!",
"order[billing_address][address_1]": "Hello, world!",
"order[billing_address][address_2]": "Hello, world!",
"order[billing_address][address_3]": "Hello, world!",
"order[billing_address][city]": "Hello, world!",
"order[billing_address][state]": "Hello, world!",
"order[billing_address][postal_code]": "Hello, world!",
"order[billing_address][country]": "Hello, world!",
"order[firstname]": "Hello, world!",
"order[lastname]": "Hello, world!",
"order[maidenname]": "Hello, world!",
"order[prefix_name]": "Hello, world!",
"order[mobile_pro]": "Hello, world!",
"order[mobile_perso]": "Hello, world!",
"order[email]": "Hello, world!",
"order[in_memory_of]": true,
"order[on_behalf_of]": true,
"order[in_honor_of]": true,
"order[dedication_title]": "Hello, world!",
"order[dedication_description]": "Hello, world!",
"order[amount]": 1,
"order[recurring_payment_enabled]": true,
"order[lifelong_payment_enabled]": true,
"order[recurring_payments_left]": 1,
"order[periodicity]": "Hello, world!",
"order[send_confirmation_email]": true,
"order[payment_status]": "Hello, world!",
"order[customizable_attributes][]": [],
"order[gifts][][id]": [
1
],
"order[gifts][][fund_id]": [
1
],
"order[gifts][][custom_fund]": []
}Schema
{
"type": "object",
"properties": {
"order[external_id]": {
"type": "string",
"description": "Donation Order external ID (for external systems)"
},
"order[user_id]": {
"type": "number",
"description": "User ID linked to this Donation Order"
},
"order[campaign_id]": {
"type": "number",
"description": "Donation Campaign ID linked to this Donation Order"
},
"order[parent_id]": {
"type": "number",
"description": "In case of a recurring donation, this is the ID of the previous Donation Order ID"
},
"order[promotion_code]": {
"type": "string",
"description": "Promotion code linked to the Donation Order (permit to link to the order which marketing campaign led to the Donation)"
},
"order[tax_number]": {
"type": "string",
"description": "Tax number linked to this Order"
},
"order[billing_address][address_1]": {
"type": "string",
"description": "Address line 1"
},
"order[billing_address][address_2]": {
"type": "string",
"description": "Address line 2"
},
"order[billing_address][address_3]": {
"type": "string",
"description": "Address line 3"
},
"order[billing_address][city]": {
"type": "string",
"description": "City"
},
"order[billing_address][state]": {
"type": "string",
"description": "State"
},
"order[billing_address][postal_code]": {
"type": "string",
"description": "Zip code"
},
"order[billing_address][country]": {
"type": "string",
"description": "Country"
},
"order[firstname]": {
"type": "string",
"description": "Firstname of the Donor"
},
"order[lastname]": {
"type": "string",
"description": "Lastname of the Donor"
},
"order[maidenname]": {
"type": "string",
"description": "Maindenname of the Donor"
},
"order[prefix_name]": {
"type": "string",
"description": "Prefix name of the Donor"
},
"order[mobile_pro]": {
"type": "string",
"description": "Professionel mobile phone number of the Donor"
},
"order[mobile_perso]": {
"type": "string",
"description": "Personal mobile phone number of the Donor"
},
"order[email]": {
"type": "string",
"description": "Email of the Donor"
},
"order[in_memory_of]": {
"type": "boolean",
"description": "is the Donation in memory of someone/something ?"
},
"order[on_behalf_of]": {
"type": "boolean",
"description": "is the Donation on behalf of someone/something ?"
},
"order[in_honor_of]": {
"type": "boolean",
"description": "is the Donation in honor of someone/something ?"
},
"order[dedication_title]": {
"type": "string",
"description": "To whom (or what) the Donation is dedicated"
},
"order[dedication_description]": {
"type": "string",
"description": "A description of why/contact information for the Dedication"
},
"order[amount]": {
"type": "number",
"description": "Amount of the Donation"
},
"order[recurring_payment_enabled]": {
"type": "boolean",
"description": "Is the Donation recurrent ?"
},
"order[lifelong_payment_enabled]": {
"type": "boolean",
"description": "Is the Donation a lifelong recurring payment ?"
},
"order[recurring_payments_left]": {
"type": "number",
"description": "How many times it has to be charged again ?"
},
"order[periodicity]": {
"type": "string",
"description": "Periodicity of the Donation"
},
"order[send_confirmation_email]": {
"type": "boolean",
"description": "Is the confirmation email to be send to the user ?"
},
"order[payment_status]": {
"type": "string",
"description": "Status of the payment (not applicable if recurring)"
},
"order[customizable_attributes][]": {
"type": "array",
"description": "+"
},
"order[gifts][][id]": {
"type": "array",
"items": {
"type": "number"
}
},
"order[gifts][][fund_id]": {
"type": "array",
"items": {
"type": "number"
}
},
"order[gifts][][custom_fund]": {
"type": "array",
"description": "+"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Update an existing Donation
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Donation Order ID"
},
"external_id": {
"type": "string",
"description": "Donation Order external ID (for external systems)"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "User ID linked to this Donation Order"
},
"campaign_id": {
"type": "integer",
"format": "int32",
"description": "Donation Campaign ID linked to this Donation Order"
},
"receipt_id": {
"type": "integer",
"format": "int32",
"description": "Receipt ID linked to this Donation Order"
},
"gift_ids": {
"type": "integer",
"format": "int32",
"description": "Gifts ID linked to this Donation Order"
},
"parent_id": {
"type": "integer",
"format": "int32",
"description": "In case of a recurring donation, this is the ID of the previous Donation Order ID"
},
"promotion_code": {
"type": "string",
"description": "Promotion code linked to the Donation Order (permit to link to the order which marketing campaign led to the Donation)"
},
"tax_number": {
"type": "string",
"description": "Tax number linked to this Order"
},
"billing_address": {
"description": "Billing address of the Donor",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"address_1": {
"type": "string",
"description": "Address line 1"
},
"address_2": {
"type": "string",
"description": "Address line 2"
},
"address_3": {
"type": "string",
"description": "Address line 3"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "State"
},
"full_name": {
"type": "string",
"description": "Full name"
},
"postal_code": {
"type": "string",
"description": "Zip code"
},
"country": {
"type": "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"
],
"description": "Country"
},
"default_billing_address": {
"type": "boolean",
"description": "is the default billing address for the user ?"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Postal address creation date time - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Postal address last update date time - iso8601"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "User ID linked to postal address"
}
}
},
"firstname": {
"type": "string",
"description": "Firstname of the Donor"
},
"lastname": {
"type": "string",
"description": "Lastname of the Donor"
},
"maidenname": {
"type": "string",
"description": "Maindenname of the Donor"
},
"prefix_name": {
"type": "string",
"description": "Prefix name of the Donor"
},
"mobile_pro": {
"type": "string",
"description": "Professionel mobile phone number of the Donor"
},
"mobile_perso": {
"type": "string",
"description": "Personal mobile phone number of the Donor"
},
"email": {
"type": "string",
"description": "Email of the Donor"
},
"in_memory_of": {
"type": "boolean",
"description": "is the Donation in memory of someone/something ?"
},
"on_behalf_of": {
"type": "boolean",
"description": "is the Donation on behalf of someone/something ?"
},
"in_honor_of": {
"type": "boolean",
"description": "is the Donation in honor of someone/something ?"
},
"dedication_title": {
"type": "string",
"description": "To whom (or what) the Donation is dedicated"
},
"dedication_description": {
"type": "string",
"description": "A description of why/contact information for the Dedication"
},
"amount": {
"type": "number",
"format": "float",
"description": "Amount of the Donation"
},
"currency": {
"type": "string",
"description": "Currency of the Donation"
},
"recurring_payment_enabled": {
"type": "boolean",
"description": "Is the Donation recurrent ?"
},
"lifelong_payment_enabled": {
"type": "boolean",
"description": "Is the Donation a lifelong recurring payment ?"
},
"recurring_payments_left": {
"type": "integer",
"format": "int32",
"description": "How many times it has to be charged again ?"
},
"periodicity": {
"type": "string",
"enum": [
"week",
"two_weeks",
"month",
"three_months",
"six_months",
"year"
],
"description": "Periodicity of the Donation"
},
"send_confirmation_email": {
"type": "boolean",
"description": "Is the confirmation email to be send to the user ?"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Donation Order creation date - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Donation Order update date - iso8601"
},
"discarded_at": {
"type": "string",
"format": "date-time",
"description": "Donation Order deletion date - iso8601"
},
"customizable_attributes": {
"type": "array",
"items": {
"type": "object"
},
"description": "Array of customizable attributes with name and value"
},
"hep_information": {
"type": "object",
"description": "HEP Mapping informations"
},
"payment_status": {
"type": "string",
"description": "Status of the payment (not applicable if recurring)"
},
"submitted_by": {
"description": "Submitter Information",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Submitter ID"
},
"type": {
"type": "string",
"description": "Submitter type"
}
}
}
},
"description": "DonationOrderEntity model"
}Update an existing DonationPUT/api/admin/v2/donations/orders/{id}
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
]
}
]URI Parameters
- id
number(required)ID of the donation order
GET /api/admin/v2/donations/gifts
Responses
List of Donation Gifts made
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Donation Order ID"
},
"external_id": {
"type": "string",
"description": "Donation Order external ID (for external systems)"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "User ID linked to this Donation Order"
},
"campaign_id": {
"type": "integer",
"format": "int32",
"description": "Donation Campaign ID linked to this Donation Order"
},
"receipt_id": {
"type": "integer",
"format": "int32",
"description": "Receipt ID linked to this Donation Order"
},
"gift_ids": {
"type": "integer",
"format": "int32",
"description": "Gifts ID linked to this Donation Order"
},
"parent_id": {
"type": "integer",
"format": "int32",
"description": "In case of a recurring donation, this is the ID of the previous Donation Order ID"
},
"promotion_code": {
"type": "string",
"description": "Promotion code linked to the Donation Order (permit to link to the order which marketing campaign led to the Donation)"
},
"tax_number": {
"type": "string",
"description": "Tax number linked to this Order"
},
"billing_address": {
"description": "Billing address of the Donor",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"address_1": {
"type": "string",
"description": "Address line 1"
},
"address_2": {
"type": "string",
"description": "Address line 2"
},
"address_3": {
"type": "string",
"description": "Address line 3"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "State"
},
"full_name": {
"type": "string",
"description": "Full name"
},
"postal_code": {
"type": "string",
"description": "Zip code"
},
"country": {
"type": "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"
],
"description": "Country"
},
"default_billing_address": {
"type": "boolean",
"description": "is the default billing address for the user ?"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Postal address creation date time - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Postal address last update date time - iso8601"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "User ID linked to postal address"
}
}
},
"firstname": {
"type": "string",
"description": "Firstname of the Donor"
},
"lastname": {
"type": "string",
"description": "Lastname of the Donor"
},
"maidenname": {
"type": "string",
"description": "Maindenname of the Donor"
},
"prefix_name": {
"type": "string",
"description": "Prefix name of the Donor"
},
"mobile_pro": {
"type": "string",
"description": "Professionel mobile phone number of the Donor"
},
"mobile_perso": {
"type": "string",
"description": "Personal mobile phone number of the Donor"
},
"email": {
"type": "string",
"description": "Email of the Donor"
},
"in_memory_of": {
"type": "boolean",
"description": "is the Donation in memory of someone/something ?"
},
"on_behalf_of": {
"type": "boolean",
"description": "is the Donation on behalf of someone/something ?"
},
"in_honor_of": {
"type": "boolean",
"description": "is the Donation in honor of someone/something ?"
},
"dedication_title": {
"type": "string",
"description": "To whom (or what) the Donation is dedicated"
},
"dedication_description": {
"type": "string",
"description": "A description of why/contact information for the Dedication"
},
"amount": {
"type": "number",
"format": "float",
"description": "Amount of the Donation"
},
"currency": {
"type": "string",
"description": "Currency of the Donation"
},
"recurring_payment_enabled": {
"type": "boolean",
"description": "Is the Donation recurrent ?"
},
"lifelong_payment_enabled": {
"type": "boolean",
"description": "Is the Donation a lifelong recurring payment ?"
},
"recurring_payments_left": {
"type": "integer",
"format": "int32",
"description": "How many times it has to be charged again ?"
},
"periodicity": {
"type": "string",
"enum": [
"week",
"two_weeks",
"month",
"three_months",
"six_months",
"year"
],
"description": "Periodicity of the Donation"
},
"send_confirmation_email": {
"type": "boolean",
"description": "Is the confirmation email to be send to the user ?"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Donation Order creation date - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Donation Order update date - iso8601"
},
"discarded_at": {
"type": "string",
"format": "date-time",
"description": "Donation Order deletion date - iso8601"
},
"customizable_attributes": {
"type": "array",
"items": {
"type": "object"
},
"description": "Array of customizable attributes with name and value"
},
"hep_information": {
"type": "object",
"description": "HEP Mapping informations"
},
"payment_status": {
"type": "string",
"description": "Status of the payment (not applicable if recurring)"
},
"submitted_by": {
"description": "Submitter Information",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Submitter ID"
},
"type": {
"type": "string",
"description": "Submitter type"
}
}
}
},
"description": "DonationOrderEntity model"
}List of Donation Gifts madeGET/api/admin/v2/donations/gifts
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"
}URI Parameters
- updated_since
string(required)
GET /api/admin/v2/donations/gifts/id
Responses
Get a Donation Gift
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Donation Gift ID"
},
"fund_id": {
"type": "integer",
"format": "int32",
"description": "Donation Fund ID linked to this Donation Gift"
},
"order_id": {
"type": "integer",
"format": "int32",
"description": "Donation Order ID linked to this Donation Gift"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "User ID linked to this Donation Gift"
},
"campaign_id": {
"type": "integer",
"format": "int32",
"description": "Donation Campaign ID linked to this Donation Gift"
},
"amount": {
"type": "number",
"format": "float",
"description": "Amount of the Donation"
},
"custom_fund": {
"type": "string",
"description": "Name of the \"other\" fund chosen"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Donation Gift creation date - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Donation Gift update date - iso8601"
},
"discarded_at": {
"type": "string",
"format": "date-time",
"description": "Donation Gift deletion date - iso8601"
}
},
"description": "DonationGiftEntity model"
}Get a Donation GiftGET/api/admin/v2/donations/gifts/{id}
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)
URI Parameters
- id
number(required)
GET /api/admin/v2/donations/campaigns/campaign_id/funds/fund_id
Responses
Update Fund Configuration for a Campaign
Schema
{
"type": "object",
"properties": {
"campaign_id": {
"type": "integer",
"format": "int32",
"description": "Donation Campaign associated to this Configuration"
},
"fund_id": {
"type": "integer",
"format": "int32",
"description": "Donation Fund associated to this Configuration"
},
"visible": {
"type": "boolean",
"description": "Donation fund will be visible in the list for the given Campaign"
},
"pinned": {
"type": "boolean",
"description": "Donation fund will be highlighted in the list for the given Campaign"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Configuration creation date - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Configuration update date - iso8601"
}
},
"description": "FundConfigurationEntity model"
}Update Fund Configuration for a CampaignGET/api/admin/v2/donations/campaigns/{campaign_id}/funds/{fund_id}
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
URI Parameters
- campaign_id
number(required)- fund_id
number(required)
PUT /api/admin/v2/donations/campaigns/campaign_id/funds/fund_id
Requests
Body
{
"fund_configuration[visible]": true,
"fund_configuration[pinned]": true
}Schema
{
"type": "object",
"properties": {
"fund_configuration[visible]": {
"type": "boolean",
"description": "Donation fund will be visible in the list for the given Campaign"
},
"fund_configuration[pinned]": {
"type": "boolean",
"description": "Donation fund will be highlighted in the list for the given Campaign"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Update Fund Configuration for a Campaign
Schema
{
"type": "object",
"properties": {
"campaign_id": {
"type": "integer",
"format": "int32",
"description": "Donation Campaign associated to this Configuration"
},
"fund_id": {
"type": "integer",
"format": "int32",
"description": "Donation Fund associated to this Configuration"
},
"visible": {
"type": "boolean",
"description": "Donation fund will be visible in the list for the given Campaign"
},
"pinned": {
"type": "boolean",
"description": "Donation fund will be highlighted in the list for the given Campaign"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Configuration creation date - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Configuration update date - iso8601"
}
},
"description": "FundConfigurationEntity model"
}Update Fund Configuration for a CampaignPUT/api/admin/v2/donations/campaigns/{campaign_id}/funds/{fund_id}
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
URI Parameters
- campaign_id
number(required)- fund_id
number(required)
me ¶
Operations about mes
GET /api/admin/v1/me
Responses
Get information about the current admin
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"email": {
"type": "string",
"description": "Admin email"
},
"name": {
"type": "string",
"description": "Admin full name"
},
"admin_type": {
"type": "string",
"enum": [
"global",
"group"
],
"description": "Admin type"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Admin creation date"
}
},
"description": "Admin model"
}Get information about the current adminGET/api/admin/v1/me
Current admin is the owner of the access_token used in the request.
settings ¶
Operations about settings
GET /api/admin/v1/settings/customizable_attributes
Responses
Get all customizable attributes
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"customizable_id": {
"type": "integer",
"format": "int32",
"description": "Customizable ID"
},
"type": {
"type": "string",
"enum": [
"CustomizableAttribute::Boolean",
"CustomizableAttribute::Date",
"CustomizableAttribute::DoubleSelect",
"CustomizableAttribute::Number",
"CustomizableAttribute::Select",
"CustomizableAttribute::Text"
],
"description": "Customizable Attribute type"
},
"customizable_type": {
"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",
"mentorships",
"mentorships_mentee",
"mentorships_mentor",
"ne_event",
"ne_ticket",
"topic_approval",
"topic_mentorships",
"topic_mentorships_mentee",
"topic_mentorships_mentor",
"user",
"ventures_venture"
],
"description": "Customizable Attribute associated model (User, Experience)"
},
"name": {
"type": "string",
"description": "Customizable Attribute name"
},
"display_name": {
"type": "string",
"description": "Customizable Attribute displayed name"
},
"tooltip": {
"type": "string",
"description": "Customizable Attribute tooltip"
},
"placeholder": {
"type": "string",
"description": "Customizable Attribute placeholder"
},
"multi": {
"type": "boolean",
"description": "Customizable Attribute multi activated ?"
},
"text_size": {
"type": "integer",
"format": "int32",
"description": "Customizable Attribute text_size"
},
"visibility": {
"type": "string",
"enum": [
"admin_only",
"tagged_user",
"everybody",
"not_visible"
],
"description": "Customizable Attribute visibility"
},
"user_editable": {
"type": "boolean",
"description": "Customizable Attribute editable by the user ?"
},
"required": {
"type": "boolean",
"description": "Customizable Attribute required ?"
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "Customizable Attribute array of options"
},
"json_options": {
"type": "object",
"description": "Customizable Attribute json options (for double select)"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Customizable Attribute creation date"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Customizable Attribute last update date"
},
"selected_value": {
"type": "string",
"description": "Customizable Attribute selected value"
}
},
"description": "CustomizableAttribute model"
}Get all customizable attributesGET/api/admin/v1/settings/customizable_attributes
Return this network customizable attributes.
URI Parameters
- customized_type
string(required)- customizable_id
string(required)
GET /api/admin/v1/settings/field_of_studies
Responses
Get all field of studies
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"name": {
"type": "string",
"description": "Field of study name"
}
},
"description": "FieldOfStudy model"
}Get all field of studiesGET/api/admin/v1/settings/field_of_studies
Return this network field of studies.
POST /api/admin/v1/settings/field_of_studies
Requests
Body
{
"field_of_study[name]": "Hello, world!"
}Schema
{
"type": "object",
"properties": {
"field_of_study[name]": {
"type": "string",
"description": "Name of the field of study"
}
},
"required": [
"field_of_study[name]"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Create a field of study
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"name": {
"type": "string",
"description": "Field of study name"
}
},
"description": "FieldOfStudy model"
}Create a field of studyPOST/api/admin/v1/settings/field_of_studies
Return the created field of study if none with the same name exists. Returns the existing field of study otherwise
GET /api/admin/v1/settings/industries
Responses
Get all industries
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"name": {
"type": "string",
"description": "Industry name"
}
},
"description": "IndustryStudy model"
}Get all industriesGET/api/admin/v1/settings/industries
Return this network industries.
GET /api/admin/v1/settings/job_functions
Responses
Get all job functions
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"identifier": {
"type": "string",
"description": "Job function name"
}
},
"description": "JobFunction model"
}Get all job functionsGET/api/admin/v1/settings/job_functions
Return this network job functions.
GET /api/admin/v1/settings/currencies
Responses
Get Network Currencies
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"name": {
"type": "string",
"description": "Currency name"
},
"code": {
"type": "string",
"description": "Currency code"
},
"symbol": {
"type": "string",
"description": "Currency symbol"
}
},
"description": "Currency model"
}Get Network CurrenciesGET/api/admin/v1/settings/currencies
Return this network enabled currencies.
network ¶
Operations about networks
GET /api/admin/v1/network
Responses
Get network information
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"title": {
"type": "string",
"description": "Sub Network title"
},
"sub_networks": {
"description": "Sub Networks list",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"title": {
"type": "string",
"description": "Sub Network title"
}
}
},
"user_lists": {
"description": "User lists",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"title": {
"type": "string",
"description": "List title"
},
"description": {
"type": "string",
"description": "List description"
},
"user_count": {
"type": "integer",
"format": "int32",
"description": "Number of users part of the list"
}
}
}
},
"required": [
"title",
"sub_networks",
"user_lists"
],
"description": "Network model"
}Get network informationGET/api/admin/v1/network
Return this network information.
POST /api/admin/v1/network/sub_networks
Requests
Body
{
"title": "Hello, world!"
}Schema
{
"type": "object",
"properties": {
"title": {
"type": "string"
}
},
"required": [
"title"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Add a new sub network
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"title": {
"type": "string",
"description": "Sub Network title"
}
},
"description": "SubNetwork model"
}Add a new sub networkPOST/api/admin/v1/network/sub_networks
Return the created sub network
PUT /api/admin/v1/network/sub_networks/id
Requests
Body
{
"sub_network[title]": "Hello, world!"
}Schema
{
"type": "object",
"properties": {
"sub_network[title]": {
"type": "string"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Update a sub network
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"title": {
"type": "string",
"description": "Sub Network title"
}
},
"description": "SubNetwork model"
}Update a sub networkPUT/api/admin/v1/network/sub_networks/{id}
Return the updated sub network
URI Parameters
- id
string(required)
DELETE /api/admin/v1/network/sub_networks/id
Responses
Delete a new sub network
Delete a new sub networkDELETE/api/admin/v1/network/sub_networks/{id}
Delete a sub network
URI Parameters
- id
string(required)
GET /api/admin/v1/network/citizenships
Responses
List all citizenships
Schema
{
"type": "object",
"properties": {
"citizenships": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"name": {
"type": "string",
"description": "Country"
},
"code": {
"type": "string",
"description": "Country code ISO Alpha 2"
}
}
}
}
},
"description": "Nationalities model"
}List all citizenshipsGET/api/admin/v1/network/citizenships
Return all citizenships
users ¶
Operations about users
POST /api/admin/v1/users/user_id/activate
Requests
Body
{
"key": "Hello, world!"
}Schema
{
"type": "object",
"properties": {
"key": {
"type": "string"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Activate user account
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"name": {
"type": "string",
"description": "User name"
},
"external_id": {
"type": "string",
"description": "User ID in your database"
},
"previous_id": {
"type": "string",
"description": "User ID in your community system"
},
"sso_identifier": {
"type": "string",
"description": "User identifier for SSO"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "User creation date time - iso8601. READ only, can't be updated"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "User last update date time - iso8601. READ only, can't be updated"
},
"confirmed_at": {
"type": "string",
"format": "date-time",
"description": "User activation date time - iso8601. READ only, can't be updated"
},
"terms_accepted_at": {
"type": "string",
"format": "date-time",
"description": "User terms accepted date time - iso8601. READ only, can't be updated"
},
"terms_accepted": {
"type": "boolean",
"description": "User terms accepted READ only, can't be updated"
},
"policies_accepted_at": {
"type": "string",
"format": "date-time",
"description": "User policies accepted date time - iso8601. READ only, can't be updated"
},
"policies_accepted": {
"type": "boolean",
"description": "User policies accepted READ only, can't be updated"
}
},
"description": "Activate model"
}Activate user accountPOST/api/admin/v1/users/{user_id}/activate
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
URI Parameters
- user_id
number(required)
GET /api/admin/v1/users/user_id/experiences?key=&page=&per_page=
Responses
Get all user experiences
Schema
{
"type": "object",
"properties": {
"experiences": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"position": {
"type": "string",
"description": "Experience position"
},
"from": {
"type": "string",
"format": "date",
"description": "Experience started at"
},
"to": {
"type": "string",
"format": "date",
"description": "Experience ended at"
},
"companies_company_id": {
"type": "string",
"description": "ID of company linked"
},
"custom_attributes": {
"type": "array",
"items": {
"type": "object"
},
"description": "Array of customizable attributes with name, value and type"
},
"industry_id": {
"type": "integer",
"format": "int32",
"description": "Industry ID matching the experience"
},
"job_function_id": {
"type": "integer",
"format": "int32",
"description": "Job Function ID matching the experience"
},
"external_id": {
"type": "string",
"description": "Experience ID in your database"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Experience creation date"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Experience last update date time - iso8601"
}
},
"description": "ExperienceCompact model"
}
}
},
"description": "Experiences model"
}Get all user experiencesGET/api/admin/v1/users/{user_id}/experiences{?key,page,per_page}
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"
}URI Parameters
- user_id
number(required)- key
string(required)- page
string(required)Page of results to fetch.
- per_page
string(required)Number of results to return per page.
POST /api/admin/v1/users/user_id/experiences
Requests
Body
{
"key": "Hello, world!",
"experience[position]": "Hello, world!",
"experience[companies_company_id]": "Hello, world!",
"experience[companies_company_key]": "Hello, world!",
"experience[from]": "Hello, world!",
"experience[to]": "Hello, world!",
"experience[custom_attributes][]": [],
"experience[industry_id]": 1,
"experience[job_function_id]": 1,
"experience[external_id]": "Hello, world!"
}Schema
{
"type": "object",
"properties": {
"key": {
"type": "string"
},
"experience[position]": {
"type": "string",
"description": "User position"
},
"experience[companies_company_id]": {
"type": "string",
"description": "Company linked to experience"
},
"experience[companies_company_key]": {
"type": "string"
},
"experience[from]": {
"type": "string",
"description": "Experience started at"
},
"experience[to]": {
"type": "string",
"description": "Experience ended at"
},
"experience[custom_attributes][]": {
"type": "array",
"description": "Array of customizable attributes with name, value and type\n\n+"
},
"experience[industry_id]": {
"type": "number",
"description": "Industry ID matching the experience"
},
"experience[job_function_id]": {
"type": "number",
"description": "Job Function ID matching the experience"
},
"experience[external_id]": {
"type": "string",
"description": "Experience ID in your database"
}
},
"required": [
"experience[position]",
"experience[companies_company_id]"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Add a new experience
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"position": {
"type": "string",
"description": "Experience position"
},
"from": {
"type": "string",
"format": "date",
"description": "Experience started at"
},
"to": {
"type": "string",
"format": "date",
"description": "Experience ended at"
},
"companies_company_id": {
"type": "string",
"description": "ID of company linked"
},
"custom_attributes": {
"type": "array",
"items": {
"type": "object"
},
"description": "Array of customizable attributes with name, value and type"
},
"industry_id": {
"type": "integer",
"format": "int32",
"description": "Industry ID matching the experience"
},
"job_function_id": {
"type": "integer",
"format": "int32",
"description": "Job Function ID matching the experience"
},
"external_id": {
"type": "string",
"description": "Experience ID in your database"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Experience creation date"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Experience last update date time - iso8601"
}
},
"description": "ExperienceCompact model"
}Validations Failed
Schema
{
"type": "object",
"properties": {
"status": {
"type": "integer",
"format": "int32",
"description": "Status Code"
},
"errors": {
"type": "string",
"description": "Errors list"
}
},
"description": "Error model"
}Add a new experiencePOST/api/admin/v1/users/{user_id}/experiences
Return the created experience.
URI Parameters
- user_id
number(required)
GET /api/admin/v1/users/user_id/experiences/id?key=&experience_key=
Responses
Get user experience
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"position": {
"type": "string",
"description": "Experience position"
},
"from": {
"type": "string",
"format": "date",
"description": "Experience started at"
},
"to": {
"type": "string",
"format": "date",
"description": "Experience ended at"
},
"companies_company_id": {
"type": "string",
"description": "ID of company linked"
},
"custom_attributes": {
"type": "array",
"items": {
"type": "object"
},
"description": "Array of customizable attributes with name, value and type"
},
"industry_id": {
"type": "integer",
"format": "int32",
"description": "Industry ID matching the experience"
},
"job_function_id": {
"type": "integer",
"format": "int32",
"description": "Job Function ID matching the experience"
},
"external_id": {
"type": "string",
"description": "Experience ID in your database"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Experience creation date"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Experience last update date time - iso8601"
}
},
"description": "ExperienceCompact model"
}Get user experienceGET/api/admin/v1/users/{user_id}/experiences/{id}{?key,experience_key}
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.
URI Parameters
- user_id
number(required)- id
number(required)- key
string(required)- experience_key
string(required)
PUT /api/admin/v1/users/user_id/experiences/id
Requests
Body
{
"key": "Hello, world!",
"experience_key": "Hello, world!",
"experience[companies_company_key]": "Hello, world!",
"experience[position]": "Hello, world!",
"experience[from]": "Hello, world!",
"experience[to]": "Hello, world!",
"experience[companies_company_id]": "Hello, world!",
"experience[custom_attributes][]": [],
"experience[industry_id]": 1,
"experience[job_function_id]": 1,
"experience[external_id]": "Hello, world!"
}Schema
{
"type": "object",
"properties": {
"key": {
"type": "string"
},
"experience_key": {
"type": "string"
},
"experience[companies_company_key]": {
"type": "string"
},
"experience[position]": {
"type": "string",
"description": "Experience position"
},
"experience[from]": {
"type": "string",
"description": "Experience started at"
},
"experience[to]": {
"type": "string",
"description": "Experience ended at"
},
"experience[companies_company_id]": {
"type": "string",
"description": "ID of company linked"
},
"experience[custom_attributes][]": {
"type": "array",
"description": "Array of customizable attributes with name, value and type\n\n+"
},
"experience[industry_id]": {
"type": "number",
"description": "Industry ID matching the experience"
},
"experience[job_function_id]": {
"type": "number",
"description": "Job Function ID matching the experience"
},
"experience[external_id]": {
"type": "string",
"description": "Experience ID in your database"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Update existing user experience
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"position": {
"type": "string",
"description": "Experience position"
},
"from": {
"type": "string",
"format": "date",
"description": "Experience started at"
},
"to": {
"type": "string",
"format": "date",
"description": "Experience ended at"
},
"companies_company_id": {
"type": "string",
"description": "ID of company linked"
},
"custom_attributes": {
"type": "array",
"items": {
"type": "object"
},
"description": "Array of customizable attributes with name, value and type"
},
"industry_id": {
"type": "integer",
"format": "int32",
"description": "Industry ID matching the experience"
},
"job_function_id": {
"type": "integer",
"format": "int32",
"description": "Job Function ID matching the experience"
},
"external_id": {
"type": "string",
"description": "Experience ID in your database"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Experience creation date"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Experience last update date time - iso8601"
}
},
"description": "ExperienceCompact model"
}Validations Failed
Schema
{
"type": "object",
"properties": {
"status": {
"type": "integer",
"format": "int32",
"description": "Status Code"
},
"errors": {
"type": "string",
"description": "Errors list"
}
},
"description": "Error model"
}Update existing user experiencePUT/api/admin/v1/users/{user_id}/experiences/{id}
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.
URI Parameters
- user_id
number(required)- id
string(required)Experience ID
DELETE /api/admin/v1/users/user_id/experiences/id?key=&experience_key=
Responses
Delete User experience
Delete User experienceDELETE/api/admin/v1/users/{user_id}/experiences/{id}{?key,experience_key}
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.
URI Parameters
- user_id
number(required)- id
string(required)- key
string(required)- experience_key
string(required)
POST /api/admin/v1/users/user_id/experiences/_bulk
Requests
Body
{
"key": "Hello, world!",
"experiences[][position]": [],
"experiences[][companies_company_id]": [],
"experiences[][companies_company_key]": [],
"experiences[][from]": [],
"experiences[][to]": [],
"experiences[][custom_attributes][]": [],
"experiences[][industry_id]": [
1
],
"experiences[][job_function_id]": [
1
],
"experiences[][external_id]": []
}Schema
{
"type": "object",
"properties": {
"key": {
"type": "string"
},
"experiences[][position]": {
"type": "array",
"description": "User position\n\n+"
},
"experiences[][companies_company_id]": {
"type": "array",
"description": "Company linked to experience\n\n+"
},
"experiences[][companies_company_key]": {
"type": "array",
"description": "+"
},
"experiences[][from]": {
"type": "array",
"description": "Experience started at\n\n+"
},
"experiences[][to]": {
"type": "array",
"description": "Experience ended at\n\n+"
},
"experiences[][custom_attributes][]": {
"type": "array",
"description": "Array of customizable attributes with name, value and type\n\n+"
},
"experiences[][industry_id]": {
"type": "array",
"items": {
"type": "number"
},
"description": "Industry ID matching the experience"
},
"experiences[][job_function_id]": {
"type": "array",
"items": {
"type": "number"
},
"description": "Job Function ID matching the experience"
},
"experiences[][external_id]": {
"type": "array",
"description": "Experience ID in your database\n\n+"
}
},
"required": [
"experiences[][position]",
"experiences[][companies_company_id]"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Bulk add experiences
Schema
{
"type": "object",
"properties": {
"experiences": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"position": {
"type": "string",
"description": "Experience position"
},
"from": {
"type": "string",
"format": "date",
"description": "Experience started at"
},
"to": {
"type": "string",
"format": "date",
"description": "Experience ended at"
},
"companies_company_id": {
"type": "string",
"description": "ID of company linked"
},
"custom_attributes": {
"type": "array",
"items": {
"type": "object"
},
"description": "Array of customizable attributes with name, value and type"
},
"industry_id": {
"type": "integer",
"format": "int32",
"description": "Industry ID matching the experience"
},
"job_function_id": {
"type": "integer",
"format": "int32",
"description": "Job Function ID matching the experience"
},
"external_id": {
"type": "string",
"description": "Experience ID in your database"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Experience creation date"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Experience last update date time - iso8601"
}
},
"description": "ExperienceCompact model"
}
}
},
"description": "Experiences model"
}Validations Failed
Schema
{
"type": "object",
"properties": {
"status": {
"type": "integer",
"format": "int32",
"description": "Status Code"
},
"errors": {
"type": "string",
"description": "Errors list"
}
},
"description": "Error model"
}Bulk add experiencesPOST/api/admin/v1/users/{user_id}/experiences/_bulk
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
URI Parameters
- user_id
number(required)
PUT /api/admin/v1/users/user_id/experiences/_bulk
Requests
Body
{
"key": "Hello, world!",
"experiences[][id]": [],
"experiences[][experience_key]": [],
"experiences[][companies_company_key]": [],
"experiences[][position]": [],
"experiences[][from]": [],
"experiences[][to]": [],
"experiences[][companies_company_id]": [],
"experiences[][custom_attributes][]": [],
"experiences[][industry_id]": [
1
],
"experiences[][job_function_id]": [
1
],
"experiences[][external_id]": []
}Schema
{
"type": "object",
"properties": {
"key": {
"type": "string"
},
"experiences[][id]": {
"type": "array",
"description": "Experience ID\n\n+"
},
"experiences[][experience_key]": {
"type": "array",
"description": "+"
},
"experiences[][companies_company_key]": {
"type": "array",
"description": "+"
},
"experiences[][position]": {
"type": "array",
"description": "Experience position\n\n+"
},
"experiences[][from]": {
"type": "array",
"description": "Experience started at\n\n+"
},
"experiences[][to]": {
"type": "array",
"description": "Experience ended at\n\n+"
},
"experiences[][companies_company_id]": {
"type": "array",
"description": "ID of company linked\n\n+"
},
"experiences[][custom_attributes][]": {
"type": "array",
"description": "Array of customizable attributes with name, value and type\n\n+"
},
"experiences[][industry_id]": {
"type": "array",
"items": {
"type": "number"
},
"description": "Industry ID matching the experience"
},
"experiences[][job_function_id]": {
"type": "array",
"items": {
"type": "number"
},
"description": "Job Function ID matching the experience"
},
"experiences[][external_id]": {
"type": "array",
"description": "Experience ID in your database\n\n+"
}
},
"required": [
"experiences[][id]"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Bulk update of existing user experiences
Schema
{
"type": "object",
"properties": {
"experiences": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"position": {
"type": "string",
"description": "Experience position"
},
"from": {
"type": "string",
"format": "date",
"description": "Experience started at"
},
"to": {
"type": "string",
"format": "date",
"description": "Experience ended at"
},
"companies_company_id": {
"type": "string",
"description": "ID of company linked"
},
"custom_attributes": {
"type": "array",
"items": {
"type": "object"
},
"description": "Array of customizable attributes with name, value and type"
},
"industry_id": {
"type": "integer",
"format": "int32",
"description": "Industry ID matching the experience"
},
"job_function_id": {
"type": "integer",
"format": "int32",
"description": "Job Function ID matching the experience"
},
"external_id": {
"type": "string",
"description": "Experience ID in your database"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Experience creation date"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Experience last update date time - iso8601"
}
},
"description": "ExperienceCompact model"
}
}
},
"description": "Experiences model"
}Validations Failed
Schema
{
"type": "object",
"properties": {
"status": {
"type": "integer",
"format": "int32",
"description": "Status Code"
},
"errors": {
"type": "string",
"description": "Errors list"
}
},
"description": "Error model"
}Bulk update of existing user experiencesPUT/api/admin/v1/users/{user_id}/experiences/_bulk
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
URI Parameters
- user_id
number(required)
GET /api/admin/v1/users/user_id/educations?key=&page=&per_page=
Responses
Get all user educations
Schema
{
"type": "object",
"properties": {
"educations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"school_name": {
"type": "string",
"description": "Education school"
},
"degree": {
"type": "string",
"description": "Education degree"
},
"from": {
"type": "string",
"format": "date",
"description": "Education started at"
},
"to": {
"type": "string",
"format": "date",
"description": "Education ended at"
},
"custom_attributes": {
"type": "array",
"items": {
"type": "object"
},
"description": "Array of customizable attributes with name, value and type"
},
"field_of_study_id": {
"type": "integer",
"format": "int32",
"description": "Field of study ID matching the education"
},
"field_of_study_name": {
"type": "string",
"description": "Field of study name (from Field of study Object linked)"
},
"external_id": {
"type": "string",
"description": "Education ID in your database"
},
"user_can_edit": {
"type": "boolean",
"description": "Is this education editable by the user"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Education creation date"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Education last update date time - iso8601"
}
},
"description": "EducationCompact model"
}
}
},
"description": "Educations model"
}Get all user educationsGET/api/admin/v1/users/{user_id}/educations{?key,page,per_page}
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"
}URI Parameters
- user_id
number(required)- key
string(required)- page
string(required)Page of results to fetch.
- per_page
string(required)Number of results to return per page.
POST /api/admin/v1/users/user_id/educations
Requests
Body
{
"key": "Hello, world!",
"education[school_name]": "Hello, world!",
"education[degree]": "Hello, world!",
"education[from]": "Hello, world!",
"education[to]": "Hello, world!",
"education[custom_attributes][]": [],
"education[field_of_study_id]": 1,
"education[field_of_study_name]": "Hello, world!",
"education[external_id]": "Hello, world!",
"education[user_can_edit]": true
}Schema
{
"type": "object",
"properties": {
"key": {
"type": "string"
},
"education[school_name]": {
"type": "string",
"description": "School name"
},
"education[degree]": {
"type": "string",
"description": "Education degree"
},
"education[from]": {
"type": "string",
"description": "Education started at"
},
"education[to]": {
"type": "string",
"description": "Education ended at"
},
"education[custom_attributes][]": {
"type": "array",
"description": "Array of customizable attributes with name, value and type\n\n+"
},
"education[field_of_study_id]": {
"type": "number",
"description": "Field of study ID matching the education"
},
"education[field_of_study_name]": {
"type": "string",
"description": "Field of study name (from Field of study Object linked)"
},
"education[external_id]": {
"type": "string",
"description": "Education ID in your database"
},
"education[user_can_edit]": {
"type": "boolean",
"description": "Is this education editable by the user"
}
},
"required": [
"education[school_name]"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Add a new education
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"school_name": {
"type": "string",
"description": "Education school"
},
"degree": {
"type": "string",
"description": "Education degree"
},
"from": {
"type": "string",
"format": "date",
"description": "Education started at"
},
"to": {
"type": "string",
"format": "date",
"description": "Education ended at"
},
"custom_attributes": {
"type": "array",
"items": {
"type": "object"
},
"description": "Array of customizable attributes with name, value and type"
},
"field_of_study_id": {
"type": "integer",
"format": "int32",
"description": "Field of study ID matching the education"
},
"field_of_study_name": {
"type": "string",
"description": "Field of study name (from Field of study Object linked)"
},
"external_id": {
"type": "string",
"description": "Education ID in your database"
},
"user_can_edit": {
"type": "boolean",
"description": "Is this education editable by the user"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Education creation date"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Education last update date time - iso8601"
}
},
"description": "EducationCompact model"
}Validations Failed
Schema
{
"type": "object",
"properties": {
"status": {
"type": "integer",
"format": "int32",
"description": "Status Code"
},
"errors": {
"type": "string",
"description": "Errors list"
}
},
"description": "Error model"
}Add a new educationPOST/api/admin/v1/users/{user_id}/educations
Return the created education.
URI Parameters
- user_id
number(required)
GET /api/admin/v1/users/user_id/educations/id?key=&education_key=
Responses
Get user education
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"school_name": {
"type": "string",
"description": "Education school"
},
"degree": {
"type": "string",
"description": "Education degree"
},
"from": {
"type": "string",
"format": "date",
"description": "Education started at"
},
"to": {
"type": "string",
"format": "date",
"description": "Education ended at"
},
"custom_attributes": {
"type": "array",
"items": {
"type": "object"
},
"description": "Array of customizable attributes with name, value and type"
},
"field_of_study_id": {
"type": "integer",
"format": "int32",
"description": "Field of study ID matching the education"
},
"field_of_study_name": {
"type": "string",
"description": "Field of study name (from Field of study Object linked)"
},
"external_id": {
"type": "string",
"description": "Education ID in your database"
},
"user_can_edit": {
"type": "boolean",
"description": "Is this education editable by the user"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Education creation date"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Education last update date time - iso8601"
}
},
"description": "EducationCompact model"
}Get user educationGET/api/admin/v1/users/{user_id}/educations/{id}{?key,education_key}
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.
URI Parameters
- user_id
number(required)- id
number(required)- key
string(required)- education_key
string(required)
PUT /api/admin/v1/users/user_id/educations/id
Requests
Body
{
"key": "Hello, world!",
"education_key": "Hello, world!",
"education[degree]": "Hello, world!",
"education[from]": "Hello, world!",
"education[to]": "Hello, world!",
"education[custom_attributes][]": [],
"education[field_of_study_id]": 1,
"education[field_of_study_name]": "Hello, world!",
"education[external_id]": "Hello, world!",
"education[user_can_edit]": true
}Schema
{
"type": "object",
"properties": {
"key": {
"type": "string"
},
"education_key": {
"type": "string"
},
"education[degree]": {
"type": "string",
"description": "Education degree"
},
"education[from]": {
"type": "string",
"description": "Education started at"
},
"education[to]": {
"type": "string",
"description": "Education ended at"
},
"education[custom_attributes][]": {
"type": "array",
"description": "Array of customizable attributes with name, value and type\n\n+"
},
"education[field_of_study_id]": {
"type": "number",
"description": "Field of study ID matching the education"
},
"education[field_of_study_name]": {
"type": "string",
"description": "Field of study name (from Field of study Object linked)"
},
"education[external_id]": {
"type": "string",
"description": "Education ID in your database"
},
"education[user_can_edit]": {
"type": "boolean",
"description": "Is this education editable by the user"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Update existing user education
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"school_name": {
"type": "string",
"description": "Education school"
},
"degree": {
"type": "string",
"description": "Education degree"
},
"from": {
"type": "string",
"format": "date",
"description": "Education started at"
},
"to": {
"type": "string",
"format": "date",
"description": "Education ended at"
},
"custom_attributes": {
"type": "array",
"items": {
"type": "object"
},
"description": "Array of customizable attributes with name, value and type"
},
"field_of_study_id": {
"type": "integer",
"format": "int32",
"description": "Field of study ID matching the education"
},
"field_of_study_name": {
"type": "string",
"description": "Field of study name (from Field of study Object linked)"
},
"external_id": {
"type": "string",
"description": "Education ID in your database"
},
"user_can_edit": {
"type": "boolean",
"description": "Is this education editable by the user"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Education creation date"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Education last update date time - iso8601"
}
},
"description": "EducationCompact model"
}Validations Failed
Schema
{
"type": "object",
"properties": {
"status": {
"type": "integer",
"format": "int32",
"description": "Status Code"
},
"errors": {
"type": "string",
"description": "Errors list"
}
},
"description": "Error model"
}Update existing user educationPUT/api/admin/v1/users/{user_id}/educations/{id}
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.
URI Parameters
- user_id
number(required)- id
string(required)Education ID
DELETE /api/admin/v1/users/user_id/educations/id?key=&education_key=
Responses
Delete User education
Delete User educationDELETE/api/admin/v1/users/{user_id}/educations/{id}{?key,education_key}
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.URI Parameters
- user_id
number(required)- id
string(required)- key
string(required)- education_key
string(required)
POST /api/admin/v1/users/user_id/educations/_bulk
Requests
Body
{
"key": "Hello, world!",
"educations[][school_name]": [],
"educations[][degree]": [],
"educations[][from]": [],
"educations[][to]": [],
"educations[][custom_attributes][]": [],
"educations[][field_of_study_id]": [
1
],
"educations[][field_of_study_name]": [],
"educations[][external_id]": [],
"educations[][user_can_edit]": [
true
]
}Schema
{
"type": "object",
"properties": {
"key": {
"type": "string"
},
"educations[][school_name]": {
"type": "array",
"description": "School name\n\n+"
},
"educations[][degree]": {
"type": "array",
"description": "Education degree\n\n+"
},
"educations[][from]": {
"type": "array",
"description": "Education started at\n\n+"
},
"educations[][to]": {
"type": "array",
"description": "Education ended at\n\n+"
},
"educations[][custom_attributes][]": {
"type": "array",
"description": "Array of customizable attributes with name, value and type\n\n+"
},
"educations[][field_of_study_id]": {
"type": "array",
"items": {
"type": "number"
},
"description": "Field of study ID matching the education"
},
"educations[][field_of_study_name]": {
"type": "array",
"description": "Field of study name (from Field of study Object linked)\n\n+"
},
"educations[][external_id]": {
"type": "array",
"description": "Education ID in your database\n\n+"
},
"educations[][user_can_edit]": {
"type": "array",
"items": {
"type": "boolean"
},
"description": "Is this education editable by the user"
}
},
"required": [
"educations[][school_name]"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Bulk add educations
Schema
{
"type": "object",
"properties": {
"educations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"school_name": {
"type": "string",
"description": "Education school"
},
"degree": {
"type": "string",
"description": "Education degree"
},
"from": {
"type": "string",
"format": "date",
"description": "Education started at"
},
"to": {
"type": "string",
"format": "date",
"description": "Education ended at"
},
"custom_attributes": {
"type": "array",
"items": {
"type": "object"
},
"description": "Array of customizable attributes with name, value and type"
},
"field_of_study_id": {
"type": "integer",
"format": "int32",
"description": "Field of study ID matching the education"
},
"field_of_study_name": {
"type": "string",
"description": "Field of study name (from Field of study Object linked)"
},
"external_id": {
"type": "string",
"description": "Education ID in your database"
},
"user_can_edit": {
"type": "boolean",
"description": "Is this education editable by the user"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Education creation date"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Education last update date time - iso8601"
}
},
"description": "EducationCompact model"
}
}
},
"description": "Educations model"
}Validations Failed
Schema
{
"type": "object",
"properties": {
"status": {
"type": "integer",
"format": "int32",
"description": "Status Code"
},
"errors": {
"type": "string",
"description": "Errors list"
}
},
"description": "Error model"
}Bulk add educationsPOST/api/admin/v1/users/{user_id}/educations/_bulk
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
URI Parameters
- user_id
number(required)
PUT /api/admin/v1/users/user_id/educations/_bulk
Requests
Body
{
"key": "Hello, world!",
"educations[][education_key]": [],
"educations[][id]": [],
"educations[][degree]": [],
"educations[][from]": [],
"educations[][to]": [],
"educations[][custom_attributes][]": [],
"educations[][field_of_study_id]": [
1
],
"educations[][field_of_study_name]": [],
"educations[][external_id]": [],
"educations[][user_can_edit]": [
true
]
}Schema
{
"type": "object",
"properties": {
"key": {
"type": "string"
},
"educations[][education_key]": {
"type": "array",
"description": "+"
},
"educations[][id]": {
"type": "array",
"description": "Education ID\n\n+"
},
"educations[][degree]": {
"type": "array",
"description": "Education degree\n\n+"
},
"educations[][from]": {
"type": "array",
"description": "Education started at\n\n+"
},
"educations[][to]": {
"type": "array",
"description": "Education ended at\n\n+"
},
"educations[][custom_attributes][]": {
"type": "array",
"description": "Array of customizable attributes with name, value and type\n\n+"
},
"educations[][field_of_study_id]": {
"type": "array",
"items": {
"type": "number"
},
"description": "Field of study ID matching the education"
},
"educations[][field_of_study_name]": {
"type": "array",
"description": "Field of study name (from Field of study Object linked)\n\n+"
},
"educations[][external_id]": {
"type": "array",
"description": "Education ID in your database\n\n+"
},
"educations[][user_can_edit]": {
"type": "array",
"items": {
"type": "boolean"
},
"description": "Is this education editable by the user"
}
},
"required": [
"educations[][id]"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Bulk update of existing user educations
Schema
{
"type": "object",
"properties": {
"educations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"school_name": {
"type": "string",
"description": "Education school"
},
"degree": {
"type": "string",
"description": "Education degree"
},
"from": {
"type": "string",
"format": "date",
"description": "Education started at"
},
"to": {
"type": "string",
"format": "date",
"description": "Education ended at"
},
"custom_attributes": {
"type": "array",
"items": {
"type": "object"
},
"description": "Array of customizable attributes with name, value and type"
},
"field_of_study_id": {
"type": "integer",
"format": "int32",
"description": "Field of study ID matching the education"
},
"field_of_study_name": {
"type": "string",
"description": "Field of study name (from Field of study Object linked)"
},
"external_id": {
"type": "string",
"description": "Education ID in your database"
},
"user_can_edit": {
"type": "boolean",
"description": "Is this education editable by the user"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Education creation date"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Education last update date time - iso8601"
}
},
"description": "EducationCompact model"
}
}
},
"description": "Educations model"
}Validations Failed
Schema
{
"type": "object",
"properties": {
"status": {
"type": "integer",
"format": "int32",
"description": "Status Code"
},
"errors": {
"type": "string",
"description": "Errors list"
}
},
"description": "Error model"
}Bulk update of existing user educationsPUT/api/admin/v1/users/{user_id}/educations/_bulk
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
URI Parameters
- user_id
number(required)
GET /api/admin/v1/users/user_id/notification_settings?key=
Responses
Return all notification settings for this user
Schema
{
"type": "object",
"properties": {
"post_email": {
"type": "boolean",
"description": "Receive notifications for new posts"
},
"trip_email": {
"type": "boolean",
"description": "Receive notifications for new trips"
},
"event_email": {
"type": "boolean",
"description": "Receive notifications for new user events"
},
"digest_email": {
"type": "boolean",
"description": "Receive notifications for new digests"
},
"comment_email": {
"type": "boolean",
"description": "Receive notifications for new comments"
},
"ventures_comment_email": {
"type": "boolean",
"description": "Receive notifications for new ventures comments"
},
"businessopportunities_request": {
"type": "boolean",
"description": "Receive notifications for new business opportunities"
},
"current_location_email": {
"type": "boolean",
"description": "Receive notifications for new checkins"
},
"emailing_communication_email": {
"type": "boolean",
"description": "Consent to receive campaigns via email"
},
"forum_post_email": {
"type": "boolean",
"description": "Receive notifications for new forum posts"
},
"contact_by_phone": {
"type": "boolean",
"description": "Consent to receive campaigns via phone"
},
"contact_by_sms": {
"type": "boolean",
"description": "Consent to receive campaigns via SMS"
},
"contact_by_post": {
"type": "boolean",
"description": "Consent to receive campaigns via post"
},
"emailing_categories_subscribed": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"name": {
"type": "string",
"description": "Name of the category"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Category creation date time - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Category last update date time - iso8601"
}
},
"description": "NetworkCategory model"
},
"description": "Emailing campaigns categories subscribed"
},
"groups_notifications": {
"type": "array",
"items": {
"type": "object",
"properties": {
"topic_id": {
"type": "integer",
"format": "int32",
"description": "Group ID"
},
"notification_enabled": {
"type": "boolean",
"description": "Receives notifications upon activity in the group"
},
"group_activity_frequency": {
"type": "string",
"enum": [
"none",
"instant",
"daily",
"weekly"
],
"description": "Frequency to which the user receives notifications upon activity in the group"
},
"emailing_campaign_enabled": {
"type": "boolean",
"description": "Receives emailing campaign from administrators of the group"
},
"categories": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"name": {
"type": "string",
"description": "Name of the category"
}
},
"description": "NetworkCategoryCompact model"
},
"description": "Network categories linked to the group"
}
}
}
}
},
"description": "NotificationSettings model"
}Return all notification settings for this userGET/api/admin/v1/users/{user_id}/notification_settings{?key}
Return this user notification settings
URI Parameters
- user_id
number(required)- key
string(required)
PUT /api/admin/v1/users/user_id/notification_settings
Requests
Body
{
"key": "Hello, world!",
"notification_settings[emailing_categories_subscribed_ids][]": [
1
],
"notification_settings[post_email]": true,
"notification_settings[trip_email]": true,
"notification_settings[event_email]": true,
"notification_settings[digest_email]": true,
"notification_settings[comment_email]": true,
"notification_settings[ventures_comment_email]": true,
"notification_settings[businessopportunities_request]": true,
"notification_settings[current_location_email]": true,
"notification_settings[emailing_communication_email]": true,
"notification_settings[forum_post_email]": true,
"notification_settings[contact_by_phone]": true,
"notification_settings[contact_by_sms]": true,
"notification_settings[contact_by_post]": true,
"notification_settings[groups_notifications][][topic_id]": [
1
],
"notification_settings[groups_notifications][][group_activity_frequency]": [],
"notification_settings[groups_notifications][][emailing_campaign_enabled]": [
true
],
"notification_settings[groups_notifications][][category_subscribed_ids][]": [
1
]
}Schema
{
"type": "object",
"properties": {
"key": {
"type": "string"
},
"notification_settings[emailing_categories_subscribed_ids][]": {
"type": "array",
"items": {
"type": "number"
},
"description": "Emailing category ids subscribed"
},
"notification_settings[post_email]": {
"type": "boolean",
"description": "Receive notifications for new posts"
},
"notification_settings[trip_email]": {
"type": "boolean",
"description": "Receive notifications for new trips"
},
"notification_settings[event_email]": {
"type": "boolean",
"description": "Receive notifications for new user events"
},
"notification_settings[digest_email]": {
"type": "boolean",
"description": "Receive notifications for new digests"
},
"notification_settings[comment_email]": {
"type": "boolean",
"description": "Receive notifications for new comments"
},
"notification_settings[ventures_comment_email]": {
"type": "boolean",
"description": "Receive notifications for new ventures comments"
},
"notification_settings[businessopportunities_request]": {
"type": "boolean",
"description": "Receive notifications for new business opportunities"
},
"notification_settings[current_location_email]": {
"type": "boolean",
"description": "Receive notifications for new checkins"
},
"notification_settings[emailing_communication_email]": {
"type": "boolean",
"description": "Consent to receive campaigns via email"
},
"notification_settings[forum_post_email]": {
"type": "boolean",
"description": "Receive notifications for new forum posts"
},
"notification_settings[contact_by_phone]": {
"type": "boolean",
"description": "Consent to receive campaigns via phone"
},
"notification_settings[contact_by_sms]": {
"type": "boolean",
"description": "Consent to receive campaigns via SMS"
},
"notification_settings[contact_by_post]": {
"type": "boolean",
"description": "Consent to receive campaigns via post"
},
"notification_settings[groups_notifications][][topic_id]": {
"type": "array",
"items": {
"type": "number"
}
},
"notification_settings[groups_notifications][][group_activity_frequency]": {
"type": "array",
"description": "+"
},
"notification_settings[groups_notifications][][emailing_campaign_enabled]": {
"type": "array",
"items": {
"type": "boolean"
}
},
"notification_settings[groups_notifications][][category_subscribed_ids][]": {
"type": "array",
"items": {
"type": "number"
},
"description": "Group category ids subscribed"
}
},
"required": [
"notification_settings[groups_notifications][][topic_id]"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Update this user notification settings
Schema
{
"type": "object",
"properties": {
"post_email": {
"type": "boolean",
"description": "Receive notifications for new posts"
},
"trip_email": {
"type": "boolean",
"description": "Receive notifications for new trips"
},
"event_email": {
"type": "boolean",
"description": "Receive notifications for new user events"
},
"digest_email": {
"type": "boolean",
"description": "Receive notifications for new digests"
},
"comment_email": {
"type": "boolean",
"description": "Receive notifications for new comments"
},
"ventures_comment_email": {
"type": "boolean",
"description": "Receive notifications for new ventures comments"
},
"businessopportunities_request": {
"type": "boolean",
"description": "Receive notifications for new business opportunities"
},
"current_location_email": {
"type": "boolean",
"description": "Receive notifications for new checkins"
},
"emailing_communication_email": {
"type": "boolean",
"description": "Consent to receive campaigns via email"
},
"forum_post_email": {
"type": "boolean",
"description": "Receive notifications for new forum posts"
},
"contact_by_phone": {
"type": "boolean",
"description": "Consent to receive campaigns via phone"
},
"contact_by_sms": {
"type": "boolean",
"description": "Consent to receive campaigns via SMS"
},
"contact_by_post": {
"type": "boolean",
"description": "Consent to receive campaigns via post"
},
"emailing_categories_subscribed": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"name": {
"type": "string",
"description": "Name of the category"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Category creation date time - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Category last update date time - iso8601"
}
},
"description": "NetworkCategory model"
},
"description": "Emailing campaigns categories subscribed"
},
"groups_notifications": {
"type": "array",
"items": {
"type": "object",
"properties": {
"topic_id": {
"type": "integer",
"format": "int32",
"description": "Group ID"
},
"notification_enabled": {
"type": "boolean",
"description": "Receives notifications upon activity in the group"
},
"group_activity_frequency": {
"type": "string",
"enum": [
"none",
"instant",
"daily",
"weekly"
],
"description": "Frequency to which the user receives notifications upon activity in the group"
},
"emailing_campaign_enabled": {
"type": "boolean",
"description": "Receives emailing campaign from administrators of the group"
},
"categories": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"name": {
"type": "string",
"description": "Name of the category"
}
},
"description": "NetworkCategoryCompact model"
},
"description": "Network categories linked to the group"
}
}
}
}
},
"description": "NotificationSettings model"
}Validations Failed
Schema
{
"type": "object",
"properties": {
"status": {
"type": "integer",
"format": "int32",
"description": "Status Code"
},
"errors": {
"type": "string",
"description": "Errors list"
}
},
"description": "Error model"
}Update this user notification settingsPUT/api/admin/v1/users/{user_id}/notification_settings
Update this user notification settings
URI Parameters
- user_id
number(required)
GET /api/admin/v1/users/postal_addresses
Responses
Get all users postal addresses
Schema
{
"type": "object",
"properties": {
"postal_addresses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"address_1": {
"type": "string",
"description": "Address line 1"
},
"address_2": {
"type": "string",
"description": "Address line 2"
},
"address_3": {
"type": "string",
"description": "Address line 3"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "State"
},
"full_name": {
"type": "string",
"description": "Full name"
},
"postal_code": {
"type": "string",
"description": "Zip code"
},
"country": {
"type": "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"
],
"description": "Country"
},
"default_billing_address": {
"type": "boolean",
"description": "is the default billing address for the user ?"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Postal address creation date time - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Postal address last update date time - iso8601"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "User ID linked to postal address"
}
},
"description": "PostalAddress model"
}
}
},
"description": "PostalAddresses model"
}Get all users postal addressesGET/api/admin/v1/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"
}URI Parameters
- page
string(required)Page of results to fetch.
- per_page
string(required)Number of results to return per page.
- order
string(required)- updated_since
string(required)
GET /api/admin/v1/users/postal_addresses/id
Responses
Get postal address
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"address_1": {
"type": "string",
"description": "Address line 1"
},
"address_2": {
"type": "string",
"description": "Address line 2"
},
"address_3": {
"type": "string",
"description": "Address line 3"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "State"
},
"full_name": {
"type": "string",
"description": "Full name"
},
"postal_code": {
"type": "string",
"description": "Zip code"
},
"country": {
"type": "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"
],
"description": "Country"
},
"default_billing_address": {
"type": "boolean",
"description": "is the default billing address for the user ?"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Postal address creation date time - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Postal address last update date time - iso8601"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "User ID linked to postal address"
}
},
"description": "PostalAddress model"
}Get postal addressGET/api/admin/v1/users/postal_addresses/{id}
Return the postal address based on its ID
URI Parameters
- id
number(required)
PUT /api/admin/v1/users/postal_addresses/id
Requests
Body
{
"postal_address[address_1]": "Hello, world!",
"postal_address[address_2]": "Hello, world!",
"postal_address[address_3]": "Hello, world!",
"postal_address[city]": "Hello, world!",
"postal_address[state]": "Hello, world!",
"postal_address[full_name]": "Hello, world!",
"postal_address[postal_code]": "Hello, world!",
"postal_address[country]": "Hello, world!",
"postal_address[default_billing_address]": true,
"postal_address[created_at]": "Hello, world!",
"postal_address[updated_at]": "Hello, world!",
"postal_address[user_id]": 1
}Schema
{
"type": "object",
"properties": {
"postal_address[address_1]": {
"type": "string",
"description": "Address line 1"
},
"postal_address[address_2]": {
"type": "string",
"description": "Address line 2"
},
"postal_address[address_3]": {
"type": "string",
"description": "Address line 3"
},
"postal_address[city]": {
"type": "string",
"description": "City"
},
"postal_address[state]": {
"type": "string",
"description": "State"
},
"postal_address[full_name]": {
"type": "string",
"description": "Full name"
},
"postal_address[postal_code]": {
"type": "string",
"description": "Zip code"
},
"postal_address[country]": {
"type": "string",
"description": "Country"
},
"postal_address[default_billing_address]": {
"type": "boolean",
"description": "is the default billing address for the user ?"
},
"postal_address[created_at]": {
"type": "string",
"description": "Postal address creation date time - iso8601"
},
"postal_address[updated_at]": {
"type": "string",
"description": "Postal address last update date time - iso8601"
},
"postal_address[user_id]": {
"type": "number",
"description": "User ID linked to postal address"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Update existing postal address
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"address_1": {
"type": "string",
"description": "Address line 1"
},
"address_2": {
"type": "string",
"description": "Address line 2"
},
"address_3": {
"type": "string",
"description": "Address line 3"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "State"
},
"full_name": {
"type": "string",
"description": "Full name"
},
"postal_code": {
"type": "string",
"description": "Zip code"
},
"country": {
"type": "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"
],
"description": "Country"
},
"default_billing_address": {
"type": "boolean",
"description": "is the default billing address for the user ?"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Postal address creation date time - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Postal address last update date time - iso8601"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "User ID linked to postal address"
}
},
"description": "PostalAddress model"
}Validations Failed
Schema
{
"type": "object",
"properties": {
"status": {
"type": "integer",
"format": "int32",
"description": "Status Code"
},
"errors": {
"type": "string",
"description": "Errors list"
}
},
"description": "Error model"
}Update existing postal addressPUT/api/admin/v1/users/postal_addresses/{id}
Update a postal address
URI Parameters
- id
string(required)Education ID
GET /api/admin/v1/users/user_id/groups
Responses
Return groups belonging of the user
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"email": {
"type": "string",
"description": "User email"
},
"name": {
"type": "string",
"description": "User full name"
},
"sub_network_ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": "IDs list of user sub networks"
},
"extended_updated_at": {
"type": "string",
"format": "date-time",
"description": "User full profile ( with experiences, educations, customs) last update date time - iso8601"
},
"joined_at": {
"type": "string",
"format": "date-time",
"description": "Timestamp the User joined the topic - iso8601"
}
},
"description": "Follower model"
}Return groups belonging of the userGET/api/admin/v1/users/{user_id}/groups
Return groups linked to the user
URI Parameters
- user_id
number(required)- key
string(required)- status
string(required)
GET /api/admin/v1/users?page=&per_page=&updated_since=&confirmed_since=&order=&full_profile=
Responses
Get all users
Schema
{
"type": "object",
"properties": {
"users": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"email": {
"type": "string",
"description": "User email"
},
"name": {
"type": "string",
"description": "User full name"
},
"sub_network_ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": "IDs list of user sub networks"
},
"extended_updated_at": {
"type": "string",
"format": "date-time",
"description": "User full profile ( with experiences, educations, customs) last update date time - iso8601"
}
}
}
}
},
"description": "UsersCompact model"
}Get all usersGET/api/admin/v1/users{?page,per_page,updated_since,confirmed_since,order,full_profile}
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).
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"
}URI Parameters
- page
string(required)Page of results to fetch.
- per_page
string(required)Number of results to return per page.
- updated_since
string(required)- confirmed_since
string(required)- order
string(required)- full_profile
string(required)
POST /api/admin/v1/users
Requests
Body
{
"user[email]": "Hello, world!",
"user[sub_network_ids][]": [
1
],
"user[postal_personal][address_1]": "Hello, world!",
"user[postal_personal][address_2]": "Hello, world!",
"user[postal_personal][address_3]": "Hello, world!",
"user[postal_personal][city]": "Hello, world!",
"user[postal_personal][state]": "Hello, world!",
"user[postal_personal][full_name]": "Hello, world!",
"user[postal_personal][postal_code]": "Hello, world!",
"user[postal_personal][country]": "Hello, world!",
"user[postal_personal][default_billing_address]": true,
"user[postal_personal][created_at]": "Hello, world!",
"user[postal_personal][updated_at]": "Hello, world!",
"user[postal_work][address_1]": "Hello, world!",
"user[postal_work][address_2]": "Hello, world!",
"user[postal_work][address_3]": "Hello, world!",
"user[postal_work][city]": "Hello, world!",
"user[postal_work][state]": "Hello, world!",
"user[postal_work][full_name]": "Hello, world!",
"user[postal_work][postal_code]": "Hello, world!",
"user[postal_work][country]": "Hello, world!",
"user[postal_work][default_billing_address]": true,
"user[postal_work][created_at]": "Hello, world!",
"user[postal_work][updated_at]": "Hello, world!",
"user[live_location][city]": "Hello, world!",
"user[live_location][country]": "Hello, world!",
"user[live_location][country_code]": "Hello, world!",
"user[live_location][address]": "Hello, world!",
"user[live_location][lat]": 1,
"user[live_location][lng]": 1,
"user[config][private_profile]": true,
"user[config][opt_out_of_directory]": true,
"user[config][opt_out_of_group_directories][]": [],
"user[config][opt_out_of_messaging]": true,
"user[config][share_gender]": "Hello, world!",
"user[config][share_prefix_firstname]": "Hello, world!",
"user[config][share_honorary_title]": "Hello, world!",
"user[config][share_prefix_name]": "Hello, world!",
"user[config][share_suffix_name]": "Hello, world!",
"user[config][share_maidenname]": "Hello, world!",
"user[config][share_birthday]": "Hello, world!",
"user[config][share_birthplace]": "Hello, world!",
"user[config][share_headline]": "Hello, world!",
"user[config][share_live_location]": "Hello, world!",
"user[config][share_sub_networks]": "Hello, world!",
"user[config][share_nationalities]": "Hello, world!",
"user[config][share_resume]": "Hello, world!",
"user[config][share_summary]": "Hello, world!",
"user[config][share_industries]": "Hello, world!",
"user[config][share_skills]": "Hello, world!",
"user[config][share_facebook_profile_url]: - Privacy sharing status of facebook_profile_url": "Hello, world!",
"user[config][share_instagram_profile_url]: - Privacy sharing status of instagram_profile_url": "Hello, world!",
"user[config][share_twitter]": "Hello, world!",
"user[config][share_skype]": "Hello, world!",
"user[config][share_linkedin_profile_url]: - Privacy sharing status of linkedin_profile_url": "Hello, world!",
"user[config][share_website]": "Hello, world!",
"user[config][share_bbm]": "Hello, world!",
"user[config][share_email]": "Hello, world!",
"user[config][share_email2]": "Hello, world!",
"user[config][share_email3]": "Hello, world!",
"user[config][share_mobile_perso]": "Hello, world!",
"user[config][share_landline_perso]": "Hello, world!",
"user[config][share_mobile_pro]": "Hello, world!",
"user[config][share_landline_pro]": "Hello, world!",
"user[config][share_postal_personal]": "Hello, world!",
"user[config][share_postal_work]": "Hello, world!",
"user[config][share_memberships]": "Hello, world!",
"user[config][share_educations]": "Hello, world!",
"user[config][share_experiences]": "Hello, world!",
"user[extended_updated_at]": "Hello, world!",
"user[likes_count]": 1,
"user[comments_count]": "Hello, world!",
"user[email2]": "Hello, world!",
"user[email3]": "Hello, world!",
"user[primary_email_choice]": "Hello, world!",
"user[firstname]": "Hello, world!",
"user[lastname]": "Hello, world!",
"user[maidenname]": "Hello, world!",
"user[prefix_firstname]": "Hello, world!",
"user[prefix_name]": "Hello, world!",
"user[suffix_name]": "Hello, world!",
"user[external_id]": "Hello, world!",
"user[sso_identifier]": "Hello, world!",
"user[previous_id]": "Hello, world!",
"user[last_visited_at]": "Hello, world!",
"user[sign_in_count]": "Hello, world!",
"user[is_active]": true,
"user[gender]": "Hello, world!",
"user[birthday]": "Hello, world!",
"user[birthplace]": "Hello, world!",
"user[headline]": "Hello, world!",
"user[summary]": "Hello, world!",
"user[created_at]": "Hello, world!",
"user[updated_at]": "Hello, world!",
"user[citizenship_ids][]": [
1
],
"user[citizenship_country_codes][]": [],
"user[deceased]": true,
"user[deceased_at]": "Hello, world!",
"user[do_not_contact]": true,
"user[mobile_perso]": "Hello, world!",
"user[mobile_pro]": "Hello, world!",
"user[landline_perso]": "Hello, world!",
"user[landline_pro]": "Hello, world!",
"user[preferred_phone_number]": "Hello, world!",
"user[preferred_postal_address]": "Hello, world!",
"user[role_id]": 1,
"user[awards]": "Hello, world!",
"user[linkedin_profile_url]": "Hello, world!",
"user[website]": "Hello, world!",
"user[skype]": "Hello, world!",
"user[bbm]": "Hello, world!",
"user[twitter]": "Hello, world!",
"user[timezone]": "Hello, world!",
"user[facebook_profile_url]": "Hello, world!",
"user[instagram_profile_url]": "Hello, world!",
"user[honorary_title]": "Hello, world!",
"user[locale]": "Hello, world!",
"user[share_email]": "Hello, world!",
"user[share_email2]": "Hello, world!",
"user[share_email3]": "Hello, world!",
"user[share_postal_address_personal]": "Hello, world!",
"user[share_postal_address_work]": "Hello, world!",
"user[share_nationalities]": "Hello, world!",
"user[share_resume]": "Hello, world!",
"user[share_mobile_pro]": "Hello, world!",
"user[share_mobile_perso]": "Hello, world!",
"user[share_landline_pro]": "Hello, world!",
"user[share_landline_perso]": "Hello, world!",
"user[skills][]": [],
"user[custom_attributes][]": [],
"user[photo]": "Hello, world!",
"user[resume]": "Hello, world!",
"user[notify_after_create]": "Hello, world!"
}Schema
{
"type": "object",
"properties": {
"user[email]": {
"type": "string",
"description": "User email"
},
"user[sub_network_ids][]": {
"type": "array",
"items": {
"type": "number"
},
"description": "User sub networks ids"
},
"user[postal_personal][address_1]": {
"type": "string",
"description": "Address line 1"
},
"user[postal_personal][address_2]": {
"type": "string",
"description": "Address line 2"
},
"user[postal_personal][address_3]": {
"type": "string",
"description": "Address line 3"
},
"user[postal_personal][city]": {
"type": "string",
"description": "City"
},
"user[postal_personal][state]": {
"type": "string",
"description": "State"
},
"user[postal_personal][full_name]": {
"type": "string",
"description": "Full name"
},
"user[postal_personal][postal_code]": {
"type": "string",
"description": "Zip code"
},
"user[postal_personal][country]": {
"type": "string",
"description": "Country"
},
"user[postal_personal][default_billing_address]": {
"type": "boolean",
"description": "is the default billing address for the user ?"
},
"user[postal_personal][created_at]": {
"type": "string",
"description": "Postal address creation date time - iso8601"
},
"user[postal_personal][updated_at]": {
"type": "string",
"description": "Postal address last update date time - iso8601"
},
"user[postal_work][address_1]": {
"type": "string",
"description": "Address line 1"
},
"user[postal_work][address_2]": {
"type": "string",
"description": "Address line 2"
},
"user[postal_work][address_3]": {
"type": "string",
"description": "Address line 3"
},
"user[postal_work][city]": {
"type": "string",
"description": "City"
},
"user[postal_work][state]": {
"type": "string",
"description": "State"
},
"user[postal_work][full_name]": {
"type": "string",
"description": "Full name"
},
"user[postal_work][postal_code]": {
"type": "string",
"description": "Zip code"
},
"user[postal_work][country]": {
"type": "string",
"description": "Country"
},
"user[postal_work][default_billing_address]": {
"type": "boolean",
"description": "is the default billing address for the user ?"
},
"user[postal_work][created_at]": {
"type": "string",
"description": "Postal address creation date time - iso8601"
},
"user[postal_work][updated_at]": {
"type": "string",
"description": "Postal address last update date time - iso8601"
},
"user[live_location][city]": {
"type": "string",
"description": "City"
},
"user[live_location][country]": {
"type": "string",
"description": "Country"
},
"user[live_location][country_code]": {
"type": "string",
"description": "ISO3166-2 Country code"
},
"user[live_location][address]": {
"type": "string",
"description": "Address"
},
"user[live_location][lat]": {
"type": "number",
"description": "Latitude"
},
"user[live_location][lng]": {
"type": "number",
"description": "Longitude"
},
"user[config][private_profile]": {
"type": "boolean",
"description": "Unique ID"
},
"user[config][opt_out_of_directory]": {
"type": "boolean",
"description": "Unique ID"
},
"user[config][opt_out_of_group_directories][]": {
"type": "array",
"description": "Unique ID\n\n+"
},
"user[config][opt_out_of_messaging]": {
"type": "boolean",
"description": "Opt out of messaging"
},
"user[config][share_gender]": {
"type": "string",
"description": "Privacy sharing status of gender"
},
"user[config][share_prefix_firstname]": {
"type": "string",
"description": "Privacy sharing status of prefix_firstname"
},
"user[config][share_honorary_title]": {
"type": "string",
"description": "Privacy sharing status of honorary_title"
},
"user[config][share_prefix_name]": {
"type": "string",
"description": "Privacy sharing status of prefix_name"
},
"user[config][share_suffix_name]": {
"type": "string",
"description": "Privacy sharing status of suffix_name"
},
"user[config][share_maidenname]": {
"type": "string",
"description": "Privacy sharing status of maidenname"
},
"user[config][share_birthday]": {
"type": "string",
"description": "Privacy sharing status of birthday"
},
"user[config][share_birthplace]": {
"type": "string",
"description": "Privacy sharing status of birthplace"
},
"user[config][share_headline]": {
"type": "string",
"description": "Privacy sharing status of headline"
},
"user[config][share_live_location]": {
"type": "string",
"description": "Privacy sharing status of live_location"
},
"user[config][share_sub_networks]": {
"type": "string",
"description": "Privacy sharing status of sub_networks"
},
"user[config][share_nationalities]": {
"type": "string",
"description": "Privacy sharing status of nationalities"
},
"user[config][share_resume]": {
"type": "string",
"description": "Privacy sharing status of resume"
},
"user[config][share_summary]": {
"type": "string",
"description": "Privacy sharing status of summary"
},
"user[config][share_industries]": {
"type": "string",
"description": "Privacy sharing status of industries"
},
"user[config][share_skills]": {
"type": "string",
"description": "Privacy sharing status of skills"
},
"user[config][share_facebook_profile_url]: - Privacy sharing status of facebook_profile_url": {
"type": "string"
},
"user[config][share_instagram_profile_url]: - Privacy sharing status of instagram_profile_url": {
"type": "string"
},
"user[config][share_twitter]": {
"type": "string",
"description": "Privacy sharing status of twitter"
},
"user[config][share_skype]": {
"type": "string",
"description": "Privacy sharing status of skype"
},
"user[config][share_linkedin_profile_url]: - Privacy sharing status of linkedin_profile_url": {
"type": "string"
},
"user[config][share_website]": {
"type": "string",
"description": "Privacy sharing status of website"
},
"user[config][share_bbm]": {
"type": "string",
"description": "Privacy sharing status of bbm"
},
"user[config][share_email]": {
"type": "string",
"description": "Privacy sharing status of email"
},
"user[config][share_email2]": {
"type": "string",
"description": "Privacy sharing status of email2"
},
"user[config][share_email3]": {
"type": "string",
"description": "Privacy sharing status of email3"
},
"user[config][share_mobile_perso]": {
"type": "string",
"description": "Privacy sharing status of mobile_perso"
},
"user[config][share_landline_perso]": {
"type": "string",
"description": "Privacy sharing status of landline_perso"
},
"user[config][share_mobile_pro]": {
"type": "string",
"description": "Privacy sharing status of mobile_pro"
},
"user[config][share_landline_pro]": {
"type": "string",
"description": "Privacy sharing status of landline_pro"
},
"user[config][share_postal_personal]": {
"type": "string",
"description": "Privacy sharing status of postal_personal"
},
"user[config][share_postal_work]": {
"type": "string",
"description": "Privacy sharing status of postal_work"
},
"user[config][share_memberships]": {
"type": "string",
"description": "Privacy sharing status of memberships"
},
"user[config][share_educations]": {
"type": "string",
"description": "Privacy sharing status of educations"
},
"user[config][share_experiences]": {
"type": "string",
"description": "Privacy sharing status of experiences"
},
"user[extended_updated_at]": {
"type": "string",
"description": "User full profile ( with experiences, educations, customs) last update date time - iso8601"
},
"user[likes_count]": {
"type": "number",
"description": "Total count of likes on this Likeable"
},
"user[comments_count]": {
"type": "string",
"description": "Total count of comment for this Commentable"
},
"user[email2]": {
"type": "string",
"description": "User secondary email"
},
"user[email3]": {
"type": "string",
"description": "User complementary email"
},
"user[primary_email_choice]": {
"type": "string",
"description": "User primary email choice"
},
"user[firstname]": {
"type": "string",
"description": "User first name"
},
"user[lastname]": {
"type": "string",
"description": "User last name"
},
"user[maidenname]": {
"type": "string",
"description": "User maiden name"
},
"user[prefix_firstname]": {
"type": "string",
"description": "User prefix firstname"
},
"user[prefix_name]": {
"type": "string",
"description": "User prefix name"
},
"user[suffix_name]": {
"type": "string",
"description": "User suffix name"
},
"user[external_id]": {
"type": "string",
"description": "User ID in your database"
},
"user[sso_identifier]": {
"type": "string",
"description": "User identifier for SSO"
},
"user[previous_id]": {
"type": "string",
"description": "User ID in your community system"
},
"user[last_visited_at]": {
"type": "string",
"description": "Date of last visit - iso8601. READ only, can't be updated"
},
"user[sign_in_count]": {
"type": "string",
"description": "Number of platform visits. READ only, can't be updated"
},
"user[is_active]": {
"type": "boolean",
"description": "User account enabled ?"
},
"user[gender]": {
"type": "string",
"description": "User gender (male/female/other)"
},
"user[birthday]": {
"type": "string",
"description": "User birth date"
},
"user[birthplace]": {
"type": "string",
"description": "User birth place"
},
"user[headline]": {
"type": "string",
"description": "User headline"
},
"user[summary]": {
"type": "string",
"description": "User summary"
},
"user[created_at]": {
"type": "string",
"description": "User creation date time - iso8601. READ only, can't be updated"
},
"user[updated_at]": {
"type": "string",
"description": "User last update date time - iso8601. READ only, can't be updated"
},
"user[citizenship_ids][]": {
"type": "array",
"items": {
"type": "number"
},
"description": "List of citizenship IDs"
},
"user[citizenship_country_codes][]": {
"type": "array",
"description": "List of ISO-3166-2 citizenship country codes\n\n+"
},
"user[deceased]": {
"type": "boolean",
"description": "User deceased ?"
},
"user[deceased_at]": {
"type": "string",
"description": "User decease date time - iso8601."
},
"user[do_not_contact]": {
"type": "boolean",
"description": "User can be contacted ?"
},
"user[mobile_perso]": {
"type": "string",
"description": "User mobile perso number"
},
"user[mobile_pro]": {
"type": "string",
"description": "User mobile pro number"
},
"user[landline_perso]": {
"type": "string",
"description": "User landline perso number"
},
"user[landline_pro]": {
"type": "string",
"description": "User landline pro number"
},
"user[preferred_phone_number]": {
"type": "string",
"description": "User preferred phone number"
},
"user[preferred_postal_address]": {
"type": "string",
"description": "User preferred postal address"
},
"user[role_id]": {
"type": "number",
"description": "User role ID"
},
"user[awards]": {
"type": "string",
"description": "User awards"
},
"user[linkedin_profile_url]": {
"type": "string",
"description": "User linkedin profile URL"
},
"user[website]": {
"type": "string",
"description": "User Website URL"
},
"user[skype]": {
"type": "string",
"description": "User skype profile"
},
"user[bbm]": {
"type": "string",
"description": "User BlackBerry Messenger profile"
},
"user[twitter]": {
"type": "string",
"description": "User twitter profile"
},
"user[timezone]": {
"type": "string",
"description": "User timezone"
},
"user[facebook_profile_url]": {
"type": "string",
"description": "User facebook profile URL"
},
"user[instagram_profile_url]": {
"type": "string",
"description": "User instagram profile URL"
},
"user[honorary_title]": {
"type": "string",
"description": "User's honorary title"
},
"user[locale]": {
"type": "string",
"description": "User Locale"
},
"user[share_email]": {
"type": "string",
"description": "User's visibility information regarding email"
},
"user[share_email2]": {
"type": "string",
"description": "User's visibility information regarding secondary email"
},
"user[share_email3]": {
"type": "string",
"description": "User's visibility information regarding complementary email"
},
"user[share_postal_address_personal]": {
"type": "string",
"description": "User's visibility information regarding postal home location"
},
"user[share_postal_address_work]": {
"type": "string",
"description": "User's visibility information regarding postal work location"
},
"user[share_nationalities]": {
"type": "string",
"description": "User's visibility information regarding nationalities"
},
"user[share_resume]": {
"type": "string",
"description": "User's visibility information regarding resume"
},
"user[share_mobile_pro]": {
"type": "string",
"description": "User's visibility information regarding work mobile phone"
},
"user[share_mobile_perso]": {
"type": "string",
"description": "User's visibility information regarding personal mobile phone"
},
"user[share_landline_pro]": {
"type": "string",
"description": "User's visibility information regarding professional landline phone"
},
"user[share_landline_perso]": {
"type": "string",
"description": "User's visibility information regarding personal landline phone"
},
"user[skills][]": {
"type": "array",
"description": "READ ONLY, list of user skills\n\n+"
},
"user[custom_attributes][]": {
"type": "array",
"description": "Array of customizable attributes with name, value and type\n\n+"
},
"user[photo]": {
"type": "string",
"description": "User profile picture"
},
"user[resume]": {
"type": "string",
"description": "Resume of the user"
},
"user[notify_after_create]": {
"type": "string"
}
},
"required": [
"user[email]",
"user[sub_network_ids][]"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Add a new user
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"email": {
"type": "string",
"description": "User email"
},
"name": {
"type": "string",
"description": "User full name"
},
"sub_network_ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": "IDs list of user sub networks"
},
"extended_updated_at": {
"type": "string",
"format": "date-time",
"description": "User full profile ( with experiences, educations, customs) last update date time - iso8601"
},
"likeable_type": {
"type": "string",
"description": "Type to use on API query"
},
"current_user_like_id": {
"type": "integer",
"format": "int32",
"description": "Like ID of the current_user if they like the Likeable"
},
"likes_count": {
"type": "integer",
"format": "int32",
"description": "Total count of likes on this Likeable"
},
"commentable_type": {
"type": "string",
"description": "Type to use on API query"
},
"comments_count": {
"type": "string",
"description": "Total count of comment for this Commentable"
},
"email2": {
"type": "string",
"description": "User secondary email"
},
"email3": {
"type": "string",
"description": "User complementary email"
},
"primary_email_choice": {
"type": "string",
"enum": [
"email",
"email2",
"email3"
],
"description": "User primary email choice"
},
"firstname": {
"type": "string",
"description": "User first name"
},
"lastname": {
"type": "string",
"description": "User last name"
},
"maidenname": {
"type": "string",
"description": "User maiden name"
},
"prefix_firstname": {
"type": "string",
"description": "User prefix firstname"
},
"prefix_name": {
"type": "string",
"description": "User prefix name"
},
"suffix_name": {
"type": "string",
"description": "User suffix name"
},
"external_id": {
"type": "string",
"description": "User ID in your database"
},
"sso_identifier": {
"type": "string",
"description": "User identifier for SSO"
},
"previous_id": {
"type": "string",
"description": "User ID in your community system"
},
"last_visited_at": {
"type": "string",
"format": "date-time",
"description": "Date of last visit - iso8601. READ only, can't be updated"
},
"sign_in_count": {
"type": "string",
"description": "Number of platform visits. READ only, can't be updated"
},
"is_active": {
"type": "boolean",
"description": "User account enabled ?"
},
"gender": {
"type": "string",
"enum": [
"male",
"female",
"other"
],
"description": "User gender (male/female/other)"
},
"birthday": {
"type": "string",
"format": "date",
"description": "User birth date"
},
"birthplace": {
"type": "string",
"description": "User birth place"
},
"headline": {
"type": "string",
"description": "User headline"
},
"summary": {
"type": "string",
"description": "User summary"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "User creation date time - iso8601. READ only, can't be updated"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "User last update date time - iso8601. READ only, can't be updated"
},
"confirmed_at": {
"type": "string",
"format": "date-time",
"description": "User activation date time - iso8601. READ only, can't be updated"
},
"citizenship_ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": "List of citizenship IDs"
},
"citizenship_country_codes": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of ISO-3166-2 citizenship country codes"
},
"deceased": {
"type": "boolean",
"description": "User deceased ?"
},
"deceased_at": {
"type": "string",
"format": "date-time",
"description": "User decease date time - iso8601."
},
"photo": {
"type": "object",
"properties": {
"compressed-url": {
"type": "string",
"description": "User compressed photo url"
},
"large-url": {
"type": "string",
"description": "User large photo url"
},
"medium-url": {
"type": "string",
"description": "User medium photo url"
},
"thumb-url": {
"type": "string",
"description": "User thumb photo url"
},
"mini-url": {
"type": "string",
"description": "User mini photo url"
},
"friend-url": {
"type": "string",
"description": "User friend photo url"
},
"icon-url": {
"type": "string",
"description": "User icon photo url"
}
},
"description": "User photo urls"
},
"do_not_contact": {
"type": "boolean",
"description": "User can be contacted ?"
},
"mobile_perso": {
"type": "string",
"description": "User mobile perso number"
},
"mobile_pro": {
"type": "string",
"description": "User mobile pro number"
},
"landline_perso": {
"type": "string",
"description": "User landline perso number"
},
"landline_pro": {
"type": "string",
"description": "User landline pro number"
},
"preferred_phone_number": {
"type": "string",
"enum": [
"mobile_pro",
"mobile_perso",
"landline_pro",
"landline_perso",
"none"
],
"description": "User preferred phone number"
},
"postal_personal": {
"description": "User personal postal address",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"address_1": {
"type": "string",
"description": "Address line 1"
},
"address_2": {
"type": "string",
"description": "Address line 2"
},
"address_3": {
"type": "string",
"description": "Address line 3"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "State"
},
"full_name": {
"type": "string",
"description": "Full name"
},
"postal_code": {
"type": "string",
"description": "Zip code"
},
"country": {
"type": "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"
],
"description": "Country"
},
"default_billing_address": {
"type": "boolean",
"description": "is the default billing address for the user ?"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Postal address creation date time - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Postal address last update date time - iso8601"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "User ID linked to postal address"
}
}
},
"postal_work": {
"description": "User work postal address",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"address_1": {
"type": "string",
"description": "Address line 1"
},
"address_2": {
"type": "string",
"description": "Address line 2"
},
"address_3": {
"type": "string",
"description": "Address line 3"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "State"
},
"full_name": {
"type": "string",
"description": "Full name"
},
"postal_code": {
"type": "string",
"description": "Zip code"
},
"country": {
"type": "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"
],
"description": "Country"
},
"default_billing_address": {
"type": "boolean",
"description": "is the default billing address for the user ?"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Postal address creation date time - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Postal address last update date time - iso8601"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "User ID linked to postal address"
}
}
},
"preferred_postal_address": {
"type": "string",
"enum": [
"postal_personal",
"postal_work"
],
"description": "User preferred postal address"
},
"config": {
"description": "User specific configuration",
"type": "object",
"properties": {
"private_profile": {
"type": "boolean",
"description": "Unique ID"
},
"opt_out_of_directory": {
"type": "boolean",
"description": "Unique ID"
},
"opt_out_of_group_directories": {
"type": "array",
"items": {
"type": "object"
},
"description": "Unique ID"
},
"opt_out_of_messaging": {
"type": "boolean",
"description": "Opt out of messaging"
},
"share_gender": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of gender"
},
"share_prefix_firstname": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of prefix_firstname"
},
"share_honorary_title": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of honorary_title"
},
"share_prefix_name": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of prefix_name"
},
"share_suffix_name": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of suffix_name"
},
"share_maidenname": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of maidenname"
},
"share_birthday": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of birthday"
},
"share_birthplace": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of birthplace"
},
"share_headline": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of headline"
},
"share_live_location": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of live_location"
},
"share_sub_networks": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of sub_networks"
},
"share_nationalities": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of nationalities"
},
"share_resume": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of resume"
},
"share_summary": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of summary"
},
"share_industries": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of industries"
},
"share_skills": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of skills"
},
"share_facebook_profile_url": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of facebook_profile_url"
},
"share_instagram_profile_url": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of instagram_profile_url"
},
"share_twitter": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of twitter"
},
"share_skype": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of skype"
},
"share_linkedin_profile_url": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of linkedin_profile_url"
},
"share_website": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of website"
},
"share_bbm": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of bbm"
},
"share_email": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of email"
},
"share_email2": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of email2"
},
"share_email3": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of email3"
},
"share_mobile_perso": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of mobile_perso"
},
"share_landline_perso": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of landline_perso"
},
"share_mobile_pro": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of mobile_pro"
},
"share_landline_pro": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of landline_pro"
},
"share_postal_personal": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of postal_personal"
},
"share_postal_work": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of postal_work"
},
"share_memberships": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of memberships"
},
"share_educations": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of educations"
},
"share_experiences": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of experiences"
}
}
},
"role_id": {
"type": "integer",
"format": "int32",
"description": "User role ID"
},
"awards": {
"type": "string",
"description": "User awards"
},
"linkedin_profile_url": {
"type": "string",
"description": "User linkedin profile URL"
},
"website": {
"type": "string",
"description": "User Website URL"
},
"skype": {
"type": "string",
"description": "User skype profile"
},
"bbm": {
"type": "string",
"description": "User BlackBerry Messenger profile"
},
"twitter": {
"type": "string",
"description": "User twitter profile"
},
"timezone": {
"type": "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"
],
"description": "User timezone"
},
"facebook_profile_url": {
"type": "string",
"description": "User facebook profile URL"
},
"instagram_profile_url": {
"type": "string",
"description": "User instagram profile URL"
},
"honorary_title": {
"type": "string",
"enum": [
"mr",
"mrs",
"ms",
"dr",
"prof"
],
"description": "User's honorary title"
},
"live_location": {
"description": "User's current location.",
"type": "object",
"properties": {
"city": {
"type": "string",
"description": "City"
},
"country": {
"type": "string",
"description": "Country"
},
"country_code": {
"type": "string",
"description": "ISO3166-2 Country code"
},
"address": {
"type": "string",
"description": "Address"
},
"lat": {
"type": "number",
"format": "float",
"description": "Latitude"
},
"lng": {
"type": "number",
"format": "float",
"description": "Longitude"
}
}
},
"resume": {
"type": "string",
"description": "URL link to the user's resume. This link will be expired if you do not open it in the 60 sec after your request. Another request will be needed"
},
"locale": {
"type": "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"
],
"description": "User Locale"
},
"share_email": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding email"
},
"share_email2": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding secondary email"
},
"share_email3": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding complementary email"
},
"share_postal_address_personal": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding postal home location"
},
"share_postal_address_work": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding postal work location"
},
"share_nationalities": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding nationalities"
},
"share_resume": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding resume"
},
"share_mobile_pro": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding work mobile phone"
},
"share_mobile_perso": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding personal mobile phone"
},
"share_landline_pro": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding professional landline phone"
},
"share_landline_perso": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding personal landline phone"
},
"skills": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"name": {
"type": "string",
"description": "Skill name"
}
}
},
"description": "READ ONLY, list of user skills"
},
"custom_attributes": {
"type": "array",
"items": {
"type": "object"
},
"description": "Array of customizable attributes with name, value and type"
}
},
"description": "User model"
}Validations Failed
Schema
{
"type": "object",
"properties": {
"status": {
"type": "integer",
"format": "int32",
"description": "Status Code"
},
"errors": {
"type": "string",
"description": "Errors list"
}
},
"description": "Error model"
}Add a new userPOST/api/admin/v1/users
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
GET /api/admin/v1/users/id?key=
Responses
Get user profile
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"email": {
"type": "string",
"description": "User email"
},
"name": {
"type": "string",
"description": "User full name"
},
"sub_network_ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": "IDs list of user sub networks"
},
"extended_updated_at": {
"type": "string",
"format": "date-time",
"description": "User full profile ( with experiences, educations, customs) last update date time - iso8601"
},
"likeable_type": {
"type": "string",
"description": "Type to use on API query"
},
"current_user_like_id": {
"type": "integer",
"format": "int32",
"description": "Like ID of the current_user if they like the Likeable"
},
"likes_count": {
"type": "integer",
"format": "int32",
"description": "Total count of likes on this Likeable"
},
"commentable_type": {
"type": "string",
"description": "Type to use on API query"
},
"comments_count": {
"type": "string",
"description": "Total count of comment for this Commentable"
},
"email2": {
"type": "string",
"description": "User secondary email"
},
"email3": {
"type": "string",
"description": "User complementary email"
},
"primary_email_choice": {
"type": "string",
"enum": [
"email",
"email2",
"email3"
],
"description": "User primary email choice"
},
"firstname": {
"type": "string",
"description": "User first name"
},
"lastname": {
"type": "string",
"description": "User last name"
},
"maidenname": {
"type": "string",
"description": "User maiden name"
},
"prefix_firstname": {
"type": "string",
"description": "User prefix firstname"
},
"prefix_name": {
"type": "string",
"description": "User prefix name"
},
"suffix_name": {
"type": "string",
"description": "User suffix name"
},
"external_id": {
"type": "string",
"description": "User ID in your database"
},
"sso_identifier": {
"type": "string",
"description": "User identifier for SSO"
},
"previous_id": {
"type": "string",
"description": "User ID in your community system"
},
"last_visited_at": {
"type": "string",
"format": "date-time",
"description": "Date of last visit - iso8601. READ only, can't be updated"
},
"sign_in_count": {
"type": "string",
"description": "Number of platform visits. READ only, can't be updated"
},
"is_active": {
"type": "boolean",
"description": "User account enabled ?"
},
"gender": {
"type": "string",
"enum": [
"male",
"female",
"other"
],
"description": "User gender (male/female/other)"
},
"birthday": {
"type": "string",
"format": "date",
"description": "User birth date"
},
"birthplace": {
"type": "string",
"description": "User birth place"
},
"headline": {
"type": "string",
"description": "User headline"
},
"summary": {
"type": "string",
"description": "User summary"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "User creation date time - iso8601. READ only, can't be updated"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "User last update date time - iso8601. READ only, can't be updated"
},
"confirmed_at": {
"type": "string",
"format": "date-time",
"description": "User activation date time - iso8601. READ only, can't be updated"
},
"citizenship_ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": "List of citizenship IDs"
},
"citizenship_country_codes": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of ISO-3166-2 citizenship country codes"
},
"deceased": {
"type": "boolean",
"description": "User deceased ?"
},
"deceased_at": {
"type": "string",
"format": "date-time",
"description": "User decease date time - iso8601."
},
"photo": {
"type": "object",
"properties": {
"compressed-url": {
"type": "string",
"description": "User compressed photo url"
},
"large-url": {
"type": "string",
"description": "User large photo url"
},
"medium-url": {
"type": "string",
"description": "User medium photo url"
},
"thumb-url": {
"type": "string",
"description": "User thumb photo url"
},
"mini-url": {
"type": "string",
"description": "User mini photo url"
},
"friend-url": {
"type": "string",
"description": "User friend photo url"
},
"icon-url": {
"type": "string",
"description": "User icon photo url"
}
},
"description": "User photo urls"
},
"do_not_contact": {
"type": "boolean",
"description": "User can be contacted ?"
},
"mobile_perso": {
"type": "string",
"description": "User mobile perso number"
},
"mobile_pro": {
"type": "string",
"description": "User mobile pro number"
},
"landline_perso": {
"type": "string",
"description": "User landline perso number"
},
"landline_pro": {
"type": "string",
"description": "User landline pro number"
},
"preferred_phone_number": {
"type": "string",
"enum": [
"mobile_pro",
"mobile_perso",
"landline_pro",
"landline_perso",
"none"
],
"description": "User preferred phone number"
},
"postal_personal": {
"description": "User personal postal address",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"address_1": {
"type": "string",
"description": "Address line 1"
},
"address_2": {
"type": "string",
"description": "Address line 2"
},
"address_3": {
"type": "string",
"description": "Address line 3"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "State"
},
"full_name": {
"type": "string",
"description": "Full name"
},
"postal_code": {
"type": "string",
"description": "Zip code"
},
"country": {
"type": "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"
],
"description": "Country"
},
"default_billing_address": {
"type": "boolean",
"description": "is the default billing address for the user ?"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Postal address creation date time - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Postal address last update date time - iso8601"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "User ID linked to postal address"
}
}
},
"postal_work": {
"description": "User work postal address",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"address_1": {
"type": "string",
"description": "Address line 1"
},
"address_2": {
"type": "string",
"description": "Address line 2"
},
"address_3": {
"type": "string",
"description": "Address line 3"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "State"
},
"full_name": {
"type": "string",
"description": "Full name"
},
"postal_code": {
"type": "string",
"description": "Zip code"
},
"country": {
"type": "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"
],
"description": "Country"
},
"default_billing_address": {
"type": "boolean",
"description": "is the default billing address for the user ?"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Postal address creation date time - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Postal address last update date time - iso8601"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "User ID linked to postal address"
}
}
},
"preferred_postal_address": {
"type": "string",
"enum": [
"postal_personal",
"postal_work"
],
"description": "User preferred postal address"
},
"config": {
"description": "User specific configuration",
"type": "object",
"properties": {
"private_profile": {
"type": "boolean",
"description": "Unique ID"
},
"opt_out_of_directory": {
"type": "boolean",
"description": "Unique ID"
},
"opt_out_of_group_directories": {
"type": "array",
"items": {
"type": "object"
},
"description": "Unique ID"
},
"opt_out_of_messaging": {
"type": "boolean",
"description": "Opt out of messaging"
},
"share_gender": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of gender"
},
"share_prefix_firstname": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of prefix_firstname"
},
"share_honorary_title": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of honorary_title"
},
"share_prefix_name": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of prefix_name"
},
"share_suffix_name": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of suffix_name"
},
"share_maidenname": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of maidenname"
},
"share_birthday": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of birthday"
},
"share_birthplace": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of birthplace"
},
"share_headline": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of headline"
},
"share_live_location": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of live_location"
},
"share_sub_networks": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of sub_networks"
},
"share_nationalities": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of nationalities"
},
"share_resume": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of resume"
},
"share_summary": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of summary"
},
"share_industries": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of industries"
},
"share_skills": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of skills"
},
"share_facebook_profile_url": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of facebook_profile_url"
},
"share_instagram_profile_url": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of instagram_profile_url"
},
"share_twitter": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of twitter"
},
"share_skype": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of skype"
},
"share_linkedin_profile_url": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of linkedin_profile_url"
},
"share_website": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of website"
},
"share_bbm": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of bbm"
},
"share_email": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of email"
},
"share_email2": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of email2"
},
"share_email3": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of email3"
},
"share_mobile_perso": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of mobile_perso"
},
"share_landline_perso": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of landline_perso"
},
"share_mobile_pro": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of mobile_pro"
},
"share_landline_pro": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of landline_pro"
},
"share_postal_personal": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of postal_personal"
},
"share_postal_work": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of postal_work"
},
"share_memberships": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of memberships"
},
"share_educations": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of educations"
},
"share_experiences": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of experiences"
}
}
},
"role_id": {
"type": "integer",
"format": "int32",
"description": "User role ID"
},
"awards": {
"type": "string",
"description": "User awards"
},
"linkedin_profile_url": {
"type": "string",
"description": "User linkedin profile URL"
},
"website": {
"type": "string",
"description": "User Website URL"
},
"skype": {
"type": "string",
"description": "User skype profile"
},
"bbm": {
"type": "string",
"description": "User BlackBerry Messenger profile"
},
"twitter": {
"type": "string",
"description": "User twitter profile"
},
"timezone": {
"type": "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"
],
"description": "User timezone"
},
"facebook_profile_url": {
"type": "string",
"description": "User facebook profile URL"
},
"instagram_profile_url": {
"type": "string",
"description": "User instagram profile URL"
},
"honorary_title": {
"type": "string",
"enum": [
"mr",
"mrs",
"ms",
"dr",
"prof"
],
"description": "User's honorary title"
},
"live_location": {
"description": "User's current location.",
"type": "object",
"properties": {
"city": {
"type": "string",
"description": "City"
},
"country": {
"type": "string",
"description": "Country"
},
"country_code": {
"type": "string",
"description": "ISO3166-2 Country code"
},
"address": {
"type": "string",
"description": "Address"
},
"lat": {
"type": "number",
"format": "float",
"description": "Latitude"
},
"lng": {
"type": "number",
"format": "float",
"description": "Longitude"
}
}
},
"resume": {
"type": "string",
"description": "URL link to the user's resume. This link will be expired if you do not open it in the 60 sec after your request. Another request will be needed"
},
"locale": {
"type": "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"
],
"description": "User Locale"
},
"share_email": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding email"
},
"share_email2": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding secondary email"
},
"share_email3": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding complementary email"
},
"share_postal_address_personal": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding postal home location"
},
"share_postal_address_work": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding postal work location"
},
"share_nationalities": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding nationalities"
},
"share_resume": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding resume"
},
"share_mobile_pro": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding work mobile phone"
},
"share_mobile_perso": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding personal mobile phone"
},
"share_landline_pro": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding professional landline phone"
},
"share_landline_perso": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding personal landline phone"
},
"skills": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"name": {
"type": "string",
"description": "Skill name"
}
}
},
"description": "READ ONLY, list of user skills"
},
"custom_attributes": {
"type": "array",
"items": {
"type": "object"
},
"description": "Array of customizable attributes with name, value and type"
}
},
"description": "User model"
}Get user profileGET/api/admin/v1/users/{id}{?key}
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.
URI Parameters
- id
string(required)- key
string(required)
PUT /api/admin/v1/users/id
Requests
Body
{
"key": "Hello, world!",
"user[postal_personal][address_1]": "Hello, world!",
"user[postal_personal][address_2]": "Hello, world!",
"user[postal_personal][address_3]": "Hello, world!",
"user[postal_personal][city]": "Hello, world!",
"user[postal_personal][state]": "Hello, world!",
"user[postal_personal][full_name]": "Hello, world!",
"user[postal_personal][postal_code]": "Hello, world!",
"user[postal_personal][country]": "Hello, world!",
"user[postal_personal][default_billing_address]": true,
"user[postal_personal][created_at]": "Hello, world!",
"user[postal_personal][updated_at]": "Hello, world!",
"user[postal_work][address_1]": "Hello, world!",
"user[postal_work][address_2]": "Hello, world!",
"user[postal_work][address_3]": "Hello, world!",
"user[postal_work][city]": "Hello, world!",
"user[postal_work][state]": "Hello, world!",
"user[postal_work][full_name]": "Hello, world!",
"user[postal_work][postal_code]": "Hello, world!",
"user[postal_work][country]": "Hello, world!",
"user[postal_work][default_billing_address]": true,
"user[postal_work][created_at]": "Hello, world!",
"user[postal_work][updated_at]": "Hello, world!",
"user[live_location][city]": "Hello, world!",
"user[live_location][country]": "Hello, world!",
"user[live_location][country_code]": "Hello, world!",
"user[live_location][address]": "Hello, world!",
"user[live_location][lat]": 1,
"user[live_location][lng]": 1,
"user[config][private_profile]": true,
"user[config][opt_out_of_directory]": true,
"user[config][opt_out_of_group_directories][]": [],
"user[config][opt_out_of_messaging]": true,
"user[config][share_gender]": "Hello, world!",
"user[config][share_prefix_firstname]": "Hello, world!",
"user[config][share_honorary_title]": "Hello, world!",
"user[config][share_prefix_name]": "Hello, world!",
"user[config][share_suffix_name]": "Hello, world!",
"user[config][share_maidenname]": "Hello, world!",
"user[config][share_birthday]": "Hello, world!",
"user[config][share_birthplace]": "Hello, world!",
"user[config][share_headline]": "Hello, world!",
"user[config][share_live_location]": "Hello, world!",
"user[config][share_sub_networks]": "Hello, world!",
"user[config][share_nationalities]": "Hello, world!",
"user[config][share_resume]": "Hello, world!",
"user[config][share_summary]": "Hello, world!",
"user[config][share_industries]": "Hello, world!",
"user[config][share_skills]": "Hello, world!",
"user[config][share_facebook_profile_url]: - Privacy sharing status of facebook_profile_url": "Hello, world!",
"user[config][share_instagram_profile_url]: - Privacy sharing status of instagram_profile_url": "Hello, world!",
"user[config][share_twitter]": "Hello, world!",
"user[config][share_skype]": "Hello, world!",
"user[config][share_linkedin_profile_url]: - Privacy sharing status of linkedin_profile_url": "Hello, world!",
"user[config][share_website]": "Hello, world!",
"user[config][share_bbm]": "Hello, world!",
"user[config][share_email]": "Hello, world!",
"user[config][share_email2]": "Hello, world!",
"user[config][share_email3]": "Hello, world!",
"user[config][share_mobile_perso]": "Hello, world!",
"user[config][share_landline_perso]": "Hello, world!",
"user[config][share_mobile_pro]": "Hello, world!",
"user[config][share_landline_pro]": "Hello, world!",
"user[config][share_postal_personal]": "Hello, world!",
"user[config][share_postal_work]": "Hello, world!",
"user[config][share_memberships]": "Hello, world!",
"user[config][share_educations]": "Hello, world!",
"user[config][share_experiences]": "Hello, world!",
"user[email]": "Hello, world!",
"user[sub_network_ids][]": [
1
],
"user[extended_updated_at]": "Hello, world!",
"user[likes_count]": 1,
"user[comments_count]": "Hello, world!",
"user[email2]": "Hello, world!",
"user[email3]": "Hello, world!",
"user[primary_email_choice]": "Hello, world!",
"user[firstname]": "Hello, world!",
"user[lastname]": "Hello, world!",
"user[maidenname]": "Hello, world!",
"user[prefix_firstname]": "Hello, world!",
"user[prefix_name]": "Hello, world!",
"user[suffix_name]": "Hello, world!",
"user[external_id]": "Hello, world!",
"user[sso_identifier]": "Hello, world!",
"user[previous_id]": "Hello, world!",
"user[last_visited_at]": "Hello, world!",
"user[sign_in_count]": "Hello, world!",
"user[is_active]": true,
"user[gender]": "Hello, world!",
"user[birthday]": "Hello, world!",
"user[birthplace]": "Hello, world!",
"user[headline]": "Hello, world!",
"user[summary]": "Hello, world!",
"user[created_at]": "Hello, world!",
"user[updated_at]": "Hello, world!",
"user[citizenship_ids][]": [
1
],
"user[citizenship_country_codes][]": [],
"user[deceased]": true,
"user[deceased_at]": "Hello, world!",
"user[do_not_contact]": true,
"user[mobile_perso]": "Hello, world!",
"user[mobile_pro]": "Hello, world!",
"user[landline_perso]": "Hello, world!",
"user[landline_pro]": "Hello, world!",
"user[preferred_phone_number]": "Hello, world!",
"user[preferred_postal_address]": "Hello, world!",
"user[role_id]": 1,
"user[awards]": "Hello, world!",
"user[linkedin_profile_url]": "Hello, world!",
"user[website]": "Hello, world!",
"user[skype]": "Hello, world!",
"user[bbm]": "Hello, world!",
"user[twitter]": "Hello, world!",
"user[timezone]": "Hello, world!",
"user[facebook_profile_url]": "Hello, world!",
"user[instagram_profile_url]": "Hello, world!",
"user[honorary_title]": "Hello, world!",
"user[locale]": "Hello, world!",
"user[share_email]": "Hello, world!",
"user[share_email2]": "Hello, world!",
"user[share_email3]": "Hello, world!",
"user[share_postal_address_personal]": "Hello, world!",
"user[share_postal_address_work]": "Hello, world!",
"user[share_nationalities]": "Hello, world!",
"user[share_resume]": "Hello, world!",
"user[share_mobile_pro]": "Hello, world!",
"user[share_mobile_perso]": "Hello, world!",
"user[share_landline_pro]": "Hello, world!",
"user[share_landline_perso]": "Hello, world!",
"user[skills][]": [],
"user[custom_attributes][]": [],
"user[photo]": "Hello, world!",
"user[resume]": "Hello, world!"
}Schema
{
"type": "object",
"properties": {
"key": {
"type": "string"
},
"user[postal_personal][address_1]": {
"type": "string",
"description": "Address line 1"
},
"user[postal_personal][address_2]": {
"type": "string",
"description": "Address line 2"
},
"user[postal_personal][address_3]": {
"type": "string",
"description": "Address line 3"
},
"user[postal_personal][city]": {
"type": "string",
"description": "City"
},
"user[postal_personal][state]": {
"type": "string",
"description": "State"
},
"user[postal_personal][full_name]": {
"type": "string",
"description": "Full name"
},
"user[postal_personal][postal_code]": {
"type": "string",
"description": "Zip code"
},
"user[postal_personal][country]": {
"type": "string",
"description": "Country"
},
"user[postal_personal][default_billing_address]": {
"type": "boolean",
"description": "is the default billing address for the user ?"
},
"user[postal_personal][created_at]": {
"type": "string",
"description": "Postal address creation date time - iso8601"
},
"user[postal_personal][updated_at]": {
"type": "string",
"description": "Postal address last update date time - iso8601"
},
"user[postal_work][address_1]": {
"type": "string",
"description": "Address line 1"
},
"user[postal_work][address_2]": {
"type": "string",
"description": "Address line 2"
},
"user[postal_work][address_3]": {
"type": "string",
"description": "Address line 3"
},
"user[postal_work][city]": {
"type": "string",
"description": "City"
},
"user[postal_work][state]": {
"type": "string",
"description": "State"
},
"user[postal_work][full_name]": {
"type": "string",
"description": "Full name"
},
"user[postal_work][postal_code]": {
"type": "string",
"description": "Zip code"
},
"user[postal_work][country]": {
"type": "string",
"description": "Country"
},
"user[postal_work][default_billing_address]": {
"type": "boolean",
"description": "is the default billing address for the user ?"
},
"user[postal_work][created_at]": {
"type": "string",
"description": "Postal address creation date time - iso8601"
},
"user[postal_work][updated_at]": {
"type": "string",
"description": "Postal address last update date time - iso8601"
},
"user[live_location][city]": {
"type": "string",
"description": "City"
},
"user[live_location][country]": {
"type": "string",
"description": "Country"
},
"user[live_location][country_code]": {
"type": "string",
"description": "ISO3166-2 Country code"
},
"user[live_location][address]": {
"type": "string",
"description": "Address"
},
"user[live_location][lat]": {
"type": "number",
"description": "Latitude"
},
"user[live_location][lng]": {
"type": "number",
"description": "Longitude"
},
"user[config][private_profile]": {
"type": "boolean",
"description": "Unique ID"
},
"user[config][opt_out_of_directory]": {
"type": "boolean",
"description": "Unique ID"
},
"user[config][opt_out_of_group_directories][]": {
"type": "array",
"description": "Unique ID\n\n+"
},
"user[config][opt_out_of_messaging]": {
"type": "boolean",
"description": "Opt out of messaging"
},
"user[config][share_gender]": {
"type": "string",
"description": "Privacy sharing status of gender"
},
"user[config][share_prefix_firstname]": {
"type": "string",
"description": "Privacy sharing status of prefix_firstname"
},
"user[config][share_honorary_title]": {
"type": "string",
"description": "Privacy sharing status of honorary_title"
},
"user[config][share_prefix_name]": {
"type": "string",
"description": "Privacy sharing status of prefix_name"
},
"user[config][share_suffix_name]": {
"type": "string",
"description": "Privacy sharing status of suffix_name"
},
"user[config][share_maidenname]": {
"type": "string",
"description": "Privacy sharing status of maidenname"
},
"user[config][share_birthday]": {
"type": "string",
"description": "Privacy sharing status of birthday"
},
"user[config][share_birthplace]": {
"type": "string",
"description": "Privacy sharing status of birthplace"
},
"user[config][share_headline]": {
"type": "string",
"description": "Privacy sharing status of headline"
},
"user[config][share_live_location]": {
"type": "string",
"description": "Privacy sharing status of live_location"
},
"user[config][share_sub_networks]": {
"type": "string",
"description": "Privacy sharing status of sub_networks"
},
"user[config][share_nationalities]": {
"type": "string",
"description": "Privacy sharing status of nationalities"
},
"user[config][share_resume]": {
"type": "string",
"description": "Privacy sharing status of resume"
},
"user[config][share_summary]": {
"type": "string",
"description": "Privacy sharing status of summary"
},
"user[config][share_industries]": {
"type": "string",
"description": "Privacy sharing status of industries"
},
"user[config][share_skills]": {
"type": "string",
"description": "Privacy sharing status of skills"
},
"user[config][share_facebook_profile_url]: - Privacy sharing status of facebook_profile_url": {
"type": "string"
},
"user[config][share_instagram_profile_url]: - Privacy sharing status of instagram_profile_url": {
"type": "string"
},
"user[config][share_twitter]": {
"type": "string",
"description": "Privacy sharing status of twitter"
},
"user[config][share_skype]": {
"type": "string",
"description": "Privacy sharing status of skype"
},
"user[config][share_linkedin_profile_url]: - Privacy sharing status of linkedin_profile_url": {
"type": "string"
},
"user[config][share_website]": {
"type": "string",
"description": "Privacy sharing status of website"
},
"user[config][share_bbm]": {
"type": "string",
"description": "Privacy sharing status of bbm"
},
"user[config][share_email]": {
"type": "string",
"description": "Privacy sharing status of email"
},
"user[config][share_email2]": {
"type": "string",
"description": "Privacy sharing status of email2"
},
"user[config][share_email3]": {
"type": "string",
"description": "Privacy sharing status of email3"
},
"user[config][share_mobile_perso]": {
"type": "string",
"description": "Privacy sharing status of mobile_perso"
},
"user[config][share_landline_perso]": {
"type": "string",
"description": "Privacy sharing status of landline_perso"
},
"user[config][share_mobile_pro]": {
"type": "string",
"description": "Privacy sharing status of mobile_pro"
},
"user[config][share_landline_pro]": {
"type": "string",
"description": "Privacy sharing status of landline_pro"
},
"user[config][share_postal_personal]": {
"type": "string",
"description": "Privacy sharing status of postal_personal"
},
"user[config][share_postal_work]": {
"type": "string",
"description": "Privacy sharing status of postal_work"
},
"user[config][share_memberships]": {
"type": "string",
"description": "Privacy sharing status of memberships"
},
"user[config][share_educations]": {
"type": "string",
"description": "Privacy sharing status of educations"
},
"user[config][share_experiences]": {
"type": "string",
"description": "Privacy sharing status of experiences"
},
"user[email]": {
"type": "string",
"description": "User email"
},
"user[sub_network_ids][]": {
"type": "array",
"items": {
"type": "number"
},
"description": "IDs list of user sub networks"
},
"user[extended_updated_at]": {
"type": "string",
"description": "User full profile ( with experiences, educations, customs) last update date time - iso8601"
},
"user[likes_count]": {
"type": "number",
"description": "Total count of likes on this Likeable"
},
"user[comments_count]": {
"type": "string",
"description": "Total count of comment for this Commentable"
},
"user[email2]": {
"type": "string",
"description": "User secondary email"
},
"user[email3]": {
"type": "string",
"description": "User complementary email"
},
"user[primary_email_choice]": {
"type": "string",
"description": "User primary email choice"
},
"user[firstname]": {
"type": "string",
"description": "User first name"
},
"user[lastname]": {
"type": "string",
"description": "User last name"
},
"user[maidenname]": {
"type": "string",
"description": "User maiden name"
},
"user[prefix_firstname]": {
"type": "string",
"description": "User prefix firstname"
},
"user[prefix_name]": {
"type": "string",
"description": "User prefix name"
},
"user[suffix_name]": {
"type": "string",
"description": "User suffix name"
},
"user[external_id]": {
"type": "string",
"description": "User ID in your database"
},
"user[sso_identifier]": {
"type": "string",
"description": "User identifier for SSO"
},
"user[previous_id]": {
"type": "string",
"description": "User ID in your community system"
},
"user[last_visited_at]": {
"type": "string",
"description": "Date of last visit - iso8601. READ only, can't be updated"
},
"user[sign_in_count]": {
"type": "string",
"description": "Number of platform visits. READ only, can't be updated"
},
"user[is_active]": {
"type": "boolean",
"description": "User account enabled ?"
},
"user[gender]": {
"type": "string",
"description": "User gender (male/female/other)"
},
"user[birthday]": {
"type": "string",
"description": "User birth date"
},
"user[birthplace]": {
"type": "string",
"description": "User birth place"
},
"user[headline]": {
"type": "string",
"description": "User headline"
},
"user[summary]": {
"type": "string",
"description": "User summary"
},
"user[created_at]": {
"type": "string",
"description": "User creation date time - iso8601. READ only, can't be updated"
},
"user[updated_at]": {
"type": "string",
"description": "User last update date time - iso8601. READ only, can't be updated"
},
"user[citizenship_ids][]": {
"type": "array",
"items": {
"type": "number"
},
"description": "List of citizenship IDs"
},
"user[citizenship_country_codes][]": {
"type": "array",
"description": "List of ISO-3166-2 citizenship country codes\n\n+"
},
"user[deceased]": {
"type": "boolean",
"description": "User deceased ?"
},
"user[deceased_at]": {
"type": "string",
"description": "User decease date time - iso8601."
},
"user[do_not_contact]": {
"type": "boolean",
"description": "User can be contacted ?"
},
"user[mobile_perso]": {
"type": "string",
"description": "User mobile perso number"
},
"user[mobile_pro]": {
"type": "string",
"description": "User mobile pro number"
},
"user[landline_perso]": {
"type": "string",
"description": "User landline perso number"
},
"user[landline_pro]": {
"type": "string",
"description": "User landline pro number"
},
"user[preferred_phone_number]": {
"type": "string",
"description": "User preferred phone number"
},
"user[preferred_postal_address]": {
"type": "string",
"description": "User preferred postal address"
},
"user[role_id]": {
"type": "number",
"description": "User role ID"
},
"user[awards]": {
"type": "string",
"description": "User awards"
},
"user[linkedin_profile_url]": {
"type": "string",
"description": "User linkedin profile URL"
},
"user[website]": {
"type": "string",
"description": "User Website URL"
},
"user[skype]": {
"type": "string",
"description": "User skype profile"
},
"user[bbm]": {
"type": "string",
"description": "User BlackBerry Messenger profile"
},
"user[twitter]": {
"type": "string",
"description": "User twitter profile"
},
"user[timezone]": {
"type": "string",
"description": "User timezone"
},
"user[facebook_profile_url]": {
"type": "string",
"description": "User facebook profile URL"
},
"user[instagram_profile_url]": {
"type": "string",
"description": "User instagram profile URL"
},
"user[honorary_title]": {
"type": "string",
"description": "User's honorary title"
},
"user[locale]": {
"type": "string",
"description": "User Locale"
},
"user[share_email]": {
"type": "string",
"description": "User's visibility information regarding email"
},
"user[share_email2]": {
"type": "string",
"description": "User's visibility information regarding secondary email"
},
"user[share_email3]": {
"type": "string",
"description": "User's visibility information regarding complementary email"
},
"user[share_postal_address_personal]": {
"type": "string",
"description": "User's visibility information regarding postal home location"
},
"user[share_postal_address_work]": {
"type": "string",
"description": "User's visibility information regarding postal work location"
},
"user[share_nationalities]": {
"type": "string",
"description": "User's visibility information regarding nationalities"
},
"user[share_resume]": {
"type": "string",
"description": "User's visibility information regarding resume"
},
"user[share_mobile_pro]": {
"type": "string",
"description": "User's visibility information regarding work mobile phone"
},
"user[share_mobile_perso]": {
"type": "string",
"description": "User's visibility information regarding personal mobile phone"
},
"user[share_landline_pro]": {
"type": "string",
"description": "User's visibility information regarding professional landline phone"
},
"user[share_landline_perso]": {
"type": "string",
"description": "User's visibility information regarding personal landline phone"
},
"user[skills][]": {
"type": "array",
"description": "READ ONLY, list of user skills\n\n+"
},
"user[custom_attributes][]": {
"type": "array",
"description": "Array of customizable attributes with name, value and type\n\n+"
},
"user[photo]": {
"type": "string",
"description": "Profile picture of the user"
},
"user[resume]": {
"type": "string",
"description": "Resume of the user"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Update existing user
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"email": {
"type": "string",
"description": "User email"
},
"name": {
"type": "string",
"description": "User full name"
},
"sub_network_ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": "IDs list of user sub networks"
},
"extended_updated_at": {
"type": "string",
"format": "date-time",
"description": "User full profile ( with experiences, educations, customs) last update date time - iso8601"
},
"likeable_type": {
"type": "string",
"description": "Type to use on API query"
},
"current_user_like_id": {
"type": "integer",
"format": "int32",
"description": "Like ID of the current_user if they like the Likeable"
},
"likes_count": {
"type": "integer",
"format": "int32",
"description": "Total count of likes on this Likeable"
},
"commentable_type": {
"type": "string",
"description": "Type to use on API query"
},
"comments_count": {
"type": "string",
"description": "Total count of comment for this Commentable"
},
"email2": {
"type": "string",
"description": "User secondary email"
},
"email3": {
"type": "string",
"description": "User complementary email"
},
"primary_email_choice": {
"type": "string",
"enum": [
"email",
"email2",
"email3"
],
"description": "User primary email choice"
},
"firstname": {
"type": "string",
"description": "User first name"
},
"lastname": {
"type": "string",
"description": "User last name"
},
"maidenname": {
"type": "string",
"description": "User maiden name"
},
"prefix_firstname": {
"type": "string",
"description": "User prefix firstname"
},
"prefix_name": {
"type": "string",
"description": "User prefix name"
},
"suffix_name": {
"type": "string",
"description": "User suffix name"
},
"external_id": {
"type": "string",
"description": "User ID in your database"
},
"sso_identifier": {
"type": "string",
"description": "User identifier for SSO"
},
"previous_id": {
"type": "string",
"description": "User ID in your community system"
},
"last_visited_at": {
"type": "string",
"format": "date-time",
"description": "Date of last visit - iso8601. READ only, can't be updated"
},
"sign_in_count": {
"type": "string",
"description": "Number of platform visits. READ only, can't be updated"
},
"is_active": {
"type": "boolean",
"description": "User account enabled ?"
},
"gender": {
"type": "string",
"enum": [
"male",
"female",
"other"
],
"description": "User gender (male/female/other)"
},
"birthday": {
"type": "string",
"format": "date",
"description": "User birth date"
},
"birthplace": {
"type": "string",
"description": "User birth place"
},
"headline": {
"type": "string",
"description": "User headline"
},
"summary": {
"type": "string",
"description": "User summary"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "User creation date time - iso8601. READ only, can't be updated"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "User last update date time - iso8601. READ only, can't be updated"
},
"confirmed_at": {
"type": "string",
"format": "date-time",
"description": "User activation date time - iso8601. READ only, can't be updated"
},
"citizenship_ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": "List of citizenship IDs"
},
"citizenship_country_codes": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of ISO-3166-2 citizenship country codes"
},
"deceased": {
"type": "boolean",
"description": "User deceased ?"
},
"deceased_at": {
"type": "string",
"format": "date-time",
"description": "User decease date time - iso8601."
},
"photo": {
"type": "object",
"properties": {
"compressed-url": {
"type": "string",
"description": "User compressed photo url"
},
"large-url": {
"type": "string",
"description": "User large photo url"
},
"medium-url": {
"type": "string",
"description": "User medium photo url"
},
"thumb-url": {
"type": "string",
"description": "User thumb photo url"
},
"mini-url": {
"type": "string",
"description": "User mini photo url"
},
"friend-url": {
"type": "string",
"description": "User friend photo url"
},
"icon-url": {
"type": "string",
"description": "User icon photo url"
}
},
"description": "User photo urls"
},
"do_not_contact": {
"type": "boolean",
"description": "User can be contacted ?"
},
"mobile_perso": {
"type": "string",
"description": "User mobile perso number"
},
"mobile_pro": {
"type": "string",
"description": "User mobile pro number"
},
"landline_perso": {
"type": "string",
"description": "User landline perso number"
},
"landline_pro": {
"type": "string",
"description": "User landline pro number"
},
"preferred_phone_number": {
"type": "string",
"enum": [
"mobile_pro",
"mobile_perso",
"landline_pro",
"landline_perso",
"none"
],
"description": "User preferred phone number"
},
"postal_personal": {
"description": "User personal postal address",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"address_1": {
"type": "string",
"description": "Address line 1"
},
"address_2": {
"type": "string",
"description": "Address line 2"
},
"address_3": {
"type": "string",
"description": "Address line 3"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "State"
},
"full_name": {
"type": "string",
"description": "Full name"
},
"postal_code": {
"type": "string",
"description": "Zip code"
},
"country": {
"type": "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"
],
"description": "Country"
},
"default_billing_address": {
"type": "boolean",
"description": "is the default billing address for the user ?"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Postal address creation date time - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Postal address last update date time - iso8601"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "User ID linked to postal address"
}
}
},
"postal_work": {
"description": "User work postal address",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"address_1": {
"type": "string",
"description": "Address line 1"
},
"address_2": {
"type": "string",
"description": "Address line 2"
},
"address_3": {
"type": "string",
"description": "Address line 3"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "State"
},
"full_name": {
"type": "string",
"description": "Full name"
},
"postal_code": {
"type": "string",
"description": "Zip code"
},
"country": {
"type": "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"
],
"description": "Country"
},
"default_billing_address": {
"type": "boolean",
"description": "is the default billing address for the user ?"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Postal address creation date time - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Postal address last update date time - iso8601"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "User ID linked to postal address"
}
}
},
"preferred_postal_address": {
"type": "string",
"enum": [
"postal_personal",
"postal_work"
],
"description": "User preferred postal address"
},
"config": {
"description": "User specific configuration",
"type": "object",
"properties": {
"private_profile": {
"type": "boolean",
"description": "Unique ID"
},
"opt_out_of_directory": {
"type": "boolean",
"description": "Unique ID"
},
"opt_out_of_group_directories": {
"type": "array",
"items": {
"type": "object"
},
"description": "Unique ID"
},
"opt_out_of_messaging": {
"type": "boolean",
"description": "Opt out of messaging"
},
"share_gender": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of gender"
},
"share_prefix_firstname": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of prefix_firstname"
},
"share_honorary_title": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of honorary_title"
},
"share_prefix_name": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of prefix_name"
},
"share_suffix_name": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of suffix_name"
},
"share_maidenname": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of maidenname"
},
"share_birthday": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of birthday"
},
"share_birthplace": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of birthplace"
},
"share_headline": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of headline"
},
"share_live_location": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of live_location"
},
"share_sub_networks": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of sub_networks"
},
"share_nationalities": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of nationalities"
},
"share_resume": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of resume"
},
"share_summary": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of summary"
},
"share_industries": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of industries"
},
"share_skills": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of skills"
},
"share_facebook_profile_url": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of facebook_profile_url"
},
"share_instagram_profile_url": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of instagram_profile_url"
},
"share_twitter": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of twitter"
},
"share_skype": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of skype"
},
"share_linkedin_profile_url": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of linkedin_profile_url"
},
"share_website": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of website"
},
"share_bbm": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of bbm"
},
"share_email": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of email"
},
"share_email2": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of email2"
},
"share_email3": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of email3"
},
"share_mobile_perso": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of mobile_perso"
},
"share_landline_perso": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of landline_perso"
},
"share_mobile_pro": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of mobile_pro"
},
"share_landline_pro": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of landline_pro"
},
"share_postal_personal": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of postal_personal"
},
"share_postal_work": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of postal_work"
},
"share_memberships": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of memberships"
},
"share_educations": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of educations"
},
"share_experiences": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of experiences"
}
}
},
"role_id": {
"type": "integer",
"format": "int32",
"description": "User role ID"
},
"awards": {
"type": "string",
"description": "User awards"
},
"linkedin_profile_url": {
"type": "string",
"description": "User linkedin profile URL"
},
"website": {
"type": "string",
"description": "User Website URL"
},
"skype": {
"type": "string",
"description": "User skype profile"
},
"bbm": {
"type": "string",
"description": "User BlackBerry Messenger profile"
},
"twitter": {
"type": "string",
"description": "User twitter profile"
},
"timezone": {
"type": "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"
],
"description": "User timezone"
},
"facebook_profile_url": {
"type": "string",
"description": "User facebook profile URL"
},
"instagram_profile_url": {
"type": "string",
"description": "User instagram profile URL"
},
"honorary_title": {
"type": "string",
"enum": [
"mr",
"mrs",
"ms",
"dr",
"prof"
],
"description": "User's honorary title"
},
"live_location": {
"description": "User's current location.",
"type": "object",
"properties": {
"city": {
"type": "string",
"description": "City"
},
"country": {
"type": "string",
"description": "Country"
},
"country_code": {
"type": "string",
"description": "ISO3166-2 Country code"
},
"address": {
"type": "string",
"description": "Address"
},
"lat": {
"type": "number",
"format": "float",
"description": "Latitude"
},
"lng": {
"type": "number",
"format": "float",
"description": "Longitude"
}
}
},
"resume": {
"type": "string",
"description": "URL link to the user's resume. This link will be expired if you do not open it in the 60 sec after your request. Another request will be needed"
},
"locale": {
"type": "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"
],
"description": "User Locale"
},
"share_email": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding email"
},
"share_email2": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding secondary email"
},
"share_email3": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding complementary email"
},
"share_postal_address_personal": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding postal home location"
},
"share_postal_address_work": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding postal work location"
},
"share_nationalities": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding nationalities"
},
"share_resume": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding resume"
},
"share_mobile_pro": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding work mobile phone"
},
"share_mobile_perso": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding personal mobile phone"
},
"share_landline_pro": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding professional landline phone"
},
"share_landline_perso": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding personal landline phone"
},
"skills": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"name": {
"type": "string",
"description": "Skill name"
}
}
},
"description": "READ ONLY, list of user skills"
},
"custom_attributes": {
"type": "array",
"items": {
"type": "object"
},
"description": "Array of customizable attributes with name, value and type"
}
},
"description": "User model"
}Validations Failed
Schema
{
"type": "object",
"properties": {
"status": {
"type": "integer",
"format": "int32",
"description": "Status Code"
},
"errors": {
"type": "string",
"description": "Errors list"
}
},
"description": "Error model"
}Update existing userPUT/api/admin/v1/users/{id}
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)
URI Parameters
- id
string(required)User ID
DELETE /api/admin/v1/users/id?key=
Responses
Delete User
Delete UserDELETE/api/admin/v1/users/{id}{?key}
Delete the user based on it’s ID
URI Parameters
- id
string(required)- key
string(required)
POST /api/admin/v1/users/find
Requests
Body
{
"field": "Hello, world!",
"value": "Hello, world!"
}Schema
{
"type": "object",
"properties": {
"field": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"field",
"value"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Find a user by a specific field
Find a user by a specific fieldPOST/api/admin/v1/users/find
Find a user by a specific field
Find a user by a specific field. Supported fields are external_id, previous_id, or email.
POST /api/admin/v1/users/_bulk
Requests
Body
{
"users[][email]": [],
"users[][sub_network_ids][]": [
1
],
"users[][postal_personal][address_1]": [],
"users[][postal_personal][address_2]": [],
"users[][postal_personal][address_3]": [],
"users[][postal_personal][city]": [],
"users[][postal_personal][state]": [],
"users[][postal_personal][full_name]": [],
"users[][postal_personal][postal_code]": [],
"users[][postal_personal][country]": [],
"users[][postal_personal][default_billing_address]": [
true
],
"users[][postal_personal][created_at]": [],
"users[][postal_personal][updated_at]": [],
"users[][postal_work][address_1]": [],
"users[][postal_work][address_2]": [],
"users[][postal_work][address_3]": [],
"users[][postal_work][city]": [],
"users[][postal_work][state]": [],
"users[][postal_work][full_name]": [],
"users[][postal_work][postal_code]": [],
"users[][postal_work][country]": [],
"users[][postal_work][default_billing_address]": [
true
],
"users[][postal_work][created_at]": [],
"users[][postal_work][updated_at]": [],
"users[][live_location][city]": [],
"users[][live_location][country]": [],
"users[][live_location][country_code]": [],
"users[][live_location][address]": [],
"users[][live_location][lat]": [
1
],
"users[][live_location][lng]": [
1
],
"users[][config][private_profile]": [
true
],
"users[][config][opt_out_of_directory]": [
true
],
"users[][config][opt_out_of_group_directories][]": [],
"users[][config][opt_out_of_messaging]": [
true
],
"users[][config][share_gender]": [],
"users[][config][share_prefix_firstname]": [],
"users[][config][share_honorary_title]": [],
"users[][config][share_prefix_name]": [],
"users[][config][share_suffix_name]": [],
"users[][config][share_maidenname]": [],
"users[][config][share_birthday]": [],
"users[][config][share_birthplace]": [],
"users[][config][share_headline]": [],
"users[][config][share_live_location]": [],
"users[][config][share_sub_networks]": [],
"users[][config][share_nationalities]": [],
"users[][config][share_resume]": [],
"users[][config][share_summary]": [],
"users[][config][share_industries]": [],
"users[][config][share_skills]": [],
"users[][config][share_facebook_profile_url] (array) - Privacy sharing status of facebook_profile_url": "Hello, world!",
"users[][config][share_instagram_profile_url] (array) - Privacy sharing status of instagram_profile_url": "Hello, world!",
"users[][config][share_twitter]": [],
"users[][config][share_skype]": [],
"users[][config][share_linkedin_profile_url] (array) - Privacy sharing status of linkedin_profile_url": "Hello, world!",
"users[][config][share_website]": [],
"users[][config][share_bbm]": [],
"users[][config][share_email]": [],
"users[][config][share_email2]": [],
"users[][config][share_email3]": [],
"users[][config][share_mobile_perso]": [],
"users[][config][share_landline_perso]": [],
"users[][config][share_mobile_pro]": [],
"users[][config][share_landline_pro]": [],
"users[][config][share_postal_personal]": [],
"users[][config][share_postal_work]": [],
"users[][config][share_memberships]": [],
"users[][config][share_educations]": [],
"users[][config][share_experiences]": [],
"users[][extended_updated_at]": [],
"users[][likes_count]": [
1
],
"users[][comments_count]": [],
"users[][email2]": [],
"users[][email3]": [],
"users[][primary_email_choice]": [],
"users[][firstname]": [],
"users[][lastname]": [],
"users[][maidenname]": [],
"users[][prefix_firstname]": [],
"users[][prefix_name]": [],
"users[][suffix_name]": [],
"users[][external_id]": [],
"users[][sso_identifier]": [],
"users[][previous_id]": [],
"users[][last_visited_at]": [],
"users[][sign_in_count]": [],
"users[][is_active]": [
true
],
"users[][gender]": [],
"users[][birthday]": [],
"users[][birthplace]": [],
"users[][headline]": [],
"users[][summary]": [],
"users[][created_at]": [],
"users[][updated_at]": [],
"users[][citizenship_ids][]": [],
"users[][citizenship_country_codes][]": [],
"users[][deceased]": [
true
],
"users[][deceased_at]": [],
"users[][do_not_contact]": [
true
],
"users[][mobile_perso]": [],
"users[][mobile_pro]": [],
"users[][landline_perso]": [],
"users[][landline_pro]": [],
"users[][preferred_phone_number]": [],
"users[][preferred_postal_address]": [],
"users[][role_id]": [
1
],
"users[][awards]": [],
"users[][linkedin_profile_url]": [],
"users[][website]": [],
"users[][skype]": [],
"users[][bbm]": [],
"users[][twitter]": [],
"users[][timezone]": [],
"users[][facebook_profile_url]": [],
"users[][instagram_profile_url]": [],
"users[][honorary_title]": [],
"users[][locale]": [],
"users[][share_email]": [],
"users[][share_email2]": [],
"users[][share_email3]": [],
"users[][share_postal_address_personal]": [],
"users[][share_postal_address_work]": [],
"users[][share_nationalities]": [],
"users[][share_resume]": [],
"users[][share_mobile_pro]": [],
"users[][share_mobile_perso]": [],
"users[][share_landline_pro]": [],
"users[][share_landline_perso]": [],
"users[][skills][]": [],
"users[][custom_attributes][]": [],
"users[][photo]": [],
"users[][resume]": [],
"users[][notify_after_create]": []
}Schema
{
"type": "object",
"properties": {
"users[][email]": {
"type": "array",
"description": "User email\n\n+"
},
"users[][sub_network_ids][]": {
"type": "array",
"items": {
"type": "number"
},
"description": "User sub networks ids"
},
"users[][postal_personal][address_1]": {
"type": "array",
"description": "Address line 1\n\n+"
},
"users[][postal_personal][address_2]": {
"type": "array",
"description": "Address line 2\n\n+"
},
"users[][postal_personal][address_3]": {
"type": "array",
"description": "Address line 3\n\n+"
},
"users[][postal_personal][city]": {
"type": "array",
"description": "City\n\n+"
},
"users[][postal_personal][state]": {
"type": "array",
"description": "State\n\n+"
},
"users[][postal_personal][full_name]": {
"type": "array",
"description": "Full name\n\n+"
},
"users[][postal_personal][postal_code]": {
"type": "array",
"description": "Zip code\n\n+"
},
"users[][postal_personal][country]": {
"type": "array",
"description": "Country\n\n+"
},
"users[][postal_personal][default_billing_address]": {
"type": "array",
"items": {
"type": "boolean"
},
"description": "is the default billing address for the user ?"
},
"users[][postal_personal][created_at]": {
"type": "array",
"description": "Postal address creation date time - iso8601\n\n+"
},
"users[][postal_personal][updated_at]": {
"type": "array",
"description": "Postal address last update date time - iso8601\n\n+"
},
"users[][postal_work][address_1]": {
"type": "array",
"description": "Address line 1\n\n+"
},
"users[][postal_work][address_2]": {
"type": "array",
"description": "Address line 2\n\n+"
},
"users[][postal_work][address_3]": {
"type": "array",
"description": "Address line 3\n\n+"
},
"users[][postal_work][city]": {
"type": "array",
"description": "City\n\n+"
},
"users[][postal_work][state]": {
"type": "array",
"description": "State\n\n+"
},
"users[][postal_work][full_name]": {
"type": "array",
"description": "Full name\n\n+"
},
"users[][postal_work][postal_code]": {
"type": "array",
"description": "Zip code\n\n+"
},
"users[][postal_work][country]": {
"type": "array",
"description": "Country\n\n+"
},
"users[][postal_work][default_billing_address]": {
"type": "array",
"items": {
"type": "boolean"
},
"description": "is the default billing address for the user ?"
},
"users[][postal_work][created_at]": {
"type": "array",
"description": "Postal address creation date time - iso8601\n\n+"
},
"users[][postal_work][updated_at]": {
"type": "array",
"description": "Postal address last update date time - iso8601\n\n+"
},
"users[][live_location][city]": {
"type": "array",
"description": "City\n\n+"
},
"users[][live_location][country]": {
"type": "array",
"description": "Country\n\n+"
},
"users[][live_location][country_code]": {
"type": "array",
"description": "ISO3166-2 Country code\n\n+"
},
"users[][live_location][address]": {
"type": "array",
"description": "Address\n\n+"
},
"users[][live_location][lat]": {
"type": "array",
"items": {
"type": "number"
},
"description": "Latitude"
},
"users[][live_location][lng]": {
"type": "array",
"items": {
"type": "number"
},
"description": "Longitude"
},
"users[][config][private_profile]": {
"type": "array",
"items": {
"type": "boolean"
},
"description": "Unique ID"
},
"users[][config][opt_out_of_directory]": {
"type": "array",
"items": {
"type": "boolean"
},
"description": "Unique ID"
},
"users[][config][opt_out_of_group_directories][]": {
"type": "array",
"description": "Unique ID\n\n+"
},
"users[][config][opt_out_of_messaging]": {
"type": "array",
"items": {
"type": "boolean"
},
"description": "Opt out of messaging"
},
"users[][config][share_gender]": {
"type": "array",
"description": "Privacy sharing status of gender\n\n+"
},
"users[][config][share_prefix_firstname]": {
"type": "array",
"description": "Privacy sharing status of prefix_firstname\n\n+"
},
"users[][config][share_honorary_title]": {
"type": "array",
"description": "Privacy sharing status of honorary_title\n\n+"
},
"users[][config][share_prefix_name]": {
"type": "array",
"description": "Privacy sharing status of prefix_name\n\n+"
},
"users[][config][share_suffix_name]": {
"type": "array",
"description": "Privacy sharing status of suffix_name\n\n+"
},
"users[][config][share_maidenname]": {
"type": "array",
"description": "Privacy sharing status of maidenname\n\n+"
},
"users[][config][share_birthday]": {
"type": "array",
"description": "Privacy sharing status of birthday\n\n+"
},
"users[][config][share_birthplace]": {
"type": "array",
"description": "Privacy sharing status of birthplace\n\n+"
},
"users[][config][share_headline]": {
"type": "array",
"description": "Privacy sharing status of headline\n\n+"
},
"users[][config][share_live_location]": {
"type": "array",
"description": "Privacy sharing status of live_location\n\n+"
},
"users[][config][share_sub_networks]": {
"type": "array",
"description": "Privacy sharing status of sub_networks\n\n+"
},
"users[][config][share_nationalities]": {
"type": "array",
"description": "Privacy sharing status of nationalities\n\n+"
},
"users[][config][share_resume]": {
"type": "array",
"description": "Privacy sharing status of resume\n\n+"
},
"users[][config][share_summary]": {
"type": "array",
"description": "Privacy sharing status of summary\n\n+"
},
"users[][config][share_industries]": {
"type": "array",
"description": "Privacy sharing status of industries\n\n+"
},
"users[][config][share_skills]": {
"type": "array",
"description": "Privacy sharing status of skills\n\n+"
},
"users[][config][share_facebook_profile_url] (array) - Privacy sharing status of facebook_profile_url": {
"type": "string",
"description": "+"
},
"users[][config][share_instagram_profile_url] (array) - Privacy sharing status of instagram_profile_url": {
"type": "string",
"description": "+"
},
"users[][config][share_twitter]": {
"type": "array",
"description": "Privacy sharing status of twitter\n\n+"
},
"users[][config][share_skype]": {
"type": "array",
"description": "Privacy sharing status of skype\n\n+"
},
"users[][config][share_linkedin_profile_url] (array) - Privacy sharing status of linkedin_profile_url": {
"type": "string",
"description": "+"
},
"users[][config][share_website]": {
"type": "array",
"description": "Privacy sharing status of website\n\n+"
},
"users[][config][share_bbm]": {
"type": "array",
"description": "Privacy sharing status of bbm\n\n+"
},
"users[][config][share_email]": {
"type": "array",
"description": "Privacy sharing status of email\n\n+"
},
"users[][config][share_email2]": {
"type": "array",
"description": "Privacy sharing status of email2\n\n+"
},
"users[][config][share_email3]": {
"type": "array",
"description": "Privacy sharing status of email3\n\n+"
},
"users[][config][share_mobile_perso]": {
"type": "array",
"description": "Privacy sharing status of mobile_perso\n\n+"
},
"users[][config][share_landline_perso]": {
"type": "array",
"description": "Privacy sharing status of landline_perso\n\n+"
},
"users[][config][share_mobile_pro]": {
"type": "array",
"description": "Privacy sharing status of mobile_pro\n\n+"
},
"users[][config][share_landline_pro]": {
"type": "array",
"description": "Privacy sharing status of landline_pro\n\n+"
},
"users[][config][share_postal_personal]": {
"type": "array",
"description": "Privacy sharing status of postal_personal\n\n+"
},
"users[][config][share_postal_work]": {
"type": "array",
"description": "Privacy sharing status of postal_work\n\n+"
},
"users[][config][share_memberships]": {
"type": "array",
"description": "Privacy sharing status of memberships\n\n+"
},
"users[][config][share_educations]": {
"type": "array",
"description": "Privacy sharing status of educations\n\n+"
},
"users[][config][share_experiences]": {
"type": "array",
"description": "Privacy sharing status of experiences\n\n+"
},
"users[][extended_updated_at]": {
"type": "array",
"description": "User full profile ( with experiences, educations, customs) last update date time - iso8601\n\n+"
},
"users[][likes_count]": {
"type": "array",
"items": {
"type": "number"
},
"description": "Total count of likes on this Likeable"
},
"users[][comments_count]": {
"type": "array",
"description": "Total count of comment for this Commentable\n\n+"
},
"users[][email2]": {
"type": "array",
"description": "User secondary email\n\n+"
},
"users[][email3]": {
"type": "array",
"description": "User complementary email\n\n+"
},
"users[][primary_email_choice]": {
"type": "array",
"description": "User primary email choice\n\n+"
},
"users[][firstname]": {
"type": "array",
"description": "User first name\n\n+"
},
"users[][lastname]": {
"type": "array",
"description": "User last name\n\n+"
},
"users[][maidenname]": {
"type": "array",
"description": "User maiden name\n\n+"
},
"users[][prefix_firstname]": {
"type": "array",
"description": "User prefix firstname\n\n+"
},
"users[][prefix_name]": {
"type": "array",
"description": "User prefix name\n\n+"
},
"users[][suffix_name]": {
"type": "array",
"description": "User suffix name\n\n+"
},
"users[][external_id]": {
"type": "array",
"description": "User ID in your database\n\n+"
},
"users[][sso_identifier]": {
"type": "array",
"description": "User identifier for SSO\n\n+"
},
"users[][previous_id]": {
"type": "array",
"description": "User ID in your community system\n\n+"
},
"users[][last_visited_at]": {
"type": "array",
"description": "Date of last visit - iso8601. READ only, can't be updated\n\n+"
},
"users[][sign_in_count]": {
"type": "array",
"description": "Number of platform visits. READ only, can't be updated\n\n+"
},
"users[][is_active]": {
"type": "array",
"items": {
"type": "boolean"
},
"description": "User account enabled ?"
},
"users[][gender]": {
"type": "array",
"description": "User gender (male/female/other)\n\n+"
},
"users[][birthday]": {
"type": "array",
"description": "User birth date\n\n+"
},
"users[][birthplace]": {
"type": "array",
"description": "User birth place\n\n+"
},
"users[][headline]": {
"type": "array",
"description": "User headline\n\n+"
},
"users[][summary]": {
"type": "array",
"description": "User summary\n\n+"
},
"users[][created_at]": {
"type": "array",
"description": "User creation date time - iso8601. READ only, can't be updated\n\n+"
},
"users[][updated_at]": {
"type": "array",
"description": "User last update date time - iso8601. READ only, can't be updated\n\n+"
},
"users[][citizenship_ids][]": {
"type": "array",
"description": "List of citizenship IDs\n\n+"
},
"users[][citizenship_country_codes][]": {
"type": "array",
"description": "List of ISO-3166-2 citizenship country codes\n\n+"
},
"users[][deceased]": {
"type": "array",
"items": {
"type": "boolean"
},
"description": "User deceased ?"
},
"users[][deceased_at]": {
"type": "array",
"description": "User decease date time - iso8601.\n\n+"
},
"users[][do_not_contact]": {
"type": "array",
"items": {
"type": "boolean"
},
"description": "User can be contacted ?"
},
"users[][mobile_perso]": {
"type": "array",
"description": "User mobile perso number\n\n+"
},
"users[][mobile_pro]": {
"type": "array",
"description": "User mobile pro number\n\n+"
},
"users[][landline_perso]": {
"type": "array",
"description": "User landline perso number\n\n+"
},
"users[][landline_pro]": {
"type": "array",
"description": "User landline pro number\n\n+"
},
"users[][preferred_phone_number]": {
"type": "array",
"description": "User preferred phone number\n\n+"
},
"users[][preferred_postal_address]": {
"type": "array",
"description": "User preferred postal address\n\n+"
},
"users[][role_id]": {
"type": "array",
"items": {
"type": "number"
},
"description": "User role ID"
},
"users[][awards]": {
"type": "array",
"description": "User awards\n\n+"
},
"users[][linkedin_profile_url]": {
"type": "array",
"description": "User linkedin profile URL\n\n+"
},
"users[][website]": {
"type": "array",
"description": "User Website URL\n\n+"
},
"users[][skype]": {
"type": "array",
"description": "User skype profile\n\n+"
},
"users[][bbm]": {
"type": "array",
"description": "User BlackBerry Messenger profile\n\n+"
},
"users[][twitter]": {
"type": "array",
"description": "User twitter profile\n\n+"
},
"users[][timezone]": {
"type": "array",
"description": "User timezone\n\n+"
},
"users[][facebook_profile_url]": {
"type": "array",
"description": "User facebook profile URL\n\n+"
},
"users[][instagram_profile_url]": {
"type": "array",
"description": "User instagram profile URL\n\n+"
},
"users[][honorary_title]": {
"type": "array",
"description": "User's honorary title\n\n+"
},
"users[][locale]": {
"type": "array",
"description": "User Locale\n\n+"
},
"users[][share_email]": {
"type": "array",
"description": "User's visibility information regarding email\n\n+"
},
"users[][share_email2]": {
"type": "array",
"description": "User's visibility information regarding secondary email\n\n+"
},
"users[][share_email3]": {
"type": "array",
"description": "User's visibility information regarding complementary email\n\n+"
},
"users[][share_postal_address_personal]": {
"type": "array",
"description": "User's visibility information regarding postal home location\n\n+"
},
"users[][share_postal_address_work]": {
"type": "array",
"description": "User's visibility information regarding postal work location\n\n+"
},
"users[][share_nationalities]": {
"type": "array",
"description": "User's visibility information regarding nationalities\n\n+"
},
"users[][share_resume]": {
"type": "array",
"description": "User's visibility information regarding resume\n\n+"
},
"users[][share_mobile_pro]": {
"type": "array",
"description": "User's visibility information regarding work mobile phone\n\n+"
},
"users[][share_mobile_perso]": {
"type": "array",
"description": "User's visibility information regarding personal mobile phone\n\n+"
},
"users[][share_landline_pro]": {
"type": "array",
"description": "User's visibility information regarding professional landline phone\n\n+"
},
"users[][share_landline_perso]": {
"type": "array",
"description": "User's visibility information regarding personal landline phone\n\n+"
},
"users[][skills][]": {
"type": "array",
"description": "READ ONLY, list of user skills\n\n+"
},
"users[][custom_attributes][]": {
"type": "array",
"description": "Array of customizable attributes with name, value and type\n\n+"
},
"users[][photo]": {
"type": "array",
"description": "Profile picture of the user\n\n+"
},
"users[][resume]": {
"type": "array",
"description": "Resume of the user\n\n+"
},
"users[][notify_after_create]": {
"type": "array",
"description": "+"
}
},
"required": [
"users[][email]",
"users[][sub_network_ids][]"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Bulk add users
Schema
{
"type": "object",
"properties": {
"users": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"email": {
"type": "string",
"description": "User email"
},
"name": {
"type": "string",
"description": "User full name"
},
"sub_network_ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": "IDs list of user sub networks"
},
"extended_updated_at": {
"type": "string",
"format": "date-time",
"description": "User full profile ( with experiences, educations, customs) last update date time - iso8601"
},
"likeable_type": {
"type": "string",
"description": "Type to use on API query"
},
"current_user_like_id": {
"type": "integer",
"format": "int32",
"description": "Like ID of the current_user if they like the Likeable"
},
"likes_count": {
"type": "integer",
"format": "int32",
"description": "Total count of likes on this Likeable"
},
"commentable_type": {
"type": "string",
"description": "Type to use on API query"
},
"comments_count": {
"type": "string",
"description": "Total count of comment for this Commentable"
},
"email2": {
"type": "string",
"description": "User secondary email"
},
"email3": {
"type": "string",
"description": "User complementary email"
},
"primary_email_choice": {
"type": "string",
"enum": [
"email",
"email2",
"email3"
],
"description": "User primary email choice"
},
"firstname": {
"type": "string",
"description": "User first name"
},
"lastname": {
"type": "string",
"description": "User last name"
},
"maidenname": {
"type": "string",
"description": "User maiden name"
},
"prefix_firstname": {
"type": "string",
"description": "User prefix firstname"
},
"prefix_name": {
"type": "string",
"description": "User prefix name"
},
"suffix_name": {
"type": "string",
"description": "User suffix name"
},
"external_id": {
"type": "string",
"description": "User ID in your database"
},
"sso_identifier": {
"type": "string",
"description": "User identifier for SSO"
},
"previous_id": {
"type": "string",
"description": "User ID in your community system"
},
"last_visited_at": {
"type": "string",
"format": "date-time",
"description": "Date of last visit - iso8601. READ only, can't be updated"
},
"sign_in_count": {
"type": "string",
"description": "Number of platform visits. READ only, can't be updated"
},
"is_active": {
"type": "boolean",
"description": "User account enabled ?"
},
"gender": {
"type": "string",
"enum": [
"male",
"female",
"other"
],
"description": "User gender (male/female/other)"
},
"birthday": {
"type": "string",
"format": "date",
"description": "User birth date"
},
"birthplace": {
"type": "string",
"description": "User birth place"
},
"headline": {
"type": "string",
"description": "User headline"
},
"summary": {
"type": "string",
"description": "User summary"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "User creation date time - iso8601. READ only, can't be updated"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "User last update date time - iso8601. READ only, can't be updated"
},
"confirmed_at": {
"type": "string",
"format": "date-time",
"description": "User activation date time - iso8601. READ only, can't be updated"
},
"citizenship_ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": "List of citizenship IDs"
},
"citizenship_country_codes": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of ISO-3166-2 citizenship country codes"
},
"deceased": {
"type": "boolean",
"description": "User deceased ?"
},
"deceased_at": {
"type": "string",
"format": "date-time",
"description": "User decease date time - iso8601."
},
"photo": {
"type": "object",
"properties": {
"compressed-url": {
"type": "string",
"description": "User compressed photo url"
},
"large-url": {
"type": "string",
"description": "User large photo url"
},
"medium-url": {
"type": "string",
"description": "User medium photo url"
},
"thumb-url": {
"type": "string",
"description": "User thumb photo url"
},
"mini-url": {
"type": "string",
"description": "User mini photo url"
},
"friend-url": {
"type": "string",
"description": "User friend photo url"
},
"icon-url": {
"type": "string",
"description": "User icon photo url"
}
},
"description": "User photo urls"
},
"do_not_contact": {
"type": "boolean",
"description": "User can be contacted ?"
},
"mobile_perso": {
"type": "string",
"description": "User mobile perso number"
},
"mobile_pro": {
"type": "string",
"description": "User mobile pro number"
},
"landline_perso": {
"type": "string",
"description": "User landline perso number"
},
"landline_pro": {
"type": "string",
"description": "User landline pro number"
},
"preferred_phone_number": {
"type": "string",
"enum": [
"mobile_pro",
"mobile_perso",
"landline_pro",
"landline_perso",
"none"
],
"description": "User preferred phone number"
},
"postal_personal": {
"description": "User personal postal address",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"address_1": {
"type": "string",
"description": "Address line 1"
},
"address_2": {
"type": "string",
"description": "Address line 2"
},
"address_3": {
"type": "string",
"description": "Address line 3"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "State"
},
"full_name": {
"type": "string",
"description": "Full name"
},
"postal_code": {
"type": "string",
"description": "Zip code"
},
"country": {
"type": "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"
],
"description": "Country"
},
"default_billing_address": {
"type": "boolean",
"description": "is the default billing address for the user ?"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Postal address creation date time - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Postal address last update date time - iso8601"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "User ID linked to postal address"
}
}
},
"postal_work": {
"description": "User work postal address",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"address_1": {
"type": "string",
"description": "Address line 1"
},
"address_2": {
"type": "string",
"description": "Address line 2"
},
"address_3": {
"type": "string",
"description": "Address line 3"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "State"
},
"full_name": {
"type": "string",
"description": "Full name"
},
"postal_code": {
"type": "string",
"description": "Zip code"
},
"country": {
"type": "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"
],
"description": "Country"
},
"default_billing_address": {
"type": "boolean",
"description": "is the default billing address for the user ?"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Postal address creation date time - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Postal address last update date time - iso8601"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "User ID linked to postal address"
}
}
},
"preferred_postal_address": {
"type": "string",
"enum": [
"postal_personal",
"postal_work"
],
"description": "User preferred postal address"
},
"config": {
"description": "User specific configuration",
"type": "object",
"properties": {
"private_profile": {
"type": "boolean",
"description": "Unique ID"
},
"opt_out_of_directory": {
"type": "boolean",
"description": "Unique ID"
},
"opt_out_of_group_directories": {
"type": "array",
"items": {
"type": "object"
},
"description": "Unique ID"
},
"opt_out_of_messaging": {
"type": "boolean",
"description": "Opt out of messaging"
},
"share_gender": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of gender"
},
"share_prefix_firstname": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of prefix_firstname"
},
"share_honorary_title": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of honorary_title"
},
"share_prefix_name": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of prefix_name"
},
"share_suffix_name": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of suffix_name"
},
"share_maidenname": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of maidenname"
},
"share_birthday": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of birthday"
},
"share_birthplace": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of birthplace"
},
"share_headline": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of headline"
},
"share_live_location": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of live_location"
},
"share_sub_networks": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of sub_networks"
},
"share_nationalities": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of nationalities"
},
"share_resume": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of resume"
},
"share_summary": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of summary"
},
"share_industries": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of industries"
},
"share_skills": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of skills"
},
"share_facebook_profile_url": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of facebook_profile_url"
},
"share_instagram_profile_url": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of instagram_profile_url"
},
"share_twitter": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of twitter"
},
"share_skype": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of skype"
},
"share_linkedin_profile_url": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of linkedin_profile_url"
},
"share_website": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of website"
},
"share_bbm": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of bbm"
},
"share_email": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of email"
},
"share_email2": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of email2"
},
"share_email3": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of email3"
},
"share_mobile_perso": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of mobile_perso"
},
"share_landline_perso": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of landline_perso"
},
"share_mobile_pro": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of mobile_pro"
},
"share_landline_pro": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of landline_pro"
},
"share_postal_personal": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of postal_personal"
},
"share_postal_work": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of postal_work"
},
"share_memberships": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of memberships"
},
"share_educations": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of educations"
},
"share_experiences": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of experiences"
}
}
},
"role_id": {
"type": "integer",
"format": "int32",
"description": "User role ID"
},
"awards": {
"type": "string",
"description": "User awards"
},
"linkedin_profile_url": {
"type": "string",
"description": "User linkedin profile URL"
},
"website": {
"type": "string",
"description": "User Website URL"
},
"skype": {
"type": "string",
"description": "User skype profile"
},
"bbm": {
"type": "string",
"description": "User BlackBerry Messenger profile"
},
"twitter": {
"type": "string",
"description": "User twitter profile"
},
"timezone": {
"type": "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"
],
"description": "User timezone"
},
"facebook_profile_url": {
"type": "string",
"description": "User facebook profile URL"
},
"instagram_profile_url": {
"type": "string",
"description": "User instagram profile URL"
},
"honorary_title": {
"type": "string",
"enum": [
"mr",
"mrs",
"ms",
"dr",
"prof"
],
"description": "User's honorary title"
},
"live_location": {
"description": "User's current location.",
"type": "object",
"properties": {
"city": {
"type": "string",
"description": "City"
},
"country": {
"type": "string",
"description": "Country"
},
"country_code": {
"type": "string",
"description": "ISO3166-2 Country code"
},
"address": {
"type": "string",
"description": "Address"
},
"lat": {
"type": "number",
"format": "float",
"description": "Latitude"
},
"lng": {
"type": "number",
"format": "float",
"description": "Longitude"
}
}
},
"resume": {
"type": "string",
"description": "URL link to the user's resume. This link will be expired if you do not open it in the 60 sec after your request. Another request will be needed"
},
"locale": {
"type": "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"
],
"description": "User Locale"
},
"share_email": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding email"
},
"share_email2": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding secondary email"
},
"share_email3": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding complementary email"
},
"share_postal_address_personal": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding postal home location"
},
"share_postal_address_work": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding postal work location"
},
"share_nationalities": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding nationalities"
},
"share_resume": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding resume"
},
"share_mobile_pro": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding work mobile phone"
},
"share_mobile_perso": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding personal mobile phone"
},
"share_landline_pro": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding professional landline phone"
},
"share_landline_perso": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding personal landline phone"
},
"skills": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"name": {
"type": "string",
"description": "Skill name"
}
}
},
"description": "READ ONLY, list of user skills"
},
"custom_attributes": {
"type": "array",
"items": {
"type": "object"
},
"description": "Array of customizable attributes with name, value and type"
}
},
"description": "User model"
}
}
},
"description": "Users model"
}Validations Failed
Schema
{
"type": "object",
"properties": {
"status": {
"type": "integer",
"format": "int32",
"description": "Status Code"
},
"errors": {
"type": "string",
"description": "Errors list"
}
},
"description": "Error model"
}Bulk add usersPOST/api/admin/v1/users/_bulk
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
PUT /api/admin/v1/users/_bulk
Requests
Body
{
"key": "Hello, world!",
"users[][id]": [],
"users[][postal_personal][address_1]": [],
"users[][postal_personal][address_2]": [],
"users[][postal_personal][address_3]": [],
"users[][postal_personal][city]": [],
"users[][postal_personal][state]": [],
"users[][postal_personal][full_name]": [],
"users[][postal_personal][postal_code]": [],
"users[][postal_personal][country]": [],
"users[][postal_personal][default_billing_address]": [
true
],
"users[][postal_personal][created_at]": [],
"users[][postal_personal][updated_at]": [],
"users[][postal_work][address_1]": [],
"users[][postal_work][address_2]": [],
"users[][postal_work][address_3]": [],
"users[][postal_work][city]": [],
"users[][postal_work][state]": [],
"users[][postal_work][full_name]": [],
"users[][postal_work][postal_code]": [],
"users[][postal_work][country]": [],
"users[][postal_work][default_billing_address]": [
true
],
"users[][postal_work][created_at]": [],
"users[][postal_work][updated_at]": [],
"users[][live_location][city]": [],
"users[][live_location][country]": [],
"users[][live_location][country_code]": [],
"users[][live_location][address]": [],
"users[][live_location][lat]": [
1
],
"users[][live_location][lng]": [
1
],
"users[][config][private_profile]": [
true
],
"users[][config][opt_out_of_directory]": [
true
],
"users[][config][opt_out_of_group_directories][]": [],
"users[][config][opt_out_of_messaging]": [
true
],
"users[][config][share_gender]": [],
"users[][config][share_prefix_firstname]": [],
"users[][config][share_honorary_title]": [],
"users[][config][share_prefix_name]": [],
"users[][config][share_suffix_name]": [],
"users[][config][share_maidenname]": [],
"users[][config][share_birthday]": [],
"users[][config][share_birthplace]": [],
"users[][config][share_headline]": [],
"users[][config][share_live_location]": [],
"users[][config][share_sub_networks]": [],
"users[][config][share_nationalities]": [],
"users[][config][share_resume]": [],
"users[][config][share_summary]": [],
"users[][config][share_industries]": [],
"users[][config][share_skills]": [],
"users[][config][share_facebook_profile_url] (array) - Privacy sharing status of facebook_profile_url": "Hello, world!",
"users[][config][share_instagram_profile_url] (array) - Privacy sharing status of instagram_profile_url": "Hello, world!",
"users[][config][share_twitter]": [],
"users[][config][share_skype]": [],
"users[][config][share_linkedin_profile_url] (array) - Privacy sharing status of linkedin_profile_url": "Hello, world!",
"users[][config][share_website]": [],
"users[][config][share_bbm]": [],
"users[][config][share_email]": [],
"users[][config][share_email2]": [],
"users[][config][share_email3]": [],
"users[][config][share_mobile_perso]": [],
"users[][config][share_landline_perso]": [],
"users[][config][share_mobile_pro]": [],
"users[][config][share_landline_pro]": [],
"users[][config][share_postal_personal]": [],
"users[][config][share_postal_work]": [],
"users[][config][share_memberships]": [],
"users[][config][share_educations]": [],
"users[][config][share_experiences]": [],
"users[][email]": [],
"users[][sub_network_ids][]": [
1
],
"users[][extended_updated_at]": [],
"users[][likes_count]": [
1
],
"users[][comments_count]": [],
"users[][email2]": [],
"users[][email3]": [],
"users[][primary_email_choice]": [],
"users[][firstname]": [],
"users[][lastname]": [],
"users[][maidenname]": [],
"users[][prefix_firstname]": [],
"users[][prefix_name]": [],
"users[][suffix_name]": [],
"users[][external_id]": [],
"users[][sso_identifier]": [],
"users[][previous_id]": [],
"users[][last_visited_at]": [],
"users[][sign_in_count]": [],
"users[][is_active]": [
true
],
"users[][gender]": [],
"users[][birthday]": [],
"users[][birthplace]": [],
"users[][headline]": [],
"users[][summary]": [],
"users[][created_at]": [],
"users[][updated_at]": [],
"users[][citizenship_ids][]": [
1
],
"users[][citizenship_country_codes][]": [],
"users[][deceased]": [
true
],
"users[][deceased_at]": [],
"users[][do_not_contact]": [
true
],
"users[][mobile_perso]": [],
"users[][mobile_pro]": [],
"users[][landline_perso]": [],
"users[][landline_pro]": [],
"users[][preferred_phone_number]": [],
"users[][preferred_postal_address]": [],
"users[][role_id]": [
1
],
"users[][awards]": [],
"users[][linkedin_profile_url]": [],
"users[][website]": [],
"users[][skype]": [],
"users[][bbm]": [],
"users[][twitter]": [],
"users[][timezone]": [],
"users[][facebook_profile_url]": [],
"users[][instagram_profile_url]": [],
"users[][honorary_title]": [],
"users[][locale]": [],
"users[][share_email]": [],
"users[][share_email2]": [],
"users[][share_email3]": [],
"users[][share_postal_address_personal]": [],
"users[][share_postal_address_work]": [],
"users[][share_nationalities]": [],
"users[][share_resume]": [],
"users[][share_mobile_pro]": [],
"users[][share_mobile_perso]": [],
"users[][share_landline_pro]": [],
"users[][share_landline_perso]": [],
"users[][skills][]": [],
"users[][custom_attributes][]": [],
"users[][photo]": [],
"users[][resume]": []
}Schema
{
"type": "object",
"properties": {
"key": {
"type": "string"
},
"users[][id]": {
"type": "array",
"description": "User ID\n\n+"
},
"users[][postal_personal][address_1]": {
"type": "array",
"description": "Address line 1\n\n+"
},
"users[][postal_personal][address_2]": {
"type": "array",
"description": "Address line 2\n\n+"
},
"users[][postal_personal][address_3]": {
"type": "array",
"description": "Address line 3\n\n+"
},
"users[][postal_personal][city]": {
"type": "array",
"description": "City\n\n+"
},
"users[][postal_personal][state]": {
"type": "array",
"description": "State\n\n+"
},
"users[][postal_personal][full_name]": {
"type": "array",
"description": "Full name\n\n+"
},
"users[][postal_personal][postal_code]": {
"type": "array",
"description": "Zip code\n\n+"
},
"users[][postal_personal][country]": {
"type": "array",
"description": "Country\n\n+"
},
"users[][postal_personal][default_billing_address]": {
"type": "array",
"items": {
"type": "boolean"
},
"description": "is the default billing address for the user ?"
},
"users[][postal_personal][created_at]": {
"type": "array",
"description": "Postal address creation date time - iso8601\n\n+"
},
"users[][postal_personal][updated_at]": {
"type": "array",
"description": "Postal address last update date time - iso8601\n\n+"
},
"users[][postal_work][address_1]": {
"type": "array",
"description": "Address line 1\n\n+"
},
"users[][postal_work][address_2]": {
"type": "array",
"description": "Address line 2\n\n+"
},
"users[][postal_work][address_3]": {
"type": "array",
"description": "Address line 3\n\n+"
},
"users[][postal_work][city]": {
"type": "array",
"description": "City\n\n+"
},
"users[][postal_work][state]": {
"type": "array",
"description": "State\n\n+"
},
"users[][postal_work][full_name]": {
"type": "array",
"description": "Full name\n\n+"
},
"users[][postal_work][postal_code]": {
"type": "array",
"description": "Zip code\n\n+"
},
"users[][postal_work][country]": {
"type": "array",
"description": "Country\n\n+"
},
"users[][postal_work][default_billing_address]": {
"type": "array",
"items": {
"type": "boolean"
},
"description": "is the default billing address for the user ?"
},
"users[][postal_work][created_at]": {
"type": "array",
"description": "Postal address creation date time - iso8601\n\n+"
},
"users[][postal_work][updated_at]": {
"type": "array",
"description": "Postal address last update date time - iso8601\n\n+"
},
"users[][live_location][city]": {
"type": "array",
"description": "City\n\n+"
},
"users[][live_location][country]": {
"type": "array",
"description": "Country\n\n+"
},
"users[][live_location][country_code]": {
"type": "array",
"description": "ISO3166-2 Country code\n\n+"
},
"users[][live_location][address]": {
"type": "array",
"description": "Address\n\n+"
},
"users[][live_location][lat]": {
"type": "array",
"items": {
"type": "number"
},
"description": "Latitude"
},
"users[][live_location][lng]": {
"type": "array",
"items": {
"type": "number"
},
"description": "Longitude"
},
"users[][config][private_profile]": {
"type": "array",
"items": {
"type": "boolean"
},
"description": "Unique ID"
},
"users[][config][opt_out_of_directory]": {
"type": "array",
"items": {
"type": "boolean"
},
"description": "Unique ID"
},
"users[][config][opt_out_of_group_directories][]": {
"type": "array",
"description": "Unique ID\n\n+"
},
"users[][config][opt_out_of_messaging]": {
"type": "array",
"items": {
"type": "boolean"
},
"description": "Opt out of messaging"
},
"users[][config][share_gender]": {
"type": "array",
"description": "Privacy sharing status of gender\n\n+"
},
"users[][config][share_prefix_firstname]": {
"type": "array",
"description": "Privacy sharing status of prefix_firstname\n\n+"
},
"users[][config][share_honorary_title]": {
"type": "array",
"description": "Privacy sharing status of honorary_title\n\n+"
},
"users[][config][share_prefix_name]": {
"type": "array",
"description": "Privacy sharing status of prefix_name\n\n+"
},
"users[][config][share_suffix_name]": {
"type": "array",
"description": "Privacy sharing status of suffix_name\n\n+"
},
"users[][config][share_maidenname]": {
"type": "array",
"description": "Privacy sharing status of maidenname\n\n+"
},
"users[][config][share_birthday]": {
"type": "array",
"description": "Privacy sharing status of birthday\n\n+"
},
"users[][config][share_birthplace]": {
"type": "array",
"description": "Privacy sharing status of birthplace\n\n+"
},
"users[][config][share_headline]": {
"type": "array",
"description": "Privacy sharing status of headline\n\n+"
},
"users[][config][share_live_location]": {
"type": "array",
"description": "Privacy sharing status of live_location\n\n+"
},
"users[][config][share_sub_networks]": {
"type": "array",
"description": "Privacy sharing status of sub_networks\n\n+"
},
"users[][config][share_nationalities]": {
"type": "array",
"description": "Privacy sharing status of nationalities\n\n+"
},
"users[][config][share_resume]": {
"type": "array",
"description": "Privacy sharing status of resume\n\n+"
},
"users[][config][share_summary]": {
"type": "array",
"description": "Privacy sharing status of summary\n\n+"
},
"users[][config][share_industries]": {
"type": "array",
"description": "Privacy sharing status of industries\n\n+"
},
"users[][config][share_skills]": {
"type": "array",
"description": "Privacy sharing status of skills\n\n+"
},
"users[][config][share_facebook_profile_url] (array) - Privacy sharing status of facebook_profile_url": {
"type": "string",
"description": "+"
},
"users[][config][share_instagram_profile_url] (array) - Privacy sharing status of instagram_profile_url": {
"type": "string",
"description": "+"
},
"users[][config][share_twitter]": {
"type": "array",
"description": "Privacy sharing status of twitter\n\n+"
},
"users[][config][share_skype]": {
"type": "array",
"description": "Privacy sharing status of skype\n\n+"
},
"users[][config][share_linkedin_profile_url] (array) - Privacy sharing status of linkedin_profile_url": {
"type": "string",
"description": "+"
},
"users[][config][share_website]": {
"type": "array",
"description": "Privacy sharing status of website\n\n+"
},
"users[][config][share_bbm]": {
"type": "array",
"description": "Privacy sharing status of bbm\n\n+"
},
"users[][config][share_email]": {
"type": "array",
"description": "Privacy sharing status of email\n\n+"
},
"users[][config][share_email2]": {
"type": "array",
"description": "Privacy sharing status of email2\n\n+"
},
"users[][config][share_email3]": {
"type": "array",
"description": "Privacy sharing status of email3\n\n+"
},
"users[][config][share_mobile_perso]": {
"type": "array",
"description": "Privacy sharing status of mobile_perso\n\n+"
},
"users[][config][share_landline_perso]": {
"type": "array",
"description": "Privacy sharing status of landline_perso\n\n+"
},
"users[][config][share_mobile_pro]": {
"type": "array",
"description": "Privacy sharing status of mobile_pro\n\n+"
},
"users[][config][share_landline_pro]": {
"type": "array",
"description": "Privacy sharing status of landline_pro\n\n+"
},
"users[][config][share_postal_personal]": {
"type": "array",
"description": "Privacy sharing status of postal_personal\n\n+"
},
"users[][config][share_postal_work]": {
"type": "array",
"description": "Privacy sharing status of postal_work\n\n+"
},
"users[][config][share_memberships]": {
"type": "array",
"description": "Privacy sharing status of memberships\n\n+"
},
"users[][config][share_educations]": {
"type": "array",
"description": "Privacy sharing status of educations\n\n+"
},
"users[][config][share_experiences]": {
"type": "array",
"description": "Privacy sharing status of experiences\n\n+"
},
"users[][email]": {
"type": "array",
"description": "User email\n\n+"
},
"users[][sub_network_ids][]": {
"type": "array",
"items": {
"type": "number"
},
"description": "IDs list of user sub networks"
},
"users[][extended_updated_at]": {
"type": "array",
"description": "User full profile ( with experiences, educations, customs) last update date time - iso8601\n\n+"
},
"users[][likes_count]": {
"type": "array",
"items": {
"type": "number"
},
"description": "Total count of likes on this Likeable"
},
"users[][comments_count]": {
"type": "array",
"description": "Total count of comment for this Commentable\n\n+"
},
"users[][email2]": {
"type": "array",
"description": "User secondary email\n\n+"
},
"users[][email3]": {
"type": "array",
"description": "User complementary email\n\n+"
},
"users[][primary_email_choice]": {
"type": "array",
"description": "User primary email choice\n\n+"
},
"users[][firstname]": {
"type": "array",
"description": "User first name\n\n+"
},
"users[][lastname]": {
"type": "array",
"description": "User last name\n\n+"
},
"users[][maidenname]": {
"type": "array",
"description": "User maiden name\n\n+"
},
"users[][prefix_firstname]": {
"type": "array",
"description": "User prefix firstname\n\n+"
},
"users[][prefix_name]": {
"type": "array",
"description": "User prefix name\n\n+"
},
"users[][suffix_name]": {
"type": "array",
"description": "User suffix name\n\n+"
},
"users[][external_id]": {
"type": "array",
"description": "User ID in your database\n\n+"
},
"users[][sso_identifier]": {
"type": "array",
"description": "User identifier for SSO\n\n+"
},
"users[][previous_id]": {
"type": "array",
"description": "User ID in your community system\n\n+"
},
"users[][last_visited_at]": {
"type": "array",
"description": "Date of last visit - iso8601. READ only, can't be updated\n\n+"
},
"users[][sign_in_count]": {
"type": "array",
"description": "Number of platform visits. READ only, can't be updated\n\n+"
},
"users[][is_active]": {
"type": "array",
"items": {
"type": "boolean"
},
"description": "User account enabled ?"
},
"users[][gender]": {
"type": "array",
"description": "User gender (male/female/other)\n\n+"
},
"users[][birthday]": {
"type": "array",
"description": "User birth date\n\n+"
},
"users[][birthplace]": {
"type": "array",
"description": "User birth place\n\n+"
},
"users[][headline]": {
"type": "array",
"description": "User headline\n\n+"
},
"users[][summary]": {
"type": "array",
"description": "User summary\n\n+"
},
"users[][created_at]": {
"type": "array",
"description": "User creation date time - iso8601. READ only, can't be updated\n\n+"
},
"users[][updated_at]": {
"type": "array",
"description": "User last update date time - iso8601. READ only, can't be updated\n\n+"
},
"users[][citizenship_ids][]": {
"type": "array",
"items": {
"type": "number"
},
"description": "List of citizenship IDs"
},
"users[][citizenship_country_codes][]": {
"type": "array",
"description": "List of ISO-3166-2 citizenship country codes\n\n+"
},
"users[][deceased]": {
"type": "array",
"items": {
"type": "boolean"
},
"description": "User deceased ?"
},
"users[][deceased_at]": {
"type": "array",
"description": "User decease date time - iso8601.\n\n+"
},
"users[][do_not_contact]": {
"type": "array",
"items": {
"type": "boolean"
},
"description": "User can be contacted ?"
},
"users[][mobile_perso]": {
"type": "array",
"description": "User mobile perso number\n\n+"
},
"users[][mobile_pro]": {
"type": "array",
"description": "User mobile pro number\n\n+"
},
"users[][landline_perso]": {
"type": "array",
"description": "User landline perso number\n\n+"
},
"users[][landline_pro]": {
"type": "array",
"description": "User landline pro number\n\n+"
},
"users[][preferred_phone_number]": {
"type": "array",
"description": "User preferred phone number\n\n+"
},
"users[][preferred_postal_address]": {
"type": "array",
"description": "User preferred postal address\n\n+"
},
"users[][role_id]": {
"type": "array",
"items": {
"type": "number"
},
"description": "User role ID"
},
"users[][awards]": {
"type": "array",
"description": "User awards\n\n+"
},
"users[][linkedin_profile_url]": {
"type": "array",
"description": "User linkedin profile URL\n\n+"
},
"users[][website]": {
"type": "array",
"description": "User Website URL\n\n+"
},
"users[][skype]": {
"type": "array",
"description": "User skype profile\n\n+"
},
"users[][bbm]": {
"type": "array",
"description": "User BlackBerry Messenger profile\n\n+"
},
"users[][twitter]": {
"type": "array",
"description": "User twitter profile\n\n+"
},
"users[][timezone]": {
"type": "array",
"description": "User timezone\n\n+"
},
"users[][facebook_profile_url]": {
"type": "array",
"description": "User facebook profile URL\n\n+"
},
"users[][instagram_profile_url]": {
"type": "array",
"description": "User instagram profile URL\n\n+"
},
"users[][honorary_title]": {
"type": "array",
"description": "User's honorary title\n\n+"
},
"users[][locale]": {
"type": "array",
"description": "User Locale\n\n+"
},
"users[][share_email]": {
"type": "array",
"description": "User's visibility information regarding email\n\n+"
},
"users[][share_email2]": {
"type": "array",
"description": "User's visibility information regarding secondary email\n\n+"
},
"users[][share_email3]": {
"type": "array",
"description": "User's visibility information regarding complementary email\n\n+"
},
"users[][share_postal_address_personal]": {
"type": "array",
"description": "User's visibility information regarding postal home location\n\n+"
},
"users[][share_postal_address_work]": {
"type": "array",
"description": "User's visibility information regarding postal work location\n\n+"
},
"users[][share_nationalities]": {
"type": "array",
"description": "User's visibility information regarding nationalities\n\n+"
},
"users[][share_resume]": {
"type": "array",
"description": "User's visibility information regarding resume\n\n+"
},
"users[][share_mobile_pro]": {
"type": "array",
"description": "User's visibility information regarding work mobile phone\n\n+"
},
"users[][share_mobile_perso]": {
"type": "array",
"description": "User's visibility information regarding personal mobile phone\n\n+"
},
"users[][share_landline_pro]": {
"type": "array",
"description": "User's visibility information regarding professional landline phone\n\n+"
},
"users[][share_landline_perso]": {
"type": "array",
"description": "User's visibility information regarding personal landline phone\n\n+"
},
"users[][skills][]": {
"type": "array",
"description": "READ ONLY, list of user skills\n\n+"
},
"users[][custom_attributes][]": {
"type": "array",
"description": "Array of customizable attributes with name, value and type\n\n+"
},
"users[][photo]": {
"type": "array",
"description": "Profile picture of the user\n\n+"
},
"users[][resume]": {
"type": "array",
"description": "Resume of the user\n\n+"
}
},
"required": [
"users[][id]"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Bulk update of existing users
Schema
{
"type": "object",
"properties": {
"users": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"email": {
"type": "string",
"description": "User email"
},
"name": {
"type": "string",
"description": "User full name"
},
"sub_network_ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": "IDs list of user sub networks"
},
"extended_updated_at": {
"type": "string",
"format": "date-time",
"description": "User full profile ( with experiences, educations, customs) last update date time - iso8601"
},
"likeable_type": {
"type": "string",
"description": "Type to use on API query"
},
"current_user_like_id": {
"type": "integer",
"format": "int32",
"description": "Like ID of the current_user if they like the Likeable"
},
"likes_count": {
"type": "integer",
"format": "int32",
"description": "Total count of likes on this Likeable"
},
"commentable_type": {
"type": "string",
"description": "Type to use on API query"
},
"comments_count": {
"type": "string",
"description": "Total count of comment for this Commentable"
},
"email2": {
"type": "string",
"description": "User secondary email"
},
"email3": {
"type": "string",
"description": "User complementary email"
},
"primary_email_choice": {
"type": "string",
"enum": [
"email",
"email2",
"email3"
],
"description": "User primary email choice"
},
"firstname": {
"type": "string",
"description": "User first name"
},
"lastname": {
"type": "string",
"description": "User last name"
},
"maidenname": {
"type": "string",
"description": "User maiden name"
},
"prefix_firstname": {
"type": "string",
"description": "User prefix firstname"
},
"prefix_name": {
"type": "string",
"description": "User prefix name"
},
"suffix_name": {
"type": "string",
"description": "User suffix name"
},
"external_id": {
"type": "string",
"description": "User ID in your database"
},
"sso_identifier": {
"type": "string",
"description": "User identifier for SSO"
},
"previous_id": {
"type": "string",
"description": "User ID in your community system"
},
"last_visited_at": {
"type": "string",
"format": "date-time",
"description": "Date of last visit - iso8601. READ only, can't be updated"
},
"sign_in_count": {
"type": "string",
"description": "Number of platform visits. READ only, can't be updated"
},
"is_active": {
"type": "boolean",
"description": "User account enabled ?"
},
"gender": {
"type": "string",
"enum": [
"male",
"female",
"other"
],
"description": "User gender (male/female/other)"
},
"birthday": {
"type": "string",
"format": "date",
"description": "User birth date"
},
"birthplace": {
"type": "string",
"description": "User birth place"
},
"headline": {
"type": "string",
"description": "User headline"
},
"summary": {
"type": "string",
"description": "User summary"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "User creation date time - iso8601. READ only, can't be updated"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "User last update date time - iso8601. READ only, can't be updated"
},
"confirmed_at": {
"type": "string",
"format": "date-time",
"description": "User activation date time - iso8601. READ only, can't be updated"
},
"citizenship_ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": "List of citizenship IDs"
},
"citizenship_country_codes": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of ISO-3166-2 citizenship country codes"
},
"deceased": {
"type": "boolean",
"description": "User deceased ?"
},
"deceased_at": {
"type": "string",
"format": "date-time",
"description": "User decease date time - iso8601."
},
"photo": {
"type": "object",
"properties": {
"compressed-url": {
"type": "string",
"description": "User compressed photo url"
},
"large-url": {
"type": "string",
"description": "User large photo url"
},
"medium-url": {
"type": "string",
"description": "User medium photo url"
},
"thumb-url": {
"type": "string",
"description": "User thumb photo url"
},
"mini-url": {
"type": "string",
"description": "User mini photo url"
},
"friend-url": {
"type": "string",
"description": "User friend photo url"
},
"icon-url": {
"type": "string",
"description": "User icon photo url"
}
},
"description": "User photo urls"
},
"do_not_contact": {
"type": "boolean",
"description": "User can be contacted ?"
},
"mobile_perso": {
"type": "string",
"description": "User mobile perso number"
},
"mobile_pro": {
"type": "string",
"description": "User mobile pro number"
},
"landline_perso": {
"type": "string",
"description": "User landline perso number"
},
"landline_pro": {
"type": "string",
"description": "User landline pro number"
},
"preferred_phone_number": {
"type": "string",
"enum": [
"mobile_pro",
"mobile_perso",
"landline_pro",
"landline_perso",
"none"
],
"description": "User preferred phone number"
},
"postal_personal": {
"description": "User personal postal address",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"address_1": {
"type": "string",
"description": "Address line 1"
},
"address_2": {
"type": "string",
"description": "Address line 2"
},
"address_3": {
"type": "string",
"description": "Address line 3"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "State"
},
"full_name": {
"type": "string",
"description": "Full name"
},
"postal_code": {
"type": "string",
"description": "Zip code"
},
"country": {
"type": "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"
],
"description": "Country"
},
"default_billing_address": {
"type": "boolean",
"description": "is the default billing address for the user ?"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Postal address creation date time - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Postal address last update date time - iso8601"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "User ID linked to postal address"
}
}
},
"postal_work": {
"description": "User work postal address",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"address_1": {
"type": "string",
"description": "Address line 1"
},
"address_2": {
"type": "string",
"description": "Address line 2"
},
"address_3": {
"type": "string",
"description": "Address line 3"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "State"
},
"full_name": {
"type": "string",
"description": "Full name"
},
"postal_code": {
"type": "string",
"description": "Zip code"
},
"country": {
"type": "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"
],
"description": "Country"
},
"default_billing_address": {
"type": "boolean",
"description": "is the default billing address for the user ?"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Postal address creation date time - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Postal address last update date time - iso8601"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "User ID linked to postal address"
}
}
},
"preferred_postal_address": {
"type": "string",
"enum": [
"postal_personal",
"postal_work"
],
"description": "User preferred postal address"
},
"config": {
"description": "User specific configuration",
"type": "object",
"properties": {
"private_profile": {
"type": "boolean",
"description": "Unique ID"
},
"opt_out_of_directory": {
"type": "boolean",
"description": "Unique ID"
},
"opt_out_of_group_directories": {
"type": "array",
"items": {
"type": "object"
},
"description": "Unique ID"
},
"opt_out_of_messaging": {
"type": "boolean",
"description": "Opt out of messaging"
},
"share_gender": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of gender"
},
"share_prefix_firstname": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of prefix_firstname"
},
"share_honorary_title": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of honorary_title"
},
"share_prefix_name": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of prefix_name"
},
"share_suffix_name": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of suffix_name"
},
"share_maidenname": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of maidenname"
},
"share_birthday": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of birthday"
},
"share_birthplace": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of birthplace"
},
"share_headline": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of headline"
},
"share_live_location": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of live_location"
},
"share_sub_networks": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of sub_networks"
},
"share_nationalities": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of nationalities"
},
"share_resume": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of resume"
},
"share_summary": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of summary"
},
"share_industries": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of industries"
},
"share_skills": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of skills"
},
"share_facebook_profile_url": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of facebook_profile_url"
},
"share_instagram_profile_url": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of instagram_profile_url"
},
"share_twitter": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of twitter"
},
"share_skype": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of skype"
},
"share_linkedin_profile_url": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of linkedin_profile_url"
},
"share_website": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of website"
},
"share_bbm": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of bbm"
},
"share_email": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of email"
},
"share_email2": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of email2"
},
"share_email3": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of email3"
},
"share_mobile_perso": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of mobile_perso"
},
"share_landline_perso": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of landline_perso"
},
"share_mobile_pro": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of mobile_pro"
},
"share_landline_pro": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of landline_pro"
},
"share_postal_personal": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of postal_personal"
},
"share_postal_work": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of postal_work"
},
"share_memberships": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of memberships"
},
"share_educations": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of educations"
},
"share_experiences": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of experiences"
}
}
},
"role_id": {
"type": "integer",
"format": "int32",
"description": "User role ID"
},
"awards": {
"type": "string",
"description": "User awards"
},
"linkedin_profile_url": {
"type": "string",
"description": "User linkedin profile URL"
},
"website": {
"type": "string",
"description": "User Website URL"
},
"skype": {
"type": "string",
"description": "User skype profile"
},
"bbm": {
"type": "string",
"description": "User BlackBerry Messenger profile"
},
"twitter": {
"type": "string",
"description": "User twitter profile"
},
"timezone": {
"type": "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"
],
"description": "User timezone"
},
"facebook_profile_url": {
"type": "string",
"description": "User facebook profile URL"
},
"instagram_profile_url": {
"type": "string",
"description": "User instagram profile URL"
},
"honorary_title": {
"type": "string",
"enum": [
"mr",
"mrs",
"ms",
"dr",
"prof"
],
"description": "User's honorary title"
},
"live_location": {
"description": "User's current location.",
"type": "object",
"properties": {
"city": {
"type": "string",
"description": "City"
},
"country": {
"type": "string",
"description": "Country"
},
"country_code": {
"type": "string",
"description": "ISO3166-2 Country code"
},
"address": {
"type": "string",
"description": "Address"
},
"lat": {
"type": "number",
"format": "float",
"description": "Latitude"
},
"lng": {
"type": "number",
"format": "float",
"description": "Longitude"
}
}
},
"resume": {
"type": "string",
"description": "URL link to the user's resume. This link will be expired if you do not open it in the 60 sec after your request. Another request will be needed"
},
"locale": {
"type": "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"
],
"description": "User Locale"
},
"share_email": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding email"
},
"share_email2": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding secondary email"
},
"share_email3": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding complementary email"
},
"share_postal_address_personal": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding postal home location"
},
"share_postal_address_work": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding postal work location"
},
"share_nationalities": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding nationalities"
},
"share_resume": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding resume"
},
"share_mobile_pro": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding work mobile phone"
},
"share_mobile_perso": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding personal mobile phone"
},
"share_landline_pro": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding professional landline phone"
},
"share_landline_perso": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding personal landline phone"
},
"skills": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"name": {
"type": "string",
"description": "Skill name"
}
}
},
"description": "READ ONLY, list of user skills"
},
"custom_attributes": {
"type": "array",
"items": {
"type": "object"
},
"description": "Array of customizable attributes with name, value and type"
}
},
"description": "User model"
}
}
},
"description": "Users model"
}Validations Failed
Schema
{
"type": "object",
"properties": {
"status": {
"type": "integer",
"format": "int32",
"description": "Status Code"
},
"errors": {
"type": "string",
"description": "Errors list"
}
},
"description": "Error model"
}Bulk update of existing usersPUT/api/admin/v1/users/_bulk
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
POST /api/admin/v1/users/id/notify
Requests
Body
{
"key": "Hello, world!",
"recipient_type": "Hello, world!"
}Schema
{
"type": "object",
"properties": {
"key": {
"type": "string"
},
"recipient_type": {
"type": "string"
}
},
"required": [
"recipient_type"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Notify User
Notify UserPOST/api/admin/v1/users/{id}/notify
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
URI Parameters
- id
string(required)
DELETE /api/admin/v2/users/id
Responses
Delete a User
Delete a UserDELETE/api/admin/v2/users/{id}
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.
URI Parameters
- id
string(required)- key
string(required)
POST /api/admin/v2/users/customizable_attributes/create
Requests
Body
{
"customizable_attribute[type]": "Hello, world!",
"customizable_attribute[display_name]": "Hello, world!",
"customizable_attribute[text_size]": 1,
"customizable_attribute[tooltip]": "Hello, world!",
"customizable_attribute[placeholder]": "Hello, world!",
"customizable_attribute[multi]": true,
"customizable_attribute[visibility]": "Hello, world!",
"customizable_attribute[user_editable]": true,
"customizable_attribute[required]": true,
"customizable_attribute[options][]": [],
"customizable_attribute[selected_value]": "Hello, world!"
}Schema
{
"type": "object",
"properties": {
"customizable_attribute[type]": {
"type": "string"
},
"customizable_attribute[display_name]": {
"type": "string",
"description": "Customizable Attribute displayed name"
},
"customizable_attribute[text_size]": {
"type": "number"
},
"customizable_attribute[tooltip]": {
"type": "string",
"description": "Customizable Attribute tooltip"
},
"customizable_attribute[placeholder]": {
"type": "string",
"description": "Customizable Attribute placeholder"
},
"customizable_attribute[multi]": {
"type": "boolean",
"description": "Customizable Attribute multi activated ?"
},
"customizable_attribute[visibility]": {
"type": "string",
"description": "Customizable Attribute visibility"
},
"customizable_attribute[user_editable]": {
"type": "boolean",
"description": "Customizable Attribute editable by the user ?"
},
"customizable_attribute[required]": {
"type": "boolean",
"description": "Customizable Attribute required ?"
},
"customizable_attribute[options][]": {
"type": "array",
"description": "Customizable Attribute array of options\n\n+"
},
"customizable_attribute[selected_value]": {
"type": "string",
"description": "Customizable Attribute selected value"
}
},
"required": [
"customizable_attribute[type]"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Customizable Attribute Creation
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"customizable_id": {
"type": "integer",
"format": "int32",
"description": "Customizable ID"
},
"type": {
"type": "string",
"enum": [
"CustomizableAttribute::Boolean",
"CustomizableAttribute::Date",
"CustomizableAttribute::DoubleSelect",
"CustomizableAttribute::Number",
"CustomizableAttribute::Select",
"CustomizableAttribute::Text"
],
"description": "Customizable Attribute type"
},
"customizable_type": {
"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",
"mentorships",
"mentorships_mentee",
"mentorships_mentor",
"ne_event",
"ne_ticket",
"topic_approval",
"topic_mentorships",
"topic_mentorships_mentee",
"topic_mentorships_mentor",
"user",
"ventures_venture"
],
"description": "Customizable Attribute associated model (User, Experience)"
},
"name": {
"type": "string",
"description": "Customizable Attribute name"
},
"display_name": {
"type": "string",
"description": "Customizable Attribute displayed name"
},
"tooltip": {
"type": "string",
"description": "Customizable Attribute tooltip"
},
"placeholder": {
"type": "string",
"description": "Customizable Attribute placeholder"
},
"multi": {
"type": "boolean",
"description": "Customizable Attribute multi activated ?"
},
"text_size": {
"type": "integer",
"format": "int32",
"description": "Customizable Attribute text_size"
},
"visibility": {
"type": "string",
"enum": [
"admin_only",
"tagged_user",
"everybody",
"not_visible"
],
"description": "Customizable Attribute visibility"
},
"user_editable": {
"type": "boolean",
"description": "Customizable Attribute editable by the user ?"
},
"required": {
"type": "boolean",
"description": "Customizable Attribute required ?"
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "Customizable Attribute array of options"
},
"json_options": {
"type": "object",
"description": "Customizable Attribute json options (for double select)"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Customizable Attribute creation date"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Customizable Attribute last update date"
},
"selected_value": {
"type": "string",
"description": "Customizable Attribute selected value"
}
},
"description": "CustomizableAttribute model"
}Customizable Attribute CreationPOST/api/admin/v2/users/customizable_attributes/create
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"
]
}
}
}PUT /api/admin/v2/users/customizable_attributes/update
Requests
Body
{
"id": 1,
"customizable_attribute[display_name]": "Hello, world!",
"customizable_attribute[tooltip]": "Hello, world!",
"customizable_attribute[placeholder]": "Hello, world!",
"customizable_attribute[multi]": true,
"customizable_attribute[visibility]": "Hello, world!",
"customizable_attribute[user_editable]": true,
"customizable_attribute[required]": true,
"customizable_attribute[options][]": [],
"customizable_attribute[selected_value]": "Hello, world!"
}Schema
{
"type": "object",
"properties": {
"id": {
"type": "number"
},
"customizable_attribute[display_name]": {
"type": "string",
"description": "Customizable Attribute displayed name"
},
"customizable_attribute[tooltip]": {
"type": "string",
"description": "Customizable Attribute tooltip"
},
"customizable_attribute[placeholder]": {
"type": "string",
"description": "Customizable Attribute placeholder"
},
"customizable_attribute[multi]": {
"type": "boolean",
"description": "Customizable Attribute multi activated ?"
},
"customizable_attribute[visibility]": {
"type": "string",
"description": "Customizable Attribute visibility"
},
"customizable_attribute[user_editable]": {
"type": "boolean",
"description": "Customizable Attribute editable by the user ?"
},
"customizable_attribute[required]": {
"type": "boolean",
"description": "Customizable Attribute required ?"
},
"customizable_attribute[options][]": {
"type": "array",
"description": "Customizable Attribute array of options\n\n+"
},
"customizable_attribute[selected_value]": {
"type": "string",
"description": "Customizable Attribute selected value"
}
},
"required": [
"id"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Customizable Attribute Update
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"customizable_id": {
"type": "integer",
"format": "int32",
"description": "Customizable ID"
},
"type": {
"type": "string",
"enum": [
"CustomizableAttribute::Boolean",
"CustomizableAttribute::Date",
"CustomizableAttribute::DoubleSelect",
"CustomizableAttribute::Number",
"CustomizableAttribute::Select",
"CustomizableAttribute::Text"
],
"description": "Customizable Attribute type"
},
"customizable_type": {
"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",
"mentorships",
"mentorships_mentee",
"mentorships_mentor",
"ne_event",
"ne_ticket",
"topic_approval",
"topic_mentorships",
"topic_mentorships_mentee",
"topic_mentorships_mentor",
"user",
"ventures_venture"
],
"description": "Customizable Attribute associated model (User, Experience)"
},
"name": {
"type": "string",
"description": "Customizable Attribute name"
},
"display_name": {
"type": "string",
"description": "Customizable Attribute displayed name"
},
"tooltip": {
"type": "string",
"description": "Customizable Attribute tooltip"
},
"placeholder": {
"type": "string",
"description": "Customizable Attribute placeholder"
},
"multi": {
"type": "boolean",
"description": "Customizable Attribute multi activated ?"
},
"text_size": {
"type": "integer",
"format": "int32",
"description": "Customizable Attribute text_size"
},
"visibility": {
"type": "string",
"enum": [
"admin_only",
"tagged_user",
"everybody",
"not_visible"
],
"description": "Customizable Attribute visibility"
},
"user_editable": {
"type": "boolean",
"description": "Customizable Attribute editable by the user ?"
},
"required": {
"type": "boolean",
"description": "Customizable Attribute required ?"
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "Customizable Attribute array of options"
},
"json_options": {
"type": "object",
"description": "Customizable Attribute json options (for double select)"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Customizable Attribute creation date"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Customizable Attribute last update date"
},
"selected_value": {
"type": "string",
"description": "Customizable Attribute selected value"
}
},
"description": "CustomizableAttribute model"
}Customizable Attribute UpdatePUT/api/admin/v2/users/customizable_attributes/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"
]
}
}
}DELETE /api/admin/v2/users/customizable_attributes/destroy
Responses
Customizable Attribute Deletion
Customizable Attribute DeletionDELETE/api/admin/v2/users/customizable_attributes/destroy
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.
URI Parameters
- id
number(required)
experiences ¶
Operations about experiences
GET /api/admin/v1/experiences
Responses
Get all experiences
Schema
{
"type": "object",
"properties": {
"experiences": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"position": {
"type": "string",
"description": "Experience position"
},
"from": {
"type": "string",
"format": "date",
"description": "Experience started at"
},
"to": {
"type": "string",
"format": "date",
"description": "Experience ended at"
},
"custom_attributes": {
"type": "array",
"items": {
"type": "object"
},
"description": "Array of customizable attributes with name, value and type"
},
"external_id": {
"type": "string",
"description": "Experience ID in your database"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Experience creation date"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Experience last update date time - iso8601"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "User linked to experience"
},
"industry": {
"description": "Industry linked to Experience",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"name": {
"type": "string",
"description": "Industry name"
}
}
},
"job_function": {
"description": "Job Function linked to Experience",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"identifier": {
"type": "string",
"description": "Job function name"
}
}
},
"company": {
"description": "Company linked to Experience",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"name": {
"type": "string",
"description": "Company full name"
}
}
},
"extended_updated_at": {
"type": "string",
"format": "date-time",
"description": "Experience (including custom attributes) last update date time - iso8601"
}
},
"description": "Experience model"
}
}
},
"description": "ExperiencesFull model"
}Get all experiencesGET/api/admin/v1/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"
}URI Parameters
- order
string(required)- updated_since
string(required)- page
string(required)Page of results to fetch.
- per_page
string(required)Number of results to return per page.
GET /api/admin/v1/experiences/id?experience_key=
Responses
Get user experience
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"position": {
"type": "string",
"description": "Experience position"
},
"from": {
"type": "string",
"format": "date",
"description": "Experience started at"
},
"to": {
"type": "string",
"format": "date",
"description": "Experience ended at"
},
"custom_attributes": {
"type": "array",
"items": {
"type": "object"
},
"description": "Array of customizable attributes with name, value and type"
},
"external_id": {
"type": "string",
"description": "Experience ID in your database"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Experience creation date"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Experience last update date time - iso8601"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "User linked to experience"
},
"industry": {
"description": "Industry linked to Experience",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"name": {
"type": "string",
"description": "Industry name"
}
}
},
"job_function": {
"description": "Job Function linked to Experience",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"identifier": {
"type": "string",
"description": "Job function name"
}
}
},
"company": {
"description": "Company linked to Experience",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"name": {
"type": "string",
"description": "Company full name"
}
}
},
"extended_updated_at": {
"type": "string",
"format": "date-time",
"description": "Experience (including custom attributes) last update date time - iso8601"
}
},
"description": "Experience model"
}Get user experienceGET/api/admin/v1/experiences/{id}{?experience_key}
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.
URI Parameters
- id
number(required)- experience_key
string(required)
PUT /api/admin/v1/experiences/id
Requests
Body
{
"experience_key": "Hello, world!",
"experience[companies_company_key]": "Hello, world!",
"experience[position]": "Hello, world!",
"experience[from]": "Hello, world!",
"experience[to]": "Hello, world!",
"experience[companies_company_id]": "Hello, world!",
"experience[custom_attributes][]": [],
"experience[industry_id]": 1,
"experience[job_function_id]": 1,
"experience[external_id]": "Hello, world!"
}Schema
{
"type": "object",
"properties": {
"experience_key": {
"type": "string"
},
"experience[companies_company_key]": {
"type": "string"
},
"experience[position]": {
"type": "string",
"description": "Experience position"
},
"experience[from]": {
"type": "string",
"description": "Experience started at"
},
"experience[to]": {
"type": "string",
"description": "Experience ended at"
},
"experience[companies_company_id]": {
"type": "string",
"description": "ID of company linked"
},
"experience[custom_attributes][]": {
"type": "array",
"description": "Array of customizable attributes with name, value and type\n\n+"
},
"experience[industry_id]": {
"type": "number",
"description": "Industry ID matching the experience"
},
"experience[job_function_id]": {
"type": "number",
"description": "Job Function ID matching the experience"
},
"experience[external_id]": {
"type": "string",
"description": "Experience ID in your database"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Update existing user experience
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"position": {
"type": "string",
"description": "Experience position"
},
"from": {
"type": "string",
"format": "date",
"description": "Experience started at"
},
"to": {
"type": "string",
"format": "date",
"description": "Experience ended at"
},
"custom_attributes": {
"type": "array",
"items": {
"type": "object"
},
"description": "Array of customizable attributes with name, value and type"
},
"external_id": {
"type": "string",
"description": "Experience ID in your database"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Experience creation date"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Experience last update date time - iso8601"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "User linked to experience"
},
"industry": {
"description": "Industry linked to Experience",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"name": {
"type": "string",
"description": "Industry name"
}
}
},
"job_function": {
"description": "Job Function linked to Experience",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"identifier": {
"type": "string",
"description": "Job function name"
}
}
},
"company": {
"description": "Company linked to Experience",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"name": {
"type": "string",
"description": "Company full name"
}
}
},
"extended_updated_at": {
"type": "string",
"format": "date-time",
"description": "Experience (including custom attributes) last update date time - iso8601"
}
},
"description": "Experience model"
}Validations Failed
Schema
{
"type": "object",
"properties": {
"status": {
"type": "integer",
"format": "int32",
"description": "Status Code"
},
"errors": {
"type": "string",
"description": "Errors list"
}
},
"description": "Error model"
}Update existing user experiencePUT/api/admin/v1/experiences/{id}
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.
URI Parameters
- id
string(required)Experience ID
DELETE /api/admin/v1/experiences/id?experience_key=
Responses
Delete User experience
Delete User experienceDELETE/api/admin/v1/experiences/{id}{?experience_key}
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.
URI Parameters
- id
string(required)- experience_key
string(required)
POST /api/admin/v2/experiences/customizable_attributes/create
Requests
Body
{
"customizable_attribute[type]": "Hello, world!",
"customizable_attribute[display_name]": "Hello, world!",
"customizable_attribute[text_size]": 1,
"customizable_attribute[tooltip]": "Hello, world!",
"customizable_attribute[placeholder]": "Hello, world!",
"customizable_attribute[multi]": true,
"customizable_attribute[visibility]": "Hello, world!",
"customizable_attribute[user_editable]": true,
"customizable_attribute[required]": true,
"customizable_attribute[options][]": [],
"customizable_attribute[selected_value]": "Hello, world!"
}Schema
{
"type": "object",
"properties": {
"customizable_attribute[type]": {
"type": "string"
},
"customizable_attribute[display_name]": {
"type": "string",
"description": "Customizable Attribute displayed name"
},
"customizable_attribute[text_size]": {
"type": "number",
"description": "Customizable Attribute text_size"
},
"customizable_attribute[tooltip]": {
"type": "string",
"description": "Customizable Attribute tooltip"
},
"customizable_attribute[placeholder]": {
"type": "string",
"description": "Customizable Attribute placeholder"
},
"customizable_attribute[multi]": {
"type": "boolean",
"description": "Customizable Attribute multi activated ?"
},
"customizable_attribute[visibility]": {
"type": "string",
"description": "Customizable Attribute visibility"
},
"customizable_attribute[user_editable]": {
"type": "boolean",
"description": "Customizable Attribute editable by the user ?"
},
"customizable_attribute[required]": {
"type": "boolean",
"description": "Customizable Attribute required ?"
},
"customizable_attribute[options][]": {
"type": "array",
"description": "Customizable Attribute array of options\n\n+"
},
"customizable_attribute[selected_value]": {
"type": "string",
"description": "Customizable Attribute selected value"
}
},
"required": [
"customizable_attribute[type]"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Customizable Attribute Creation
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"customizable_id": {
"type": "integer",
"format": "int32",
"description": "Customizable ID"
},
"type": {
"type": "string",
"enum": [
"CustomizableAttribute::Boolean",
"CustomizableAttribute::Date",
"CustomizableAttribute::DoubleSelect",
"CustomizableAttribute::Number",
"CustomizableAttribute::Select",
"CustomizableAttribute::Text"
],
"description": "Customizable Attribute type"
},
"customizable_type": {
"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",
"mentorships",
"mentorships_mentee",
"mentorships_mentor",
"ne_event",
"ne_ticket",
"topic_approval",
"topic_mentorships",
"topic_mentorships_mentee",
"topic_mentorships_mentor",
"user",
"ventures_venture"
],
"description": "Customizable Attribute associated model (User, Experience)"
},
"name": {
"type": "string",
"description": "Customizable Attribute name"
},
"display_name": {
"type": "string",
"description": "Customizable Attribute displayed name"
},
"tooltip": {
"type": "string",
"description": "Customizable Attribute tooltip"
},
"placeholder": {
"type": "string",
"description": "Customizable Attribute placeholder"
},
"multi": {
"type": "boolean",
"description": "Customizable Attribute multi activated ?"
},
"text_size": {
"type": "integer",
"format": "int32",
"description": "Customizable Attribute text_size"
},
"visibility": {
"type": "string",
"enum": [
"admin_only",
"tagged_user",
"everybody",
"not_visible"
],
"description": "Customizable Attribute visibility"
},
"user_editable": {
"type": "boolean",
"description": "Customizable Attribute editable by the user ?"
},
"required": {
"type": "boolean",
"description": "Customizable Attribute required ?"
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "Customizable Attribute array of options"
},
"json_options": {
"type": "object",
"description": "Customizable Attribute json options (for double select)"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Customizable Attribute creation date"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Customizable Attribute last update date"
},
"selected_value": {
"type": "string",
"description": "Customizable Attribute selected value"
}
},
"description": "CustomizableAttribute model"
}Customizable Attribute CreationPOST/api/admin/v2/experiences/customizable_attributes/create
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" ] } } } ```
PUT /api/admin/v2/experiences/customizable_attributes/update
Requests
Body
{
"id": 1,
"customizable_attribute[display_name]": "Hello, world!",
"customizable_attribute[tooltip]": "Hello, world!",
"customizable_attribute[placeholder]": "Hello, world!",
"customizable_attribute[multi]": true,
"customizable_attribute[text_size]": 1,
"customizable_attribute[visibility]": "Hello, world!",
"customizable_attribute[user_editable]": true,
"customizable_attribute[required]": true,
"customizable_attribute[options][]": [],
"customizable_attribute[selected_value]": "Hello, world!"
}Schema
{
"type": "object",
"properties": {
"id": {
"type": "number"
},
"customizable_attribute[display_name]": {
"type": "string",
"description": "Customizable Attribute displayed name"
},
"customizable_attribute[tooltip]": {
"type": "string",
"description": "Customizable Attribute tooltip"
},
"customizable_attribute[placeholder]": {
"type": "string",
"description": "Customizable Attribute placeholder"
},
"customizable_attribute[multi]": {
"type": "boolean",
"description": "Customizable Attribute multi activated ?"
},
"customizable_attribute[text_size]": {
"type": "number",
"description": "Customizable Attribute text_size"
},
"customizable_attribute[visibility]": {
"type": "string",
"description": "Customizable Attribute visibility"
},
"customizable_attribute[user_editable]": {
"type": "boolean",
"description": "Customizable Attribute editable by the user ?"
},
"customizable_attribute[required]": {
"type": "boolean",
"description": "Customizable Attribute required ?"
},
"customizable_attribute[options][]": {
"type": "array",
"description": "Customizable Attribute array of options\n\n+"
},
"customizable_attribute[selected_value]": {
"type": "string",
"description": "Customizable Attribute selected value"
}
},
"required": [
"id"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Customizable Attribute Update
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"customizable_id": {
"type": "integer",
"format": "int32",
"description": "Customizable ID"
},
"type": {
"type": "string",
"enum": [
"CustomizableAttribute::Boolean",
"CustomizableAttribute::Date",
"CustomizableAttribute::DoubleSelect",
"CustomizableAttribute::Number",
"CustomizableAttribute::Select",
"CustomizableAttribute::Text"
],
"description": "Customizable Attribute type"
},
"customizable_type": {
"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",
"mentorships",
"mentorships_mentee",
"mentorships_mentor",
"ne_event",
"ne_ticket",
"topic_approval",
"topic_mentorships",
"topic_mentorships_mentee",
"topic_mentorships_mentor",
"user",
"ventures_venture"
],
"description": "Customizable Attribute associated model (User, Experience)"
},
"name": {
"type": "string",
"description": "Customizable Attribute name"
},
"display_name": {
"type": "string",
"description": "Customizable Attribute displayed name"
},
"tooltip": {
"type": "string",
"description": "Customizable Attribute tooltip"
},
"placeholder": {
"type": "string",
"description": "Customizable Attribute placeholder"
},
"multi": {
"type": "boolean",
"description": "Customizable Attribute multi activated ?"
},
"text_size": {
"type": "integer",
"format": "int32",
"description": "Customizable Attribute text_size"
},
"visibility": {
"type": "string",
"enum": [
"admin_only",
"tagged_user",
"everybody",
"not_visible"
],
"description": "Customizable Attribute visibility"
},
"user_editable": {
"type": "boolean",
"description": "Customizable Attribute editable by the user ?"
},
"required": {
"type": "boolean",
"description": "Customizable Attribute required ?"
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "Customizable Attribute array of options"
},
"json_options": {
"type": "object",
"description": "Customizable Attribute json options (for double select)"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Customizable Attribute creation date"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Customizable Attribute last update date"
},
"selected_value": {
"type": "string",
"description": "Customizable Attribute selected value"
}
},
"description": "CustomizableAttribute model"
}Customizable Attribute UpdatePUT/api/admin/v2/experiences/customizable_attributes/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"
]
}
}
}DELETE /api/admin/v2/experiences/customizable_attributes/destroy
Responses
Customizable Attribute Deletion
Customizable Attribute DeletionDELETE/api/admin/v2/experiences/customizable_attributes/destroy
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.
URI Parameters
- id
number(required)
educations ¶
Operations about educations
GET /api/admin/v1/educations
Responses
Get all user educations
Schema
{
"type": "object",
"properties": {
"educations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"school_name": {
"type": "string",
"description": "Education school"
},
"degree": {
"type": "string",
"description": "Education degree"
},
"from": {
"type": "string",
"format": "date",
"description": "Education started at"
},
"to": {
"type": "string",
"format": "date",
"description": "Education ended at"
},
"custom_attributes": {
"type": "array",
"items": {
"type": "object"
},
"description": "Array of customizable attributes with name, value and type"
},
"external_id": {
"type": "string",
"description": "Education ID in your database"
},
"user_can_edit": {
"type": "boolean",
"description": "Is this education editable by the user"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Education creation date"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Education last update date time - iso8601"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "User linked to education"
},
"field_of_study": {
"description": "Field of study linked to Education",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"name": {
"type": "string",
"description": "Field of study name"
}
}
},
"extended_updated_at": {
"type": "string",
"format": "date-time",
"description": "Education (including custom attributes) last update date time - iso8601"
}
},
"description": "Education model"
}
}
},
"description": "EducationsFull model"
}Get all user educationsGET/api/admin/v1/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"
}URI Parameters
- page
string(required)Page of results to fetch.
- per_page
string(required)Number of results to return per page.
- order
string(required)- updated_since
string(required)
GET /api/admin/v1/educations/id?education_key=
Responses
Get user education
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"school_name": {
"type": "string",
"description": "Education school"
},
"degree": {
"type": "string",
"description": "Education degree"
},
"from": {
"type": "string",
"format": "date",
"description": "Education started at"
},
"to": {
"type": "string",
"format": "date",
"description": "Education ended at"
},
"custom_attributes": {
"type": "array",
"items": {
"type": "object"
},
"description": "Array of customizable attributes with name, value and type"
},
"external_id": {
"type": "string",
"description": "Education ID in your database"
},
"user_can_edit": {
"type": "boolean",
"description": "Is this education editable by the user"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Education creation date"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Education last update date time - iso8601"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "User linked to education"
},
"field_of_study": {
"description": "Field of study linked to Education",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"name": {
"type": "string",
"description": "Field of study name"
}
}
},
"extended_updated_at": {
"type": "string",
"format": "date-time",
"description": "Education (including custom attributes) last update date time - iso8601"
}
},
"description": "Education model"
}Get user educationGET/api/admin/v1/educations/{id}{?education_key}
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.
URI Parameters
- id
number(required)- education_key
string(required)
PUT /api/admin/v1/educations/id
Requests
Body
{
"education_key": "Hello, world!",
"education[degree]": "Hello, world!",
"education[from]": "Hello, world!",
"education[to]": "Hello, world!",
"education[custom_attributes][]": [],
"education[field_of_study_id]": 1,
"education[field_of_study_name]": "Hello, world!",
"education[external_id]": "Hello, world!",
"education[user_can_edit]": true
}Schema
{
"type": "object",
"properties": {
"education_key": {
"type": "string"
},
"education[degree]": {
"type": "string",
"description": "Education degree"
},
"education[from]": {
"type": "string",
"description": "Education started at"
},
"education[to]": {
"type": "string",
"description": "Education ended at"
},
"education[custom_attributes][]": {
"type": "array",
"description": "Array of customizable attributes with name, value and type\n\n+"
},
"education[field_of_study_id]": {
"type": "number",
"description": "Field of study ID matching the education"
},
"education[field_of_study_name]": {
"type": "string",
"description": "Field of study name (from Field of study Object linked)"
},
"education[external_id]": {
"type": "string",
"description": "Education ID in your database"
},
"education[user_can_edit]": {
"type": "boolean",
"description": "Is this education editable by the user"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Update existing user education
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"school_name": {
"type": "string",
"description": "Education school"
},
"degree": {
"type": "string",
"description": "Education degree"
},
"from": {
"type": "string",
"format": "date",
"description": "Education started at"
},
"to": {
"type": "string",
"format": "date",
"description": "Education ended at"
},
"custom_attributes": {
"type": "array",
"items": {
"type": "object"
},
"description": "Array of customizable attributes with name, value and type"
},
"external_id": {
"type": "string",
"description": "Education ID in your database"
},
"user_can_edit": {
"type": "boolean",
"description": "Is this education editable by the user"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Education creation date"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Education last update date time - iso8601"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "User linked to education"
},
"field_of_study": {
"description": "Field of study linked to Education",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"name": {
"type": "string",
"description": "Field of study name"
}
}
},
"extended_updated_at": {
"type": "string",
"format": "date-time",
"description": "Education (including custom attributes) last update date time - iso8601"
}
},
"description": "Education model"
}Validations Failed
Schema
{
"type": "object",
"properties": {
"status": {
"type": "integer",
"format": "int32",
"description": "Status Code"
},
"errors": {
"type": "string",
"description": "Errors list"
}
},
"description": "Error model"
}Update existing user educationPUT/api/admin/v1/educations/{id}
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.
URI Parameters
- id
string(required)Education ID
DELETE /api/admin/v1/educations/id?education_key=
Responses
Delete User education
Delete User educationDELETE/api/admin/v1/educations/{id}{?education_key}
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.URI Parameters
- id
string(required)- education_key
string(required)
GET /api/admin/v2/educations?page=&per_page=&order=&updated_since=
Responses
Get all user educations
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"school_name": {
"type": "string",
"description": "Education school"
},
"degree": {
"type": "string",
"description": "Education degree"
},
"from": {
"type": "string",
"format": "date",
"description": "Education started at"
},
"to": {
"type": "string",
"format": "date",
"description": "Education ended at"
},
"custom_attributes": {
"type": "array",
"items": {
"type": "object"
},
"description": "Array of customizable attributes with name, value and type"
},
"external_id": {
"type": "string",
"description": "Education ID in your database"
},
"user_can_edit": {
"type": "boolean",
"description": "Is this education editable by the user"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Education creation date"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Education last update date time - iso8601"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "User linked to education"
},
"field_of_study": {
"description": "Field of study linked to Education",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"name": {
"type": "string",
"description": "Field of study name"
}
}
},
"extended_updated_at": {
"type": "string",
"format": "date-time",
"description": "Education (including custom attributes) last update date time - iso8601"
}
},
"description": "Education model"
}Get all user educationsGET/api/admin/v2/educations{?page,per_page,order,updated_since}
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"
}URI Parameters
- page
string(required)Page of results to fetch.
- per_page
string(required)Number of results to return per page.
- order
string(required)- updated_since
string(required)
POST /api/admin/v2/educations
Requests
Body
{
"education[user_id]": "Hello, world!",
"education[school]": "Hello, world!",
"education[degree]": "Hello, world!",
"education[field_of_study]": "Hello, world!",
"education[from]": "Hello, world!",
"education[to]": "Hello, world!",
"education[custom_attributes][]": [],
"education[external_id]": "Hello, world!",
"education[user_can_edit]": true,
"education[created_at]": "Hello, world!",
"education[updated_at]": "Hello, world!",
"education[extended_updated_at]": "Hello, world!"
}Schema
{
"type": "object",
"properties": {
"education[user_id]": {
"type": "string",
"description": "User ID attached to the education"
},
"education[school]": {
"type": "string",
"description": "School name"
},
"education[degree]": {
"type": "string",
"description": "Education degree"
},
"education[field_of_study]": {
"type": "string",
"description": "Field of study"
},
"education[from]": {
"type": "string",
"description": "Education started at"
},
"education[to]": {
"type": "string",
"description": "Education ended at"
},
"education[custom_attributes][]": {
"type": "array",
"description": "Array of customizable attributes with name, value and type\n\n+"
},
"education[external_id]": {
"type": "string",
"description": "Education ID in your database"
},
"education[user_can_edit]": {
"type": "boolean",
"description": "Is this education editable by the user"
},
"education[created_at]": {
"type": "string",
"description": "Education creation date"
},
"education[updated_at]": {
"type": "string",
"description": "Education last update date time - iso8601"
},
"education[extended_updated_at]": {
"type": "string",
"description": "Education (including custom attributes) last update date time - iso8601"
}
},
"required": [
"education[user_id]",
"education[school]"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Add a user education
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"school_name": {
"type": "string",
"description": "Education school"
},
"degree": {
"type": "string",
"description": "Education degree"
},
"from": {
"type": "string",
"format": "date",
"description": "Education started at"
},
"to": {
"type": "string",
"format": "date",
"description": "Education ended at"
},
"custom_attributes": {
"type": "array",
"items": {
"type": "object"
},
"description": "Array of customizable attributes with name, value and type"
},
"external_id": {
"type": "string",
"description": "Education ID in your database"
},
"user_can_edit": {
"type": "boolean",
"description": "Is this education editable by the user"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Education creation date"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Education last update date time - iso8601"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "User linked to education"
},
"field_of_study": {
"description": "Field of study linked to Education",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"name": {
"type": "string",
"description": "Field of study name"
}
}
},
"extended_updated_at": {
"type": "string",
"format": "date-time",
"description": "Education (including custom attributes) last update date time - iso8601"
}
},
"description": "Education model"
}Validations Failed
Schema
{
"type": "object",
"properties": {
"status": {
"type": "integer",
"format": "int32",
"description": "Status Code"
},
"errors": {
"type": "string",
"description": "Errors list"
}
},
"description": "Error model"
}Add a user educationPOST/api/admin/v2/educations
Create a user education based
Add education to user matching the user_id param
GET /api/admin/v2/educations/id
Responses
Get user education
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"school_name": {
"type": "string",
"description": "Education school"
},
"degree": {
"type": "string",
"description": "Education degree"
},
"from": {
"type": "string",
"format": "date",
"description": "Education started at"
},
"to": {
"type": "string",
"format": "date",
"description": "Education ended at"
},
"custom_attributes": {
"type": "array",
"items": {
"type": "object"
},
"description": "Array of customizable attributes with name, value and type"
},
"external_id": {
"type": "string",
"description": "Education ID in your database"
},
"user_can_edit": {
"type": "boolean",
"description": "Is this education editable by the user"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Education creation date"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Education last update date time - iso8601"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "User linked to education"
},
"field_of_study": {
"description": "Field of study linked to Education",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"name": {
"type": "string",
"description": "Field of study name"
}
}
},
"extended_updated_at": {
"type": "string",
"format": "date-time",
"description": "Education (including custom attributes) last update date time - iso8601"
}
},
"description": "Education model"
}Get user educationGET/api/admin/v2/educations/{id}
Return the user education
Find the user education matching the education ID
URI Parameters
- id
number(required)
PUT /api/admin/v2/educations/id
Requests
Body
{
"education[school]": "Hello, world!",
"education[degree]": "Hello, world!",
"education[field_of_study]": "Hello, world!",
"education[from]": "Hello, world!",
"education[to]": "Hello, world!",
"education[custom_attributes][]": [],
"education[external_id]": "Hello, world!",
"education[user_can_edit]": true,
"education[created_at]": "Hello, world!",
"education[updated_at]": "Hello, world!",
"education[extended_updated_at]": "Hello, world!"
}Schema
{
"type": "object",
"properties": {
"education[school]": {
"type": "string",
"description": "Education school"
},
"education[degree]": {
"type": "string",
"description": "Education degree"
},
"education[field_of_study]": {
"type": "string",
"description": "Field of study"
},
"education[from]": {
"type": "string",
"description": "Education started at"
},
"education[to]": {
"type": "string",
"description": "Education ended at"
},
"education[custom_attributes][]": {
"type": "array",
"description": "Array of customizable attributes with name, value and type\n\n+"
},
"education[external_id]": {
"type": "string",
"description": "Education ID in your database"
},
"education[user_can_edit]": {
"type": "boolean",
"description": "Is this education editable by the user"
},
"education[created_at]": {
"type": "string",
"description": "Education creation date"
},
"education[updated_at]": {
"type": "string",
"description": "Education last update date time - iso8601"
},
"education[extended_updated_at]": {
"type": "string",
"description": "Education (including custom attributes) last update date time - iso8601"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Update existing user education
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"school_name": {
"type": "string",
"description": "Education school"
},
"degree": {
"type": "string",
"description": "Education degree"
},
"from": {
"type": "string",
"format": "date",
"description": "Education started at"
},
"to": {
"type": "string",
"format": "date",
"description": "Education ended at"
},
"custom_attributes": {
"type": "array",
"items": {
"type": "object"
},
"description": "Array of customizable attributes with name, value and type"
},
"external_id": {
"type": "string",
"description": "Education ID in your database"
},
"user_can_edit": {
"type": "boolean",
"description": "Is this education editable by the user"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Education creation date"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Education last update date time - iso8601"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "User linked to education"
},
"field_of_study": {
"description": "Field of study linked to Education",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"name": {
"type": "string",
"description": "Field of study name"
}
}
},
"extended_updated_at": {
"type": "string",
"format": "date-time",
"description": "Education (including custom attributes) last update date time - iso8601"
}
},
"description": "Education model"
}Validations Failed
Schema
{
"type": "object",
"properties": {
"status": {
"type": "integer",
"format": "int32",
"description": "Status Code"
},
"errors": {
"type": "string",
"description": "Errors list"
}
},
"description": "Error model"
}Update existing user educationPUT/api/admin/v2/educations/{id}
Update the user education
Find the user education matching the education ID.
URI Parameters
- id
string(required)Education ID
DELETE /api/admin/v2/educations/id
Responses
Delete User education
Delete User educationDELETE/api/admin/v2/educations/{id}
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.
URI Parameters
- id
number(required)
POST /api/admin/v2/educations/customizable_attributes/create
Requests
Body
{
"customizable_attribute[type]": "Hello, world!",
"customizable_attribute[display_name]": "Hello, world!",
"customizable_attribute[text_size]": 1,
"customizable_attribute[tooltip]": "Hello, world!",
"customizable_attribute[placeholder]": "Hello, world!",
"customizable_attribute[multi]": true,
"customizable_attribute[visibility]": "Hello, world!",
"customizable_attribute[user_editable]": true,
"customizable_attribute[required]": true,
"customizable_attribute[options][]": [],
"customizable_attribute[selected_value]": "Hello, world!"
}Schema
{
"type": "object",
"properties": {
"customizable_attribute[type]": {
"type": "string"
},
"customizable_attribute[display_name]": {
"type": "string",
"description": "Customizable Attribute displayed name"
},
"customizable_attribute[text_size]": {
"type": "number",
"description": "Customizable Attribute text_size"
},
"customizable_attribute[tooltip]": {
"type": "string",
"description": "Customizable Attribute tooltip"
},
"customizable_attribute[placeholder]": {
"type": "string",
"description": "Customizable Attribute placeholder"
},
"customizable_attribute[multi]": {
"type": "boolean",
"description": "Customizable Attribute multi activated ?"
},
"customizable_attribute[visibility]": {
"type": "string",
"description": "Customizable Attribute visibility"
},
"customizable_attribute[user_editable]": {
"type": "boolean",
"description": "Customizable Attribute editable by the user ?"
},
"customizable_attribute[required]": {
"type": "boolean",
"description": "Customizable Attribute required ?"
},
"customizable_attribute[options][]": {
"type": "array",
"description": "Customizable Attribute array of options\n\n+"
},
"customizable_attribute[selected_value]": {
"type": "string",
"description": "Customizable Attribute selected value"
}
},
"required": [
"customizable_attribute[type]"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Customizable Attribute Creation
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"customizable_id": {
"type": "integer",
"format": "int32",
"description": "Customizable ID"
},
"type": {
"type": "string",
"enum": [
"CustomizableAttribute::Boolean",
"CustomizableAttribute::Date",
"CustomizableAttribute::DoubleSelect",
"CustomizableAttribute::Number",
"CustomizableAttribute::Select",
"CustomizableAttribute::Text"
],
"description": "Customizable Attribute type"
},
"customizable_type": {
"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",
"mentorships",
"mentorships_mentee",
"mentorships_mentor",
"ne_event",
"ne_ticket",
"topic_approval",
"topic_mentorships",
"topic_mentorships_mentee",
"topic_mentorships_mentor",
"user",
"ventures_venture"
],
"description": "Customizable Attribute associated model (User, Experience)"
},
"name": {
"type": "string",
"description": "Customizable Attribute name"
},
"display_name": {
"type": "string",
"description": "Customizable Attribute displayed name"
},
"tooltip": {
"type": "string",
"description": "Customizable Attribute tooltip"
},
"placeholder": {
"type": "string",
"description": "Customizable Attribute placeholder"
},
"multi": {
"type": "boolean",
"description": "Customizable Attribute multi activated ?"
},
"text_size": {
"type": "integer",
"format": "int32",
"description": "Customizable Attribute text_size"
},
"visibility": {
"type": "string",
"enum": [
"admin_only",
"tagged_user",
"everybody",
"not_visible"
],
"description": "Customizable Attribute visibility"
},
"user_editable": {
"type": "boolean",
"description": "Customizable Attribute editable by the user ?"
},
"required": {
"type": "boolean",
"description": "Customizable Attribute required ?"
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "Customizable Attribute array of options"
},
"json_options": {
"type": "object",
"description": "Customizable Attribute json options (for double select)"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Customizable Attribute creation date"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Customizable Attribute last update date"
},
"selected_value": {
"type": "string",
"description": "Customizable Attribute selected value"
}
},
"description": "CustomizableAttribute model"
}Customizable Attribute CreationPOST/api/admin/v2/educations/customizable_attributes/create
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" ] } } } ```
PUT /api/admin/v2/educations/customizable_attributes/update
Requests
Body
{
"id": 1,
"customizable_attribute[display_name]": "Hello, world!",
"customizable_attribute[tooltip]": "Hello, world!",
"customizable_attribute[placeholder]": "Hello, world!",
"customizable_attribute[multi]": true,
"customizable_attribute[text_size]": 1,
"customizable_attribute[visibility]": "Hello, world!",
"customizable_attribute[user_editable]": true,
"customizable_attribute[required]": true,
"customizable_attribute[options][]": [],
"customizable_attribute[selected_value]": "Hello, world!"
}Schema
{
"type": "object",
"properties": {
"id": {
"type": "number"
},
"customizable_attribute[display_name]": {
"type": "string",
"description": "Customizable Attribute displayed name"
},
"customizable_attribute[tooltip]": {
"type": "string",
"description": "Customizable Attribute tooltip"
},
"customizable_attribute[placeholder]": {
"type": "string",
"description": "Customizable Attribute placeholder"
},
"customizable_attribute[multi]": {
"type": "boolean",
"description": "Customizable Attribute multi activated ?"
},
"customizable_attribute[text_size]": {
"type": "number",
"description": "Customizable Attribute text_size"
},
"customizable_attribute[visibility]": {
"type": "string",
"description": "Customizable Attribute visibility"
},
"customizable_attribute[user_editable]": {
"type": "boolean",
"description": "Customizable Attribute editable by the user ?"
},
"customizable_attribute[required]": {
"type": "boolean",
"description": "Customizable Attribute required ?"
},
"customizable_attribute[options][]": {
"type": "array",
"description": "Customizable Attribute array of options\n\n+"
},
"customizable_attribute[selected_value]": {
"type": "string",
"description": "Customizable Attribute selected value"
}
},
"required": [
"id"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Customizable Attribute Update
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"customizable_id": {
"type": "integer",
"format": "int32",
"description": "Customizable ID"
},
"type": {
"type": "string",
"enum": [
"CustomizableAttribute::Boolean",
"CustomizableAttribute::Date",
"CustomizableAttribute::DoubleSelect",
"CustomizableAttribute::Number",
"CustomizableAttribute::Select",
"CustomizableAttribute::Text"
],
"description": "Customizable Attribute type"
},
"customizable_type": {
"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",
"mentorships",
"mentorships_mentee",
"mentorships_mentor",
"ne_event",
"ne_ticket",
"topic_approval",
"topic_mentorships",
"topic_mentorships_mentee",
"topic_mentorships_mentor",
"user",
"ventures_venture"
],
"description": "Customizable Attribute associated model (User, Experience)"
},
"name": {
"type": "string",
"description": "Customizable Attribute name"
},
"display_name": {
"type": "string",
"description": "Customizable Attribute displayed name"
},
"tooltip": {
"type": "string",
"description": "Customizable Attribute tooltip"
},
"placeholder": {
"type": "string",
"description": "Customizable Attribute placeholder"
},
"multi": {
"type": "boolean",
"description": "Customizable Attribute multi activated ?"
},
"text_size": {
"type": "integer",
"format": "int32",
"description": "Customizable Attribute text_size"
},
"visibility": {
"type": "string",
"enum": [
"admin_only",
"tagged_user",
"everybody",
"not_visible"
],
"description": "Customizable Attribute visibility"
},
"user_editable": {
"type": "boolean",
"description": "Customizable Attribute editable by the user ?"
},
"required": {
"type": "boolean",
"description": "Customizable Attribute required ?"
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "Customizable Attribute array of options"
},
"json_options": {
"type": "object",
"description": "Customizable Attribute json options (for double select)"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Customizable Attribute creation date"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Customizable Attribute last update date"
},
"selected_value": {
"type": "string",
"description": "Customizable Attribute selected value"
}
},
"description": "CustomizableAttribute model"
}Customizable Attribute UpdatePUT/api/admin/v2/educations/customizable_attributes/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"
]
}
}
}DELETE /api/admin/v2/educations/customizable_attributes/destroy
Responses
Customizable Attribute Deletion
Customizable Attribute DeletionDELETE/api/admin/v2/educations/customizable_attributes/destroy
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.
URI Parameters
- id
number(required)
emailings ¶
Operations about emailings
GET /api/admin/v1/emailings/categories?page=&per_page=
Responses
Get emailing categories list
Schema
{
"type": "object",
"properties": {
"categories": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"name": {
"type": "string",
"description": "Name of the category"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Category creation date time - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Category last update date time - iso8601"
}
},
"description": "NetworkCategory model"
}
}
},
"description": "NetworkCategoriesFull model"
}Get emailing categories listGET/api/admin/v1/emailings/categories{?page,per_page}
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"
}URI Parameters
- page
string(required)Page of results to fetch.
- per_page
string(required)Number of results to return per page.
POST /api/admin/v1/emailings/categories
Requests
Body
{
"category[name]": "Hello, world!"
}Schema
{
"type": "object",
"properties": {
"category[name]": {
"type": "string",
"description": "Name of the category"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Add a new emailing category
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"name": {
"type": "string",
"description": "Name of the category"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Category creation date time - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Category last update date time - iso8601"
}
},
"description": "NetworkCategory model"
}Validations Failed
Schema
{
"type": "object",
"properties": {
"status": {
"type": "integer",
"format": "int32",
"description": "Status Code"
},
"errors": {
"type": "string",
"description": "Errors list"
}
},
"description": "Error model"
}Add a new emailing categoryPOST/api/admin/v1/emailings/categories
Create a new emailing category
GET /api/admin/v1/emailings/categories/id
Responses
Get emailing category information
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"name": {
"type": "string",
"description": "Name of the category"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Category creation date time - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Category last update date time - iso8601"
}
},
"description": "NetworkCategory model"
}Get emailing category informationGET/api/admin/v1/emailings/categories/{id}
Return the emailing category.
URI Parameters
- id
string(required)
PUT /api/admin/v1/emailings/categories/id
Requests
Body
{
"category[name]": "Hello, world!",
"category[created_at]": "Hello, world!"
}Schema
{
"type": "object",
"properties": {
"category[name]": {
"type": "string",
"description": "Name of the category"
},
"category[created_at]": {
"type": "string",
"description": "Category creation date time - iso8601"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Update an emailing category
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"name": {
"type": "string",
"description": "Name of the category"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Category creation date time - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Category last update date time - iso8601"
}
},
"description": "NetworkCategory model"
}Validations Failed
Schema
{
"type": "object",
"properties": {
"status": {
"type": "integer",
"format": "int32",
"description": "Status Code"
},
"errors": {
"type": "string",
"description": "Errors list"
}
},
"description": "Error model"
}Update an emailing categoryPUT/api/admin/v1/emailings/categories/{id}
Update the emailing category attributes and return the updated emailing category.
URI Parameters
- id
number(required)
DELETE /api/admin/v1/emailings/categories/id
Responses
Delete Emailing Category
Delete Emailing CategoryDELETE/api/admin/v1/emailings/categories/{id}
Delete the Emailing Category based on its ID
URI Parameters
- id
string(required)
GET /api/admin/v1/emailings/campaigns?page=&per_page=
Responses
Get emailing campaigns list
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Emailing campaign creation date"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Emailing campaign last update date"
},
"sent_date": {
"type": "string",
"format": "date-time",
"description": "Emailing campaign expedition date"
},
"which_user_email": {
"type": "string",
"enum": [
"primary_email",
"email",
"email2",
"email3",
"email1then2",
"email1then2then3",
"email2then1",
"email3then2then1",
"email1and2",
"email1and2and3"
],
"description": "To which email the campaign is sent"
},
"subject": {
"type": "string",
"description": "Subject of the Emailing campaign"
},
"from_name": {
"type": "string",
"description": "Sender name of the Emailing campaign"
},
"from": {
"type": "string",
"description": "Sender email of the Emailing campaign"
},
"reply_to_name": {
"type": "string",
"description": "Reply to name for the Emailing campaign"
},
"reply_to": {
"type": "string",
"description": "Reply to email for the Emailing campaign"
},
"content": {
"type": "string",
"description": "Content of the Emailing campaign"
},
"network_categories": {
"description": "Network categories linked to the campaign",
"type": "object",
"properties": {
"categories": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"name": {
"type": "string",
"description": "Name of the category"
}
},
"description": "NetworkCategoryCompact model"
}
}
}
},
"display_invitation": {
"type": "boolean",
"description": "Display the invitation button at the end of the emailing ?"
},
"topic_ids": {
"type": "integer",
"format": "int32",
"description": "Linked topic ids"
},
"network_event_ids": {
"type": "integer",
"format": "int32",
"description": "linked event ids"
},
"recipients_count": {
"type": "integer",
"format": "int32",
"description": "Number of recipients"
},
"recipient_ids": {
"type": "integer",
"format": "int32",
"description": "user ids who received the campaign"
}
},
"description": "EmailingCampaign model"
}Get emailing campaigns listGET/api/admin/v1/emailings/campaigns{?page,per_page}
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"
}URI Parameters
- page
string(required)Page of results to fetch.
- per_page
string(required)Number of results to return per page.
POST /api/admin/v1/emailings/campaigns
Requests
Body
{
"emailing_campaign[subject]": "Hello, world!",
"emailing_campaign[which_user_email]": "Hello, world!",
"emailing_campaign[from_name]": "Hello, world!",
"emailing_campaign[from]": "Hello, world!",
"emailing_campaign[reply_to_name]": "Hello, world!",
"emailing_campaign[reply_to]": "Hello, world!",
"emailing_campaign[content]": "Hello, world!",
"emailing_campaign[network_categories]": "Hello, world!",
"emailing_campaign[display_invitation]": true,
"emailing_campaign[topic_ids][]": [
1
],
"emailing_campaign[network_event_ids][]": [
1
],
"emailing_campaign[recipients_count]": 1,
"emailing_campaign[recipient_ids][]": [
1
]
}Schema
{
"type": "object",
"properties": {
"emailing_campaign[subject]": {
"type": "string"
},
"emailing_campaign[which_user_email]": {
"type": "string",
"description": "To which email the campaign is sent"
},
"emailing_campaign[from_name]": {
"type": "string",
"description": "Sender name of the Emailing campaign"
},
"emailing_campaign[from]": {
"type": "string",
"description": "Sender email of the Emailing campaign"
},
"emailing_campaign[reply_to_name]": {
"type": "string",
"description": "Reply to name for the Emailing campaign"
},
"emailing_campaign[reply_to]": {
"type": "string",
"description": "Reply to email for the Emailing campaign"
},
"emailing_campaign[content]": {
"type": "string",
"description": "Content of the Emailing campaign"
},
"emailing_campaign[network_categories]": {
"type": "string",
"description": "Network categories linked to the campaign"
},
"emailing_campaign[display_invitation]": {
"type": "boolean",
"description": "Display the invitation button at the end of the emailing ?"
},
"emailing_campaign[topic_ids][]": {
"type": "array",
"items": {
"type": "number"
},
"description": "Linked topic ids"
},
"emailing_campaign[network_event_ids][]": {
"type": "array",
"items": {
"type": "number"
},
"description": "linked event ids"
},
"emailing_campaign[recipients_count]": {
"type": "number",
"description": "Number of recipients"
},
"emailing_campaign[recipient_ids][]": {
"type": "array",
"items": {
"type": "number"
},
"description": "user ids who received the campaign"
}
},
"required": [
"emailing_campaign[subject]"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Create an emailing campaign
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Emailing campaign creation date"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Emailing campaign last update date"
},
"sent_date": {
"type": "string",
"format": "date-time",
"description": "Emailing campaign expedition date"
},
"which_user_email": {
"type": "string",
"enum": [
"primary_email",
"email",
"email2",
"email3",
"email1then2",
"email1then2then3",
"email2then1",
"email3then2then1",
"email1and2",
"email1and2and3"
],
"description": "To which email the campaign is sent"
},
"subject": {
"type": "string",
"description": "Subject of the Emailing campaign"
},
"from_name": {
"type": "string",
"description": "Sender name of the Emailing campaign"
},
"from": {
"type": "string",
"description": "Sender email of the Emailing campaign"
},
"reply_to_name": {
"type": "string",
"description": "Reply to name for the Emailing campaign"
},
"reply_to": {
"type": "string",
"description": "Reply to email for the Emailing campaign"
},
"content": {
"type": "string",
"description": "Content of the Emailing campaign"
},
"network_categories": {
"description": "Network categories linked to the campaign",
"type": "object",
"properties": {
"categories": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"name": {
"type": "string",
"description": "Name of the category"
}
},
"description": "NetworkCategoryCompact model"
}
}
}
},
"display_invitation": {
"type": "boolean",
"description": "Display the invitation button at the end of the emailing ?"
},
"topic_ids": {
"type": "integer",
"format": "int32",
"description": "Linked topic ids"
},
"network_event_ids": {
"type": "integer",
"format": "int32",
"description": "linked event ids"
},
"recipients_count": {
"type": "integer",
"format": "int32",
"description": "Number of recipients"
},
"recipient_ids": {
"type": "integer",
"format": "int32",
"description": "user ids who received the campaign"
}
},
"description": "EmailingCampaign model"
}Create an emailing campaignPOST/api/admin/v1/emailings/campaigns
Create an emailing campaign with the specified parameters
GET /api/admin/v1/emailings/campaigns/id
Responses
Get an emailing campaign
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Emailing campaign creation date"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Emailing campaign last update date"
},
"sent_date": {
"type": "string",
"format": "date-time",
"description": "Emailing campaign expedition date"
},
"which_user_email": {
"type": "string",
"enum": [
"primary_email",
"email",
"email2",
"email3",
"email1then2",
"email1then2then3",
"email2then1",
"email3then2then1",
"email1and2",
"email1and2and3"
],
"description": "To which email the campaign is sent"
},
"subject": {
"type": "string",
"description": "Subject of the Emailing campaign"
},
"from_name": {
"type": "string",
"description": "Sender name of the Emailing campaign"
},
"from": {
"type": "string",
"description": "Sender email of the Emailing campaign"
},
"reply_to_name": {
"type": "string",
"description": "Reply to name for the Emailing campaign"
},
"reply_to": {
"type": "string",
"description": "Reply to email for the Emailing campaign"
},
"content": {
"type": "string",
"description": "Content of the Emailing campaign"
},
"network_categories": {
"description": "Network categories linked to the campaign",
"type": "object",
"properties": {
"categories": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"name": {
"type": "string",
"description": "Name of the category"
}
},
"description": "NetworkCategoryCompact model"
}
}
}
},
"display_invitation": {
"type": "boolean",
"description": "Display the invitation button at the end of the emailing ?"
},
"topic_ids": {
"type": "integer",
"format": "int32",
"description": "Linked topic ids"
},
"network_event_ids": {
"type": "integer",
"format": "int32",
"description": "linked event ids"
},
"recipients_count": {
"type": "integer",
"format": "int32",
"description": "Number of recipients"
},
"recipient_ids": {
"type": "integer",
"format": "int32",
"description": "user ids who received the campaign"
}
},
"description": "EmailingCampaign model"
}Get an emailing campaignGET/api/admin/v1/emailings/campaigns/{id}
Get a specific emailing campaign
URI Parameters
- id
string(required)
PUT /api/admin/v1/emailings/campaigns/id
Requests
Body
{
"emailing_campaign[which_user_email]": "Hello, world!",
"emailing_campaign[subject]": "Hello, world!",
"emailing_campaign[from_name]": "Hello, world!",
"emailing_campaign[from]": "Hello, world!",
"emailing_campaign[reply_to_name]": "Hello, world!",
"emailing_campaign[reply_to]": "Hello, world!",
"emailing_campaign[content]": "Hello, world!",
"emailing_campaign[network_categories]": "Hello, world!",
"emailing_campaign[display_invitation]": true,
"emailing_campaign[topic_ids][]": [
1
],
"emailing_campaign[network_event_ids][]": [
1
],
"emailing_campaign[recipients_count]": 1,
"emailing_campaign[recipient_ids][]": [
1
]
}Schema
{
"type": "object",
"properties": {
"emailing_campaign[which_user_email]": {
"type": "string",
"description": "To which email the campaign is sent"
},
"emailing_campaign[subject]": {
"type": "string",
"description": "Subject of the Emailing campaign"
},
"emailing_campaign[from_name]": {
"type": "string",
"description": "Sender name of the Emailing campaign"
},
"emailing_campaign[from]": {
"type": "string",
"description": "Sender email of the Emailing campaign"
},
"emailing_campaign[reply_to_name]": {
"type": "string",
"description": "Reply to name for the Emailing campaign"
},
"emailing_campaign[reply_to]": {
"type": "string",
"description": "Reply to email for the Emailing campaign"
},
"emailing_campaign[content]": {
"type": "string",
"description": "Content of the Emailing campaign"
},
"emailing_campaign[network_categories]": {
"type": "string",
"description": "Network categories linked to the campaign"
},
"emailing_campaign[display_invitation]": {
"type": "boolean",
"description": "Display the invitation button at the end of the emailing ?"
},
"emailing_campaign[topic_ids][]": {
"type": "array",
"items": {
"type": "number"
},
"description": "Linked topic ids"
},
"emailing_campaign[network_event_ids][]": {
"type": "array",
"items": {
"type": "number"
},
"description": "linked event ids"
},
"emailing_campaign[recipients_count]": {
"type": "number",
"description": "Number of recipients"
},
"emailing_campaign[recipient_ids][]": {
"type": "array",
"items": {
"type": "number"
},
"description": "user ids who received the campaign"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Update an emailing campaign
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Emailing campaign creation date"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Emailing campaign last update date"
},
"sent_date": {
"type": "string",
"format": "date-time",
"description": "Emailing campaign expedition date"
},
"which_user_email": {
"type": "string",
"enum": [
"primary_email",
"email",
"email2",
"email3",
"email1then2",
"email1then2then3",
"email2then1",
"email3then2then1",
"email1and2",
"email1and2and3"
],
"description": "To which email the campaign is sent"
},
"subject": {
"type": "string",
"description": "Subject of the Emailing campaign"
},
"from_name": {
"type": "string",
"description": "Sender name of the Emailing campaign"
},
"from": {
"type": "string",
"description": "Sender email of the Emailing campaign"
},
"reply_to_name": {
"type": "string",
"description": "Reply to name for the Emailing campaign"
},
"reply_to": {
"type": "string",
"description": "Reply to email for the Emailing campaign"
},
"content": {
"type": "string",
"description": "Content of the Emailing campaign"
},
"network_categories": {
"description": "Network categories linked to the campaign",
"type": "object",
"properties": {
"categories": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"name": {
"type": "string",
"description": "Name of the category"
}
},
"description": "NetworkCategoryCompact model"
}
}
}
},
"display_invitation": {
"type": "boolean",
"description": "Display the invitation button at the end of the emailing ?"
},
"topic_ids": {
"type": "integer",
"format": "int32",
"description": "Linked topic ids"
},
"network_event_ids": {
"type": "integer",
"format": "int32",
"description": "linked event ids"
},
"recipients_count": {
"type": "integer",
"format": "int32",
"description": "Number of recipients"
},
"recipient_ids": {
"type": "integer",
"format": "int32",
"description": "user ids who received the campaign"
}
},
"description": "EmailingCampaign model"
}Update an emailing campaignPUT/api/admin/v1/emailings/campaigns/{id}
Update a non-sent emailing campaign
URI Parameters
- id
string(required)
DELETE /api/admin/v1/emailings/campaigns/id
Responses
Delete emailing campaign
Delete emailing campaignDELETE/api/admin/v1/emailings/campaigns/{id}
Deletes an emailing campaign
URI Parameters
- id
string(required)
POST /api/admin/v1/emailings/campaigns/id/send
Requests
Body
{
"recipients[user_list_ids][]": [
1
]
}Schema
{
"type": "object",
"properties": {
"recipients[user_list_ids][]": {
"type": "array",
"items": {
"type": "number"
}
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Send an emailing campaign
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Emailing campaign creation date"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Emailing campaign last update date"
},
"sent_date": {
"type": "string",
"format": "date-time",
"description": "Emailing campaign expedition date"
},
"which_user_email": {
"type": "string",
"enum": [
"primary_email",
"email",
"email2",
"email3",
"email1then2",
"email1then2then3",
"email2then1",
"email3then2then1",
"email1and2",
"email1and2and3"
],
"description": "To which email the campaign is sent"
},
"subject": {
"type": "string",
"description": "Subject of the Emailing campaign"
},
"from_name": {
"type": "string",
"description": "Sender name of the Emailing campaign"
},
"from": {
"type": "string",
"description": "Sender email of the Emailing campaign"
},
"reply_to_name": {
"type": "string",
"description": "Reply to name for the Emailing campaign"
},
"reply_to": {
"type": "string",
"description": "Reply to email for the Emailing campaign"
},
"content": {
"type": "string",
"description": "Content of the Emailing campaign"
},
"network_categories": {
"description": "Network categories linked to the campaign",
"type": "object",
"properties": {
"categories": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"name": {
"type": "string",
"description": "Name of the category"
}
},
"description": "NetworkCategoryCompact model"
}
}
}
},
"display_invitation": {
"type": "boolean",
"description": "Display the invitation button at the end of the emailing ?"
},
"topic_ids": {
"type": "integer",
"format": "int32",
"description": "Linked topic ids"
},
"network_event_ids": {
"type": "integer",
"format": "int32",
"description": "linked event ids"
},
"recipients_count": {
"type": "integer",
"format": "int32",
"description": "Number of recipients"
},
"recipient_ids": {
"type": "integer",
"format": "int32",
"description": "user ids who received the campaign"
}
},
"description": "EmailingCampaign model"
}Send an emailing campaignPOST/api/admin/v1/emailings/campaigns/{id}/send
Sends the specified non-sent emailing campaign
URI Parameters
- id
string(required)
topics ¶
Operations about topics
GET /api/admin/v1/topics/categories
Responses
Get Topic Categories
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"name": {
"type": "string",
"description": "Topic Category title"
},
"description": {
"type": "string",
"description": "Topic Category description"
}
},
"required": [
"name",
"description"
],
"description": "TopicCategory model"
}Get Topic CategoriesGET/api/admin/v1/topics/categories
Return this network Topic Categories. This endpoint has been deprecated.
GET /api/admin/v1/topics?page=&per_page=
Responses
(DEPRECATED) Get Topics
Schema
{
"type": "object",
"properties": {
"topics": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"name": {
"type": "string",
"description": "Topic title"
},
"description": {
"type": "string",
"description": "Topic description"
},
"expert_title": {
"type": "string",
"description": "Topic expert title"
},
"public": {
"type": "boolean",
"description": "Topic public ?"
},
"restricted_access": {
"type": "boolean",
"description": "Restricted access to this topic ?"
},
"category_id": {
"type": "integer",
"format": "int32",
"description": "Topic Category ID"
},
"category": {
"description": "Topic is part of this category",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"name": {
"type": "string",
"description": "Topic Category title"
},
"description": {
"type": "string",
"description": "Topic Category description"
}
},
"required": [
"name",
"description"
]
},
"experts": {
"type": "object",
"description": "Users' ID, name and description of each Expert for this Topic"
},
"followers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"email": {
"type": "string",
"description": "User email"
},
"name": {
"type": "string",
"description": "User full name"
},
"sub_network_ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": "IDs list of user sub networks"
},
"extended_updated_at": {
"type": "string",
"format": "date-time",
"description": "User full profile ( with experiences, educations, customs) last update date time - iso8601"
},
"joined_at": {
"type": "string",
"format": "date-time",
"description": "Timestamp the User joined the topic - iso8601"
}
},
"description": "Follower model"
}
},
"logo": {
"type": "object",
"properties": {
"default-url": {
"type": "string",
"description": "topic default logo url"
},
"medium-url": {
"type": "string",
"description": "topic medium logo url"
}
},
"description": "Logo URLs"
},
"cover_picture": {
"type": "object",
"properties": {
"default-url": {
"type": "string",
"description": "topic default logo url"
},
"medium-url": {
"type": "string",
"description": "topic medium logo url"
},
"small-url": {
"type": "string",
"description": "topic small logo url"
}
},
"description": "Cover picture URLs"
}
},
"description": "Topic model"
}
}
},
"description": "Topics model"
}(DEPRECATED) Get TopicsGET/api/admin/v1/topics{?page,per_page}
Return this network topics. This endpoint has been deprecated.
URI Parameters
- page
string(required)Page of results to fetch.
- per_page
string(required)Number of results to return per page.
POST /api/admin/v1/topics
Requests
Body
{
"topic[name]": "Hello, world!",
"topic[description]": "Hello, world!",
"topic[expert_ids][]": [
1
],
"topic[logo]": "Hello, world!",
"topic[cover_picture]": "Hello, world!",
"topic[expert_title]": "Hello, world!",
"topic[public]": true,
"topic[restricted_access]": true,
"topic[category_id]": 1
}Schema
{
"type": "object",
"properties": {
"topic[name]": {
"type": "string",
"description": "Topic Name"
},
"topic[description]": {
"type": "string",
"description": "Topic Description"
},
"topic[expert_ids][]": {
"type": "array",
"items": {
"type": "number"
},
"description": "Topic Expert user ids"
},
"topic[logo]": {
"type": "string"
},
"topic[cover_picture]": {
"type": "string"
},
"topic[expert_title]": {
"type": "string",
"description": "Topic expert title"
},
"topic[public]": {
"type": "boolean",
"description": "Topic public ?"
},
"topic[restricted_access]": {
"type": "boolean",
"description": "Restricted access to this topic ?"
},
"topic[category_id]": {
"type": "number",
"description": "Topic Category ID"
}
},
"required": [
"topic[name]",
"topic[description]"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
(DEPRECATED) Create a new Topic
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"name": {
"type": "string",
"description": "Topic title"
},
"description": {
"type": "string",
"description": "Topic description"
},
"expert_title": {
"type": "string",
"description": "Topic expert title"
},
"public": {
"type": "boolean",
"description": "Topic public ?"
},
"restricted_access": {
"type": "boolean",
"description": "Restricted access to this topic ?"
},
"category_id": {
"type": "integer",
"format": "int32",
"description": "Topic Category ID"
},
"category": {
"description": "Topic is part of this category",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"name": {
"type": "string",
"description": "Topic Category title"
},
"description": {
"type": "string",
"description": "Topic Category description"
}
},
"required": [
"name",
"description"
]
},
"experts": {
"type": "object",
"description": "Users' ID, name and description of each Expert for this Topic"
},
"followers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"email": {
"type": "string",
"description": "User email"
},
"name": {
"type": "string",
"description": "User full name"
},
"sub_network_ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": "IDs list of user sub networks"
},
"extended_updated_at": {
"type": "string",
"format": "date-time",
"description": "User full profile ( with experiences, educations, customs) last update date time - iso8601"
},
"joined_at": {
"type": "string",
"format": "date-time",
"description": "Timestamp the User joined the topic - iso8601"
}
},
"description": "Follower model"
}
},
"logo": {
"type": "object",
"properties": {
"default-url": {
"type": "string",
"description": "topic default logo url"
},
"medium-url": {
"type": "string",
"description": "topic medium logo url"
}
},
"description": "Logo URLs"
},
"cover_picture": {
"type": "object",
"properties": {
"default-url": {
"type": "string",
"description": "topic default logo url"
},
"medium-url": {
"type": "string",
"description": "topic medium logo url"
},
"small-url": {
"type": "string",
"description": "topic small logo url"
}
},
"description": "Cover picture URLs"
}
},
"description": "Topic model"
}Validations Failed
Schema
{
"type": "object",
"properties": {
"status": {
"type": "integer",
"format": "int32",
"description": "Status Code"
},
"errors": {
"type": "string",
"description": "Errors list"
}
},
"description": "Error model"
}(DEPRECATED) Create a new TopicPOST/api/admin/v1/topics
Create a new topic
This endpoint has been deprecated.
GET /api/admin/v1/topics/id
Responses
(DEPRECATED) Get Topic
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"name": {
"type": "string",
"description": "Topic title"
},
"description": {
"type": "string",
"description": "Topic description"
},
"expert_title": {
"type": "string",
"description": "Topic expert title"
},
"public": {
"type": "boolean",
"description": "Topic public ?"
},
"restricted_access": {
"type": "boolean",
"description": "Restricted access to this topic ?"
},
"category_id": {
"type": "integer",
"format": "int32",
"description": "Topic Category ID"
},
"category": {
"description": "Topic is part of this category",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"name": {
"type": "string",
"description": "Topic Category title"
},
"description": {
"type": "string",
"description": "Topic Category description"
}
},
"required": [
"name",
"description"
]
},
"experts": {
"type": "object",
"description": "Users' ID, name and description of each Expert for this Topic"
},
"followers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"email": {
"type": "string",
"description": "User email"
},
"name": {
"type": "string",
"description": "User full name"
},
"sub_network_ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": "IDs list of user sub networks"
},
"extended_updated_at": {
"type": "string",
"format": "date-time",
"description": "User full profile ( with experiences, educations, customs) last update date time - iso8601"
},
"joined_at": {
"type": "string",
"format": "date-time",
"description": "Timestamp the User joined the topic - iso8601"
}
},
"description": "Follower model"
}
},
"logo": {
"type": "object",
"properties": {
"default-url": {
"type": "string",
"description": "topic default logo url"
},
"medium-url": {
"type": "string",
"description": "topic medium logo url"
}
},
"description": "Logo URLs"
},
"cover_picture": {
"type": "object",
"properties": {
"default-url": {
"type": "string",
"description": "topic default logo url"
},
"medium-url": {
"type": "string",
"description": "topic medium logo url"
},
"small-url": {
"type": "string",
"description": "topic small logo url"
}
},
"description": "Cover picture URLs"
}
},
"description": "Topic model"
}(DEPRECATED) Get TopicGET/api/admin/v1/topics/{id}
Return this Topic. This endpoint has been deprecated.
URI Parameters
- id
string(required)
PUT /api/admin/v1/topics/id
Requests
Body
{
"topic[expert_ids][]": [
1
],
"topic[logo]": "Hello, world!",
"topic[cover_picture]": "Hello, world!",
"topic[name]": "Hello, world!",
"topic[description]": "Hello, world!",
"topic[expert_title]": "Hello, world!",
"topic[public]": true,
"topic[restricted_access]": true,
"topic[category_id]": 1
}Schema
{
"type": "object",
"properties": {
"topic[expert_ids][]": {
"type": "array",
"items": {
"type": "number"
},
"description": "Topic Expert user ids"
},
"topic[logo]": {
"type": "string"
},
"topic[cover_picture]": {
"type": "string"
},
"topic[name]": {
"type": "string",
"description": "Topic title"
},
"topic[description]": {
"type": "string",
"description": "Topic description"
},
"topic[expert_title]": {
"type": "string",
"description": "Topic expert title"
},
"topic[public]": {
"type": "boolean",
"description": "Topic public ?"
},
"topic[restricted_access]": {
"type": "boolean",
"description": "Restricted access to this topic ?"
},
"topic[category_id]": {
"type": "number",
"description": "Topic Category ID"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
(DEPRECATED) Update a topic
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"name": {
"type": "string",
"description": "Topic title"
},
"description": {
"type": "string",
"description": "Topic description"
},
"expert_title": {
"type": "string",
"description": "Topic expert title"
},
"public": {
"type": "boolean",
"description": "Topic public ?"
},
"restricted_access": {
"type": "boolean",
"description": "Restricted access to this topic ?"
},
"category_id": {
"type": "integer",
"format": "int32",
"description": "Topic Category ID"
},
"category": {
"description": "Topic is part of this category",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"name": {
"type": "string",
"description": "Topic Category title"
},
"description": {
"type": "string",
"description": "Topic Category description"
}
},
"required": [
"name",
"description"
]
},
"experts": {
"type": "object",
"description": "Users' ID, name and description of each Expert for this Topic"
},
"followers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"email": {
"type": "string",
"description": "User email"
},
"name": {
"type": "string",
"description": "User full name"
},
"sub_network_ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": "IDs list of user sub networks"
},
"extended_updated_at": {
"type": "string",
"format": "date-time",
"description": "User full profile ( with experiences, educations, customs) last update date time - iso8601"
},
"joined_at": {
"type": "string",
"format": "date-time",
"description": "Timestamp the User joined the topic - iso8601"
}
},
"description": "Follower model"
}
},
"logo": {
"type": "object",
"properties": {
"default-url": {
"type": "string",
"description": "topic default logo url"
},
"medium-url": {
"type": "string",
"description": "topic medium logo url"
}
},
"description": "Logo URLs"
},
"cover_picture": {
"type": "object",
"properties": {
"default-url": {
"type": "string",
"description": "topic default logo url"
},
"medium-url": {
"type": "string",
"description": "topic medium logo url"
},
"small-url": {
"type": "string",
"description": "topic small logo url"
}
},
"description": "Cover picture URLs"
}
},
"description": "Topic model"
}Validations Failed
Schema
{
"type": "object",
"properties": {
"status": {
"type": "integer",
"format": "int32",
"description": "Status Code"
},
"errors": {
"type": "string",
"description": "Errors list"
}
},
"description": "Error model"
}(DEPRECATED) Update a topicPUT/api/admin/v1/topics/{id}
Update the topic attributes and return the updated topic. This endpoint has been deprecated.
URI Parameters
- id
number(required)Topic ID
DELETE /api/admin/v1/topics/id
Responses
(DEPRECATED) Delete Topic
(DEPRECATED) Delete TopicDELETE/api/admin/v1/topics/{id}
Delete the topic based on its ID This endpoint has been deprecated.
URI Parameters
- id
string(required)
POST /api/admin/v1/topics/topic_id/followers
Requests
Body
{
"user_ids[]": [
1
]
}Schema
{
"type": "object",
"properties": {
"user_ids[]": {
"type": "array",
"items": {
"type": "number"
}
}
},
"required": [
"user_ids[]"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
(DEPRECATED) Add Followers
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"email": {
"type": "string",
"description": "User email"
},
"name": {
"type": "string",
"description": "User full name"
},
"sub_network_ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": "IDs list of user sub networks"
},
"extended_updated_at": {
"type": "string",
"format": "date-time",
"description": "User full profile ( with experiences, educations, customs) last update date time - iso8601"
},
"joined_at": {
"type": "string",
"format": "date-time",
"description": "Timestamp the User joined the topic - iso8601"
}
},
"description": "Follower model"
}(DEPRECATED) Add FollowersPOST/api/admin/v1/topics/{topic_id}/followers
Add one or more user as follower of this Topic. This endpoint has been deprecated.
URI Parameters
- topic_id
string(required)
DELETE /api/admin/v1/topics/topic_id/followers
Responses
(DEPRECATED) Remove Followers
(DEPRECATED) Remove FollowersDELETE/api/admin/v1/topics/{topic_id}/followers
Remove one or more user as follower of this Topic. This endpoint has been deprecated.
URI Parameters
- topic_id
string(required)
GET /api/admin/v2/topics/users?page=&per_page=&status=&updated_since=
Responses
Groups Users Index
Schema
{
"type": "object",
"properties": {
"group_id": {
"type": "string",
"description": "Unique Group ID"
},
"user_id": {
"type": "string",
"description": "Unique User ID"
},
"status": {
"type": "string",
"description": "Users status in this group (members or prospects)"
},
"joined_at": {
"type": "string",
"format": "date-time",
"description": "Iso8601"
},
"notifications": {
"type": "boolean",
"description": "User enabled notifications for this Group"
}
},
"required": [
"group_id",
"user_id"
],
"description": "GroupUsers model"
}Groups Users IndexGET/api/admin/v2/topics/users{?page,per_page,status,updated_since}
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:
statusto retrieve onlymembers, onlyprospects, onlyleft, or all users (default)group_idsto retrieve only data for some groups.updated_sinceto retrieve only members / prospects updated since this date
URI Parameters
- page
string(required)Page of results to fetch.
- per_page
string(required)Number of results to return per page.
- status
string(required)- updated_since
string(required)Filter only users updated since this date
POST /api/admin/v2/topics/users
Requests
Body
{
"send_email_invitation": true,
"members[][group_id]": [
1
],
"members[][user_ids][]": [
1
],
"prospects[][group_id]": [
1
],
"prospects[][user_ids][]": [
1
]
}Schema
{
"type": "object",
"properties": {
"send_email_invitation": {
"type": "boolean",
"description": "Send an invitation email when the user is added to the group, only available for members a unconfirmed users"
},
"members[][group_id]": {
"type": "array",
"items": {
"type": "number"
},
"description": "Group unique ID"
},
"members[][user_ids][]": {
"type": "array",
"items": {
"type": "number"
},
"description": "Each user IDs to add as Members"
},
"prospects[][group_id]": {
"type": "array",
"items": {
"type": "number"
},
"description": "Group unique ID"
},
"prospects[][user_ids][]": {
"type": "array",
"items": {
"type": "number"
},
"description": "Each user IDs to add as Prospects"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Groups Users Create
Schema
{
"type": "object",
"properties": {
"group_id": {
"type": "string",
"description": "Unique Group ID"
},
"user_id": {
"type": "string",
"description": "Unique User ID"
},
"status": {
"type": "string",
"description": "Users status in this group (members or prospects)"
},
"joined_at": {
"type": "string",
"format": "date-time",
"description": "Iso8601"
},
"notifications": {
"type": "boolean",
"description": "User enabled notifications for this Group"
}
},
"required": [
"group_id",
"user_id"
],
"description": "GroupUsers model"
}Validations Failed
Schema
{
"type": "object",
"properties": {
"status": {
"type": "integer",
"format": "int32",
"description": "Status Code"
},
"errors": {
"type": "string",
"description": "Errors list"
}
},
"description": "Error model"
}Groups Users CreatePOST/api/admin/v2/topics/users
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
DELETE /api/admin/v2/topics/users
Responses
Groups Users Delete
Schema
{
"type": "object",
"properties": {
"group_id": {
"type": "string",
"description": "Unique Group ID"
},
"user_id": {
"type": "string",
"description": "Unique User ID"
},
"status": {
"type": "string",
"description": "Users status in this group (members or prospects)"
},
"joined_at": {
"type": "string",
"format": "date-time",
"description": "Iso8601"
},
"notifications": {
"type": "boolean",
"description": "User enabled notifications for this Group"
}
},
"required": [
"group_id",
"user_id"
],
"description": "GroupUsers model"
}Validations Failed
Schema
{
"type": "object",
"properties": {
"status": {
"type": "integer",
"format": "int32",
"description": "Status Code"
},
"errors": {
"type": "string",
"description": "Errors list"
}
},
"description": "Error model"
}Groups Users DeleteDELETE/api/admin/v2/topics/users
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]}
]
}POST /api/admin/v2/topics/topic_id/memberships/types
Requests
Body
{
"type[currency]": "Hello, world!",
"type[periodicity]": "Hello, world!",
"type[price]": 1,
"type[external_id]": "Hello, world!",
"type[name]": "Hello, world!",
"type[description]": "Hello, world!",
"type[active]": true,
"type[restriction_enabled]": true,
"type[discharged]": true,
"type[recurring_payment_enabled]": true,
"type[until_year_end]": true,
"type[enable_expire_month]": true,
"type[expire_month]": 1,
"type[recurring_mode]": "Hello, world!",
"type[payment_account_id]": 1
}Schema
{
"type": "object",
"properties": {
"type[currency]": {
"type": "string"
},
"type[periodicity]": {
"type": "string"
},
"type[price]": {
"type": "number"
},
"type[external_id]": {
"type": "string",
"description": "External ID of the Memberships Type (ID in your system)"
},
"type[name]": {
"type": "string",
"description": "Memberships Type Name"
},
"type[description]": {
"type": "string",
"description": "Memberships Type Description"
},
"type[active]": {
"type": "boolean",
"description": "Memberships Type active ?"
},
"type[restriction_enabled]": {
"type": "boolean",
"description": "Memberships Type restriction enabled ?"
},
"type[discharged]": {
"type": "boolean",
"description": "Memberships Type discharged ?"
},
"type[recurring_payment_enabled]": {
"type": "boolean",
"description": "Memberships Type recurring payment enabled ? (deprecated)"
},
"type[until_year_end]": {
"type": "boolean",
"description": "Memberships Type valid until year end ?"
},
"type[enable_expire_month]": {
"type": "boolean",
"description": "Memberships Type expire month ?"
},
"type[expire_month]": {
"type": "number",
"description": "Month when the Memberships Type expires"
},
"type[recurring_mode]": {
"type": "string",
"description": "Automatic renewal for memberships ?"
},
"type[payment_account_id]": {
"type": "number",
"description": "ID of associated payment account"
}
},
"required": [
"type[currency]",
"type[periodicity]",
"type[price]"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Add a new Memberships Type
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of the Memberships Type"
},
"external_id": {
"type": "string",
"description": "External ID of the Memberships Type (ID in your system)"
},
"name": {
"type": "string",
"description": "Memberships Type Name"
},
"description": {
"type": "string",
"description": "Memberships Type Description"
},
"active": {
"type": "boolean",
"description": "Memberships Type active ?"
},
"restriction_enabled": {
"type": "boolean",
"description": "Memberships Type restriction enabled ?"
},
"discharged": {
"type": "boolean",
"description": "Memberships Type discharged ?"
},
"recurring_payment_enabled": {
"type": "boolean",
"description": "Memberships Type recurring payment enabled ? (deprecated)"
},
"until_year_end": {
"type": "boolean",
"description": "Memberships Type valid until year end ?"
},
"enable_expire_month": {
"type": "boolean",
"description": "Memberships Type expire month ?"
},
"expire_month": {
"type": "integer",
"format": "int32",
"description": "Month when the Memberships Type expires"
},
"price": {
"type": "number",
"format": "float",
"description": "Memberships Type price"
},
"currency": {
"type": "string",
"description": "ISO code of the Currency of the Memberships Type"
},
"periodicity": {
"type": "string",
"enum": [
"none",
"week",
"fifteen_days",
"month",
"two_months",
"three_months",
"six_months",
"year",
"two_years",
"three_years",
"four_years",
"five_years"
],
"description": "Periodicity of the Memberships Type"
},
"recurring_mode": {
"type": "string",
"enum": [
"no_recurring",
"recurring_allowed",
"recurring_only"
],
"description": "Automatic renewal for memberships ?"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Membership type creation date - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Membership type update date - iso8601"
},
"payment_account_id": {
"type": "integer",
"format": "int32",
"description": "ID of associated payment account"
},
"parent": {
"description": "Parent Information",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Parent ID"
},
"type": {
"type": "string",
"description": "Parent type"
}
}
}
},
"description": "MembershipType model"
}Add a new Memberships TypePOST/api/admin/v2/topics/{topic_id}/memberships/types
Add a Membership Type to the Topic
URI Parameters
- topic_id
number(required)
POST /api/admin/v2/topics/topic_id/ventures
Requests
Body
{
"venture[company_name]": "Hello, world!",
"venture[business_stage]": "Hello, world!",
"venture[high_level_pitch]": "Hello, world!",
"venture[product]": "Hello, world!",
"venture[user_id]": 1,
"venture[customizable_attributes][]": [],
"venture[company_size]": "Hello, world!",
"venture[industry_ids][]": [
1
],
"venture[logo]": "Hello, world!",
"venture[cover_picture]": "Hello, world!",
"venture[company_website]": "Hello, world!",
"venture[twitter]": "Hello, world!",
"venture[facebook]": "Hello, world!",
"venture[angel_list]": "Hello, world!",
"venture[currently_fundraising]": true,
"venture[feedable_at]": "Hello, world!",
"venture[fundraising_at]": "Hello, world!",
"venture[fundraising_amount]": 1,
"venture[help]": "Hello, world!",
"venture[non_profit]": true,
"venture[video_html]": "Hello, world!",
"venture[created_date]": "Hello, world!",
"venture[fundraising_currency]": "Hello, world!",
"venture[linkedin]": "Hello, world!",
"venture[tagline]": "Hello, world!",
"venture[locations][][address]": [],
"venture[locations][][city]": [],
"venture[locations][][country_code]": [],
"venture[funding_rounds][][amount]": [
1
],
"venture[funding_rounds][][currency]": [],
"venture[funding_rounds][][funding_type]": [],
"venture[funding_rounds][][closed_date]": [],
"venture[funding_rounds][][press_url]": [],
"venture[funding_rounds][][investors][][name]": [],
"venture[funding_rounds][][investors][][url]": [],
"venture[team_members][][user_id]": [
1
],
"venture[team_members][][role]": [],
"venture[team_members][][status]": []
}Schema
{
"type": "object",
"properties": {
"venture[company_name]": {
"type": "string"
},
"venture[business_stage]": {
"type": "string"
},
"venture[high_level_pitch]": {
"type": "string"
},
"venture[product]": {
"type": "string"
},
"venture[user_id]": {
"type": "number"
},
"venture[customizable_attributes][]": {
"type": "array",
"description": "+"
},
"venture[company_size]": {
"type": "string"
},
"venture[industry_ids][]": {
"type": "array",
"items": {
"type": "number"
}
},
"venture[logo]": {
"type": "string"
},
"venture[cover_picture]": {
"type": "string"
},
"venture[company_website]": {
"type": "string",
"description": "URL to the website of the Venture"
},
"venture[twitter]": {
"type": "string",
"description": "Link to the twitter acount of the venture"
},
"venture[facebook]": {
"type": "string",
"description": "Link to the facebook acount of the venture"
},
"venture[angel_list]": {
"type": "string",
"description": "Link to the angel list acount of the venture"
},
"venture[currently_fundraising]": {
"type": "boolean",
"description": "Is the Venture currently raising fund ?"
},
"venture[feedable_at]": {
"type": "string",
"description": "Venture feed date - iso8601 / is used to sort items in a reverse chronological order in the live feed"
},
"venture[fundraising_at]": {
"type": "string",
"description": "Venture is raising funds for the next date - iso8601"
},
"venture[fundraising_amount]": {
"type": "number",
"description": "Amount of find the Venture is raising"
},
"venture[help]": {
"type": "string",
"description": "What help can be brought to the Venture"
},
"venture[non_profit]": {
"type": "boolean",
"description": "Is the Venture non-for profit ?"
},
"venture[video_html]": {
"type": "string",
"description": "Link to a video presenting the Venture"
},
"venture[created_date]": {
"type": "string",
"description": "Venture creation date - iso8601"
},
"venture[fundraising_currency]": {
"type": "string",
"description": "Currency linked to the fundraising"
},
"venture[linkedin]": {
"type": "string",
"description": "Link to the linkedin account of the company"
},
"venture[tagline]": {
"type": "string",
"description": "Tagline of the Venture"
},
"venture[locations][][address]": {
"type": "array",
"description": "+"
},
"venture[locations][][city]": {
"type": "array",
"description": "+"
},
"venture[locations][][country_code]": {
"type": "array",
"description": "+"
},
"venture[funding_rounds][][amount]": {
"type": "array",
"items": {
"type": "number"
},
"description": "Amound raised in the Funding round"
},
"venture[funding_rounds][][currency]": {
"type": "array",
"description": "+"
},
"venture[funding_rounds][][funding_type]": {
"type": "array",
"description": "Type of the Funding Round\n\n+"
},
"venture[funding_rounds][][closed_date]": {
"type": "array",
"description": "Funding Round closing date - iso8601\n\n+"
},
"venture[funding_rounds][][press_url]": {
"type": "array",
"description": "URL of the press release regarding this Funding Round\n\n+"
},
"venture[funding_rounds][][investors][][name]": {
"type": "array",
"description": "+"
},
"venture[funding_rounds][][investors][][url]": {
"type": "array",
"description": "URL to the website of the Investor\n\n+"
},
"venture[team_members][][user_id]": {
"type": "array",
"items": {
"type": "number"
}
},
"venture[team_members][][role]": {
"type": "array",
"description": "Role of the Team Member\n\n+"
},
"venture[team_members][][status]": {
"type": "array",
"description": "Approvals::Network status of the Team member in the Venture\n\n+"
}
},
"required": [
"venture[company_name]",
"venture[business_stage]",
"venture[high_level_pitch]",
"venture[product]",
"venture[user_id]",
"venture[funding_rounds][][currency]",
"venture[funding_rounds][][investors][][name]",
"venture[team_members][][user_id]"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Create a Topic Venture
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of the Venture"
},
"company_name": {
"type": "string",
"description": "Name of the Venture"
},
"high_level_pitch": {
"type": "string",
"description": "Pitch of the Venture"
},
"product": {
"type": "string",
"description": "Product sold by the Venture"
},
"logo": {
"type": "string",
"description": "URL to the logo of the Venture"
},
"company_website": {
"type": "string",
"description": "URL to the website of the Venture"
},
"twitter": {
"type": "string",
"description": "Link to the twitter acount of the venture"
},
"facebook": {
"type": "string",
"description": "Link to the facebook acount of the venture"
},
"angel_list": {
"type": "string",
"description": "Link to the angel list acount of the venture"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Venture creation date on the Service - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Venture update date - iso8601"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "ID of the User who created / has been linked to the Venture"
},
"currently_fundraising": {
"type": "boolean",
"description": "Is the Venture currently raising fund ?"
},
"feedable_at": {
"type": "string",
"format": "date-time",
"description": "Venture feed date - iso8601 / is used to sort items in a reverse chronological order in the live feed "
},
"fundraising_at": {
"type": "string",
"format": "date-time",
"description": "Venture is raising funds for the next date - iso8601"
},
"fundraising_amount": {
"type": "integer",
"format": "int32",
"description": "Amount of find the Venture is raising"
},
"help": {
"type": "string",
"description": "What help can be brought to the Venture"
},
"business_stage": {
"type": "string",
"enum": [
"seed_startup",
"growing",
"established",
"unknown"
],
"description": "Current development stage of the venture"
},
"non_profit": {
"type": "boolean",
"description": "Is the Venture non-for profit ?"
},
"video_html": {
"type": "string",
"description": "Link to a video presenting the Venture"
},
"created_date": {
"type": "string",
"format": "date-time",
"description": "Venture creation date - iso8601"
},
"cover_picture": {
"type": "string",
"description": "URL to the logo of the Venture"
},
"company_size": {
"type": "string",
"enum": [
"only_me",
"2_10",
"11_50",
"51_200",
"201_500",
"501_1000",
"1001_5000",
"5001_10000",
"10001_more"
],
"description": "Number of employees in the Venture"
},
"fundraising_currency": {
"type": "string",
"enum": [
"USD",
"EUR",
"GBP",
"AUD",
"CAD",
"JPY",
"BYR",
"PAB",
"SOS",
"SRD",
"SSP",
"STD",
"STN",
"SVC",
"SYP",
"SZL",
"THB",
"TJS",
"TMT",
"TND",
"TOP",
"TRY",
"NPR",
"TTD",
"TWD",
"NOK",
"TZS",
"UAH",
"UGX",
"NIO",
"PEN",
"OMR",
"PGK",
"PHP",
"PKR",
"PLN",
"PYG",
"QAR",
"RON",
"RSD",
"RUB",
"RWF",
"SAR",
"SBD",
"SCR",
"SDG",
"SEK",
"SGD",
"SHP",
"NZD",
"SKK",
"SLE",
"SLL",
"UYU",
"BCH",
"BTC",
"JEP",
"GGP",
"IMP",
"XFU",
"GBX",
"CNH",
"USDC",
"EEK",
"GHS",
"HRK",
"LTL",
"LVL",
"MRO",
"MTL",
"TMM",
"JPY",
"ZWD",
"ZWL",
"ZWN",
"ZWR",
"VEF",
"UZS",
"VES",
"VND",
"VUV",
"WST",
"XAF",
"XAG",
"XAU",
"XBA",
"XBB",
"XBC",
"XBD",
"XCD",
"XDR",
"XOF",
"XPD",
"XPF",
"XPT",
"XTS",
"YER",
"ZAR",
"ZMK",
"ZMW",
"AED",
"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",
"KZT",
"LAK",
"LBP",
"LKR",
"LRD",
"LSL",
"LYD",
"MAD",
"MDL",
"MGA",
"MKD",
"MMK",
"MNT",
"MOP",
"MRU",
"MUR",
"MVR",
"MWK",
"MXN",
"MYR",
"MZN",
"NAD",
"NGN",
"GNF",
"GTQ",
"GYD",
"HKD",
"HNL",
"HTG",
"HUF",
"IDR",
"ILS",
"INR",
"IQD",
"IRR",
"ISK",
"JMD",
"JOD",
"KES",
"KGS",
"KHR",
"KMF",
"KPW",
"KRW",
"KWD",
"KYD"
],
"description": "Currency linked to the fundraising"
},
"linkedin": {
"type": "string",
"description": "Link to the linkedin account of the company"
},
"tagline": {
"type": "string",
"description": "Tagline of the Venture"
},
"funding_rounds": {
"description": "Funding rounds of the Venture",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of the Funding Round"
},
"funding_type": {
"type": "string",
"enum": [
"Angel/pre-seed",
"Seed",
"Series A",
"Series B",
"Series C",
"Series D",
"Corporate Round",
"Acquired",
"Grant",
"Debt",
"Secondary"
],
"description": "Type of the Funding Round"
},
"amount": {
"type": "integer",
"format": "int32",
"description": "Amound raised in the Funding round"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Funding Round creation date - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Funding Round update date - iso8601"
},
"closed_date": {
"type": "string",
"format": "date-time",
"description": "Funding Round closing date - iso8601"
},
"press_url": {
"type": "string",
"description": "URL of the press release regarding this Funding Round"
},
"currency": {
"type": "string",
"enum": [
"usd",
"eur",
"gbp",
"aud",
"cad",
"jpy",
"byr",
"pab",
"sos",
"srd",
"ssp",
"std",
"stn",
"svc",
"syp",
"szl",
"thb",
"tjs",
"tmt",
"tnd",
"top",
"try",
"npr",
"ttd",
"twd",
"nok",
"tzs",
"uah",
"ugx",
"nio",
"pen",
"omr",
"pgk",
"php",
"pkr",
"pln",
"pyg",
"qar",
"ron",
"rsd",
"rub",
"rwf",
"sar",
"sbd",
"scr",
"sdg",
"sek",
"sgd",
"shp",
"nzd",
"skk",
"sle",
"sll",
"uyu",
"bch",
"btc",
"jep",
"ggp",
"imp",
"xfu",
"gbx",
"cnh",
"usdc",
"eek",
"ghs",
"hrk",
"ltl",
"lvl",
"mro",
"mtl",
"tmm",
"jpy",
"zwd",
"zwl",
"zwn",
"zwr",
"vef",
"uzs",
"ves",
"vnd",
"vuv",
"wst",
"xaf",
"xag",
"xau",
"xba",
"xbb",
"xbc",
"xbd",
"xcd",
"xdr",
"xof",
"xpd",
"xpf",
"xpt",
"xts",
"yer",
"zar",
"zmk",
"zmw",
"aed",
"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",
"kzt",
"lak",
"lbp",
"lkr",
"lrd",
"lsl",
"lyd",
"mad",
"mdl",
"mga",
"mkd",
"mmk",
"mnt",
"mop",
"mru",
"mur",
"mvr",
"mwk",
"mxn",
"myr",
"mzn",
"nad",
"ngn",
"gnf",
"gtq",
"gyd",
"hkd",
"hnl",
"htg",
"huf",
"idr",
"ils",
"inr",
"iqd",
"irr",
"isk",
"jmd",
"jod",
"kes",
"kgs",
"khr",
"kmf",
"kpw",
"krw",
"kwd",
"kyd"
],
"description": "Currency linked to the Funding Round"
},
"investors": {
"description": "Investors of the Funding Round",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of the Investor"
},
"name": {
"type": "string",
"description": "Name of the Investor"
},
"url": {
"type": "string",
"description": "URL to the website of the Investor"
}
}
}
}
},
"locations": {
"description": "Offices locations of the Venture",
"type": "object",
"properties": {
"city": {
"type": "string",
"description": "City"
},
"country": {
"type": "string",
"description": "Country"
},
"country_code": {
"type": "string",
"description": "ISO3166-2 Country code"
},
"address": {
"type": "string",
"description": "Address"
},
"lat": {
"type": "number",
"format": "float",
"description": "Latitude"
},
"lng": {
"type": "number",
"format": "float",
"description": "Longitude"
}
}
},
"team_members": {
"description": "Team members of the Venture",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of the Team Member"
},
"role": {
"type": "string",
"description": "Role of the Team Member"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "ID of the User linked to the Team Member"
},
"status": {
"type": "string",
"enum": [
"pending",
"accepted",
"declined"
],
"description": "Approvals::Network status of the Team member in the Venture"
},
"venture_id": {
"type": "integer",
"format": "int32",
"description": "ID of the Venture linked to the Team Member"
}
}
},
"industry_ids": {
"type": "integer",
"format": "int32",
"description": "Industries related to the Venture"
},
"parent": {
"description": "Parent Information",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Parent ID"
},
"type": {
"type": "string",
"description": "Parent type"
}
}
},
"customizable_attributes": {
"type": "array",
"items": {
"type": "object"
},
"description": "Array of customizables attribute mapping name to the value"
}
},
"description": "VentureEntity model"
}Create a Topic VenturePOST/api/admin/v2/topics/{topic_id}/ventures
Create a topic venture
Logo and cover_picture must be sent as files (URL to files won’t work)
URI Parameters
- topic_id
number(required)
GET /api/admin/v2/topics?updated_since=
Responses
Groups Index
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"name": {
"type": "string",
"description": "Group title"
},
"description": {
"type": "string",
"description": "Group description"
},
"expert_title": {
"type": "string",
"description": "Group expert title"
},
"public": {
"type": "boolean",
"description": "Group visible on user not-connected Group pages?"
},
"restricted_access": {
"type": "boolean",
"description": "Users should ask to join the group ?"
},
"secret": {
"type": "boolean",
"description": "Secret group ? (Not displayed)"
},
"published_at": {
"type": "string",
"format": "date-time",
"description": "Publication date of the Group - Iso8601"
},
"published": {
"type": "boolean",
"description": "Group is published ?"
},
"categories": {
"description": "Group is part of these categories",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"name": {
"type": "string",
"description": "Group Category title"
},
"description": {
"type": "string",
"description": "Group Category description"
}
},
"required": [
"name",
"description"
]
},
"experts": {
"description": "Users' ID, and description of each experts (Contacts) for this Group",
"type": "object",
"properties": {
"user_id": {
"type": "string",
"description": "Unique User ID"
},
"description": {
"type": "string",
"description": "Expert description"
}
},
"required": [
"user_id"
]
},
"partners": {
"description": "Partners of this group",
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Partner name"
},
"description": {
"type": "string",
"description": "Partner description"
},
"url": {
"type": "string",
"description": "Partner url"
},
"end_date": {
"type": "string",
"format": "date-time",
"description": "End Date Iso8601"
},
"logo": {
"type": "object",
"properties": {
"medium-url": {
"type": "string",
"description": "Partner medium logo url"
},
"thumb-url": {
"type": "string",
"description": "Partner thumb logo url"
}
},
"description": "Logo URLs"
}
},
"required": [
"name",
"description"
]
},
"config": {
"type": "GroupConfig",
"description": "Configs of this group"
},
"logo": {
"type": "object",
"properties": {
"default-url": {
"type": "string",
"description": "topic default logo url"
},
"medium-url": {
"type": "string",
"description": "topic medium logo url"
}
},
"description": "Logo URLs"
},
"cover_picture": {
"type": "object",
"properties": {
"default-url": {
"type": "string",
"description": "topic default logo url"
},
"medium-url": {
"type": "string",
"description": "topic medium logo url"
},
"small-url": {
"type": "string",
"description": "topic small logo url"
}
},
"description": "Cover picture URLs"
},
"location": {
"description": "Group location",
"type": "object",
"properties": {
"city": {
"type": "string",
"description": "City"
},
"country": {
"type": "string",
"description": "Country"
},
"country_code": {
"type": "string",
"description": "ISO3166-2 Country code"
},
"address": {
"type": "string",
"description": "Address"
},
"lat": {
"type": "number",
"format": "float",
"description": "Latitude"
},
"lng": {
"type": "number",
"format": "float",
"description": "Longitude"
}
}
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Group creation date - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Group update date - iso8601"
}
},
"description": "Group model"
}Groups IndexGET/api/admin/v2/topics{?updated_since}
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"
}URI Parameters
- updated_since
string(required)Filter only Groups created or updated since this date
POST /api/admin/v2/topics
Requests
Body
{
"group[name]": "Hello, world!",
"group[category_ids][]": [
1
],
"group[logo]": "Hello, world!",
"group[cover_picture]": "Hello, world!",
"group[config][news_tab_enabled]": true,
"group[config][home_tab_enabled]": true,
"group[config][forum_tab_enabled]": true,
"group[config][events_tab_enabled]": true,
"group[config][memberships_tab_enabled]": true,
"group[config][media_center_tab_enabled]": true,
"group[config][ventures_tab_enabled]": true,
"group[config][followers_tab_enabled]": true,
"group[config][default_group_activity_frequency]": "Hello, world!",
"group[experts][][user_id]": [
1
],
"group[experts][][description]": [],
"group[partners][][name]": [],
"group[partners][][url]": [],
"group[partners][][description]": [],
"group[partners][][end_date]": [],
"group[partners][][logo]": [],
"group[location][address]": "Hello, world!",
"group[location][city]": "Hello, world!",
"group[location][postal_code]": "Hello, world!",
"group[location][country]": "Hello, world!",
"group[location][country_code]": "Hello, world!",
"group[description]": "Hello, world!",
"group[expert_title]": "Hello, world!",
"group[public]": true,
"group[restricted_access]": true,
"group[secret]": true,
"group[published_at]": "Hello, world!",
"group[published]": true,
"group[created_at]": "Hello, world!",
"group[updated_at]": "Hello, world!"
}Schema
{
"type": "object",
"properties": {
"group[name]": {
"type": "string",
"description": "Group Name"
},
"group[category_ids][]": {
"type": "array",
"items": {
"type": "number"
},
"description": "Group categories ids"
},
"group[logo]": {
"type": "string"
},
"group[cover_picture]": {
"type": "string"
},
"group[config][news_tab_enabled]": {
"type": "boolean",
"description": "News tab enabled ?"
},
"group[config][home_tab_enabled]": {
"type": "boolean",
"description": "Home tab enabled ?"
},
"group[config][forum_tab_enabled]": {
"type": "boolean",
"description": "Forum tab enabled ?"
},
"group[config][events_tab_enabled]": {
"type": "boolean",
"description": "Events tab enabled ?"
},
"group[config][memberships_tab_enabled]": {
"type": "boolean",
"description": "Memberships tab enabled ?"
},
"group[config][media_center_tab_enabled]": {
"type": "boolean",
"description": "Media Center tab enabled ?"
},
"group[config][ventures_tab_enabled]": {
"type": "boolean",
"description": "Ventures tab enabled ?"
},
"group[config][followers_tab_enabled]": {
"type": "boolean",
"description": "Followers tab enabled ?"
},
"group[config][default_group_activity_frequency]": {
"type": "string",
"description": "Group activity frequency"
},
"group[experts][][user_id]": {
"type": "array",
"items": {
"type": "number"
},
"description": "Unique User ID"
},
"group[experts][][description]": {
"type": "array",
"description": "Expert description\n\n+"
},
"group[partners][][name]": {
"type": "array",
"description": "Partner name\n\n+"
},
"group[partners][][url]": {
"type": "array",
"description": "Partner website url\n\n+"
},
"group[partners][][description]": {
"type": "array",
"description": "Partner description\n\n+"
},
"group[partners][][end_date]": {
"type": "array",
"description": "Partner end date\n\n+"
},
"group[partners][][logo]": {
"type": "array",
"description": "Partner logo file (300x300)\n\n+"
},
"group[location][address]": {
"type": "string",
"description": "Group Address"
},
"group[location][city]": {
"type": "string",
"description": "Group City"
},
"group[location][postal_code]": {
"type": "string",
"description": "Group Postal Code"
},
"group[location][country]": {
"type": "string",
"description": "Group Country"
},
"group[location][country_code]": {
"type": "string",
"description": "Group Country code (2 letters)"
},
"group[description]": {
"type": "string",
"description": "Group description"
},
"group[expert_title]": {
"type": "string",
"description": "Group expert title"
},
"group[public]": {
"type": "boolean",
"description": "Group visible on user not-connected Group pages?"
},
"group[restricted_access]": {
"type": "boolean",
"description": "Users should ask to join the group ?"
},
"group[secret]": {
"type": "boolean",
"description": "Secret group ? (Not displayed)"
},
"group[published_at]": {
"type": "string",
"description": "Publication date of the Group - Iso8601"
},
"group[published]": {
"type": "boolean",
"description": "Group is published ?"
},
"group[created_at]": {
"type": "string",
"description": "Group creation date - iso8601"
},
"group[updated_at]": {
"type": "string",
"description": "Group update date - iso8601"
}
},
"required": [
"group[name]",
"group[config][default_group_activity_frequency]",
"group[experts][][user_id]",
"group[partners][][name]",
"group[partners][][url]"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Add a new Group
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"name": {
"type": "string",
"description": "Group title"
},
"description": {
"type": "string",
"description": "Group description"
},
"expert_title": {
"type": "string",
"description": "Group expert title"
},
"public": {
"type": "boolean",
"description": "Group visible on user not-connected Group pages?"
},
"restricted_access": {
"type": "boolean",
"description": "Users should ask to join the group ?"
},
"secret": {
"type": "boolean",
"description": "Secret group ? (Not displayed)"
},
"published_at": {
"type": "string",
"format": "date-time",
"description": "Publication date of the Group - Iso8601"
},
"published": {
"type": "boolean",
"description": "Group is published ?"
},
"categories": {
"description": "Group is part of these categories",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"name": {
"type": "string",
"description": "Group Category title"
},
"description": {
"type": "string",
"description": "Group Category description"
}
},
"required": [
"name",
"description"
]
},
"experts": {
"description": "Users' ID, and description of each experts (Contacts) for this Group",
"type": "object",
"properties": {
"user_id": {
"type": "string",
"description": "Unique User ID"
},
"description": {
"type": "string",
"description": "Expert description"
}
},
"required": [
"user_id"
]
},
"partners": {
"description": "Partners of this group",
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Partner name"
},
"description": {
"type": "string",
"description": "Partner description"
},
"url": {
"type": "string",
"description": "Partner url"
},
"end_date": {
"type": "string",
"format": "date-time",
"description": "End Date Iso8601"
},
"logo": {
"type": "object",
"properties": {
"medium-url": {
"type": "string",
"description": "Partner medium logo url"
},
"thumb-url": {
"type": "string",
"description": "Partner thumb logo url"
}
},
"description": "Logo URLs"
}
},
"required": [
"name",
"description"
]
},
"config": {
"type": "GroupConfig",
"description": "Configs of this group"
},
"logo": {
"type": "object",
"properties": {
"default-url": {
"type": "string",
"description": "topic default logo url"
},
"medium-url": {
"type": "string",
"description": "topic medium logo url"
}
},
"description": "Logo URLs"
},
"cover_picture": {
"type": "object",
"properties": {
"default-url": {
"type": "string",
"description": "topic default logo url"
},
"medium-url": {
"type": "string",
"description": "topic medium logo url"
},
"small-url": {
"type": "string",
"description": "topic small logo url"
}
},
"description": "Cover picture URLs"
},
"location": {
"description": "Group location",
"type": "object",
"properties": {
"city": {
"type": "string",
"description": "City"
},
"country": {
"type": "string",
"description": "Country"
},
"country_code": {
"type": "string",
"description": "ISO3166-2 Country code"
},
"address": {
"type": "string",
"description": "Address"
},
"lat": {
"type": "number",
"format": "float",
"description": "Latitude"
},
"lng": {
"type": "number",
"format": "float",
"description": "Longitude"
}
}
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Group creation date - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Group update date - iso8601"
}
},
"description": "Group model"
}Validations Failed
Schema
{
"type": "object",
"properties": {
"status": {
"type": "integer",
"format": "int32",
"description": "Status Code"
},
"errors": {
"type": "string",
"description": "Errors list"
}
},
"description": "Error model"
}Add a new GroupPOST/api/admin/v2/topics
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.
GET /api/admin/v2/topics/id
Responses
Group
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"name": {
"type": "string",
"description": "Group title"
},
"description": {
"type": "string",
"description": "Group description"
},
"expert_title": {
"type": "string",
"description": "Group expert title"
},
"public": {
"type": "boolean",
"description": "Group visible on user not-connected Group pages?"
},
"restricted_access": {
"type": "boolean",
"description": "Users should ask to join the group ?"
},
"secret": {
"type": "boolean",
"description": "Secret group ? (Not displayed)"
},
"published_at": {
"type": "string",
"format": "date-time",
"description": "Publication date of the Group - Iso8601"
},
"published": {
"type": "boolean",
"description": "Group is published ?"
},
"categories": {
"description": "Group is part of these categories",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"name": {
"type": "string",
"description": "Group Category title"
},
"description": {
"type": "string",
"description": "Group Category description"
}
},
"required": [
"name",
"description"
]
},
"experts": {
"description": "Users' ID, and description of each experts (Contacts) for this Group",
"type": "object",
"properties": {
"user_id": {
"type": "string",
"description": "Unique User ID"
},
"description": {
"type": "string",
"description": "Expert description"
}
},
"required": [
"user_id"
]
},
"partners": {
"description": "Partners of this group",
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Partner name"
},
"description": {
"type": "string",
"description": "Partner description"
},
"url": {
"type": "string",
"description": "Partner url"
},
"end_date": {
"type": "string",
"format": "date-time",
"description": "End Date Iso8601"
},
"logo": {
"type": "object",
"properties": {
"medium-url": {
"type": "string",
"description": "Partner medium logo url"
},
"thumb-url": {
"type": "string",
"description": "Partner thumb logo url"
}
},
"description": "Logo URLs"
}
},
"required": [
"name",
"description"
]
},
"config": {
"type": "GroupConfig",
"description": "Configs of this group"
},
"logo": {
"type": "object",
"properties": {
"default-url": {
"type": "string",
"description": "topic default logo url"
},
"medium-url": {
"type": "string",
"description": "topic medium logo url"
}
},
"description": "Logo URLs"
},
"cover_picture": {
"type": "object",
"properties": {
"default-url": {
"type": "string",
"description": "topic default logo url"
},
"medium-url": {
"type": "string",
"description": "topic medium logo url"
},
"small-url": {
"type": "string",
"description": "topic small logo url"
}
},
"description": "Cover picture URLs"
},
"location": {
"description": "Group location",
"type": "object",
"properties": {
"city": {
"type": "string",
"description": "City"
},
"country": {
"type": "string",
"description": "Country"
},
"country_code": {
"type": "string",
"description": "ISO3166-2 Country code"
},
"address": {
"type": "string",
"description": "Address"
},
"lat": {
"type": "number",
"format": "float",
"description": "Latitude"
},
"lng": {
"type": "number",
"format": "float",
"description": "Longitude"
}
}
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Group creation date - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Group update date - iso8601"
}
},
"description": "Group model"
}PUT /api/admin/v2/topics/id
Requests
Body
{
"group[category_ids][]": [
1
],
"group[logo]": "Hello, world!",
"group[cover_picture]": "Hello, world!",
"group[config][news_tab_enabled]": true,
"group[config][home_tab_enabled]": true,
"group[config][forum_tab_enabled]": true,
"group[config][events_tab_enabled]": true,
"group[config][memberships_tab_enabled]": true,
"group[config][media_center_tab_enabled]": true,
"group[config][ventures_tab_enabled]": true,
"group[config][followers_tab_enabled]": true,
"group[config][default_group_activity_frequency]": "Hello, world!",
"group[experts][][user_id]": [
1
],
"group[experts][][description]": [],
"group[partners][][name]": [],
"group[partners][][url]": [],
"group[partners][][description]": [],
"group[partners][][end_date]": [],
"group[partners][][logo]": [],
"group[location][address]": "Hello, world!",
"group[location][city]": "Hello, world!",
"group[location][postal_code]": "Hello, world!",
"group[location][country]": "Hello, world!",
"group[location][country_code]": "Hello, world!",
"group[name]": "Hello, world!",
"group[description]": "Hello, world!",
"group[expert_title]": "Hello, world!",
"group[public]": true,
"group[restricted_access]": true,
"group[secret]": true,
"group[published_at]": "Hello, world!",
"group[published]": true,
"group[created_at]": "Hello, world!",
"group[updated_at]": "Hello, world!"
}Schema
{
"type": "object",
"properties": {
"group[category_ids][]": {
"type": "array",
"items": {
"type": "number"
},
"description": "Group categories ids"
},
"group[logo]": {
"type": "string"
},
"group[cover_picture]": {
"type": "string"
},
"group[config][news_tab_enabled]": {
"type": "boolean",
"description": "News tab enabled ?"
},
"group[config][home_tab_enabled]": {
"type": "boolean",
"description": "Home tab enabled ?"
},
"group[config][forum_tab_enabled]": {
"type": "boolean",
"description": "Forum tab enabled ?"
},
"group[config][events_tab_enabled]": {
"type": "boolean",
"description": "Events tab enabled ?"
},
"group[config][memberships_tab_enabled]": {
"type": "boolean",
"description": "Memberships tab enabled ?"
},
"group[config][media_center_tab_enabled]": {
"type": "boolean",
"description": "Media Center tab enabled ?"
},
"group[config][ventures_tab_enabled]": {
"type": "boolean",
"description": "Ventures tab enabled ?"
},
"group[config][followers_tab_enabled]": {
"type": "boolean",
"description": "Followers tab enabled ?"
},
"group[config][default_group_activity_frequency]": {
"type": "string",
"description": "Group activity frequency"
},
"group[experts][][user_id]": {
"type": "array",
"items": {
"type": "number"
},
"description": "Unique User ID"
},
"group[experts][][description]": {
"type": "array",
"description": "Expert description\n\n+"
},
"group[partners][][name]": {
"type": "array",
"description": "Partner name\n\n+"
},
"group[partners][][url]": {
"type": "array",
"description": "Partner website url\n\n+"
},
"group[partners][][description]": {
"type": "array",
"description": "Partner description\n\n+"
},
"group[partners][][end_date]": {
"type": "array",
"description": "Partner end date\n\n+"
},
"group[partners][][logo]": {
"type": "array",
"description": "Partner logo file (300x300)\n\n+"
},
"group[location][address]": {
"type": "string",
"description": "Group Address"
},
"group[location][city]": {
"type": "string",
"description": "Group City"
},
"group[location][postal_code]": {
"type": "string",
"description": "Group Postal Code"
},
"group[location][country]": {
"type": "string",
"description": "Group Country"
},
"group[location][country_code]": {
"type": "string",
"description": "Group Country code (2 letters)"
},
"group[name]": {
"type": "string",
"description": "Group title"
},
"group[description]": {
"type": "string",
"description": "Group description"
},
"group[expert_title]": {
"type": "string",
"description": "Group expert title"
},
"group[public]": {
"type": "boolean",
"description": "Group visible on user not-connected Group pages?"
},
"group[restricted_access]": {
"type": "boolean",
"description": "Users should ask to join the group ?"
},
"group[secret]": {
"type": "boolean",
"description": "Secret group ? (Not displayed)"
},
"group[published_at]": {
"type": "string",
"description": "Publication date of the Group - Iso8601"
},
"group[published]": {
"type": "boolean",
"description": "Group is published ?"
},
"group[created_at]": {
"type": "string",
"description": "Group creation date - iso8601"
},
"group[updated_at]": {
"type": "string",
"description": "Group update date - iso8601"
}
},
"required": [
"group[config][default_group_activity_frequency]"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Update Group
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"name": {
"type": "string",
"description": "Group title"
},
"description": {
"type": "string",
"description": "Group description"
},
"expert_title": {
"type": "string",
"description": "Group expert title"
},
"public": {
"type": "boolean",
"description": "Group visible on user not-connected Group pages?"
},
"restricted_access": {
"type": "boolean",
"description": "Users should ask to join the group ?"
},
"secret": {
"type": "boolean",
"description": "Secret group ? (Not displayed)"
},
"published_at": {
"type": "string",
"format": "date-time",
"description": "Publication date of the Group - Iso8601"
},
"published": {
"type": "boolean",
"description": "Group is published ?"
},
"categories": {
"description": "Group is part of these categories",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"name": {
"type": "string",
"description": "Group Category title"
},
"description": {
"type": "string",
"description": "Group Category description"
}
},
"required": [
"name",
"description"
]
},
"experts": {
"description": "Users' ID, and description of each experts (Contacts) for this Group",
"type": "object",
"properties": {
"user_id": {
"type": "string",
"description": "Unique User ID"
},
"description": {
"type": "string",
"description": "Expert description"
}
},
"required": [
"user_id"
]
},
"partners": {
"description": "Partners of this group",
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Partner name"
},
"description": {
"type": "string",
"description": "Partner description"
},
"url": {
"type": "string",
"description": "Partner url"
},
"end_date": {
"type": "string",
"format": "date-time",
"description": "End Date Iso8601"
},
"logo": {
"type": "object",
"properties": {
"medium-url": {
"type": "string",
"description": "Partner medium logo url"
},
"thumb-url": {
"type": "string",
"description": "Partner thumb logo url"
}
},
"description": "Logo URLs"
}
},
"required": [
"name",
"description"
]
},
"config": {
"type": "GroupConfig",
"description": "Configs of this group"
},
"logo": {
"type": "object",
"properties": {
"default-url": {
"type": "string",
"description": "topic default logo url"
},
"medium-url": {
"type": "string",
"description": "topic medium logo url"
}
},
"description": "Logo URLs"
},
"cover_picture": {
"type": "object",
"properties": {
"default-url": {
"type": "string",
"description": "topic default logo url"
},
"medium-url": {
"type": "string",
"description": "topic medium logo url"
},
"small-url": {
"type": "string",
"description": "topic small logo url"
}
},
"description": "Cover picture URLs"
},
"location": {
"description": "Group location",
"type": "object",
"properties": {
"city": {
"type": "string",
"description": "City"
},
"country": {
"type": "string",
"description": "Country"
},
"country_code": {
"type": "string",
"description": "ISO3166-2 Country code"
},
"address": {
"type": "string",
"description": "Address"
},
"lat": {
"type": "number",
"format": "float",
"description": "Latitude"
},
"lng": {
"type": "number",
"format": "float",
"description": "Longitude"
}
}
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Group creation date - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Group update date - iso8601"
}
},
"description": "Group model"
}Validations Failed
Schema
{
"type": "object",
"properties": {
"status": {
"type": "integer",
"format": "int32",
"description": "Status Code"
},
"errors": {
"type": "string",
"description": "Errors list"
}
},
"description": "Error model"
}Update GroupPUT/api/admin/v2/topics/{id}
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.
URI Parameters
- id
number(required)
DELETE /api/admin/v2/topics/id
Responses
Delete Group
Delete GroupDELETE/api/admin/v2/topics/{id}
Remove one of your Group
URI Parameters
- id
number(required)
companies ¶
Operations about companies
GET /api/admin/v1/companies?page=&per_page=&updated_since=&order=&full_profile=
Responses
Get all companies
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"name": {
"type": "string",
"description": "Company full name"
}
},
"description": "CompanyCompact model"
}Get all companiesGET/api/admin/v1/companies{?page,per_page,updated_since,order,full_profile}
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"
}URI Parameters
- page
string(required)Page of results to fetch.
- per_page
string(required)Number of results to return per page.
- updated_since
string(required)- order
string(required)- full_profile
string(required)
POST /api/admin/v1/companies
Requests
Body
{
"company[name]": "Hello, world!",
"company[postal_location][address_1]": "Hello, world!",
"company[postal_location][address_2]": "Hello, world!",
"company[postal_location][address_3]": "Hello, world!",
"company[postal_location][city]": "Hello, world!",
"company[postal_location][state]": "Hello, world!",
"company[postal_location][full_name]": "Hello, world!",
"company[postal_location][postal_code]": "Hello, world!",
"company[postal_location][country]": "Hello, world!",
"company[postal_location][created_at]": "Hello, world!",
"company[postal_location][updated_at]": "Hello, world!",
"company[billing_location][address_1]": "Hello, world!",
"company[billing_location][address_2]": "Hello, world!",
"company[billing_location][address_3]": "Hello, world!",
"company[billing_location][city]": "Hello, world!",
"company[billing_location][state]": "Hello, world!",
"company[billing_location][full_name]": "Hello, world!",
"company[billing_location][postal_code]": "Hello, world!",
"company[billing_location][country]": "Hello, world!",
"company[billing_location][created_at]": "Hello, world!",
"company[billing_location][updated_at]": "Hello, world!",
"company[industries][][id]": [
1
],
"company[logo]": "Hello, world!",
"company[corporate_name]": "Hello, world!",
"company[company_identifier]": "Hello, world!",
"company[group_name]": "Hello, world!",
"company[company_number]": "Hello, world!",
"company[juridiction]": "Hello, world!",
"company[siret_nb]": "Hello, world!",
"company[siren_nb]": "Hello, world!",
"company[website_url]": "Hello, world!",
"company[blog_rss_url]": "Hello, world!",
"company[twitter_id]": "Hello, world!",
"company[facebook_id]": "Hello, world!",
"company[contact_info_phone1]": "Hello, world!",
"company[contact_info_phone2]": "Hello, world!",
"company[contact_info_fax]": "Hello, world!",
"company[short_description]": "Hello, world!",
"company[long_description]": "Hello, world!",
"company[founded_year]": "Hello, world!",
"company[video_url]": "Hello, world!",
"company[angel_list_url]": "Hello, world!",
"company[linkedin_url]": "Hello, world!",
"company[linkedin_id]": "Hello, world!",
"company[admin_comment]": "Hello, world!",
"company[annual_revenue]": "Hello, world!",
"company[external_job_board]": "Hello, world!",
"company[status]": "Hello, world!",
"company[activity_status]": "Hello, world!",
"company[code_naf]": "Hello, world!",
"company[email]": "Hello, world!",
"company[do_not_contact]": true,
"company[code_ape_id]": "Hello, world!",
"company[xing_url]": "Hello, world!",
"company[xing_id]": "Hello, world!",
"company[created_at]": "Hello, world!",
"company[updated_at]": "Hello, world!",
"company[external_id]": "Hello, world!",
"company[employee_count_range]": "Hello, world!"
}Schema
{
"type": "object",
"properties": {
"company[name]": {
"type": "string",
"description": "Company name"
},
"company[postal_location][address_1]": {
"type": "string",
"description": "Address line 1"
},
"company[postal_location][address_2]": {
"type": "string",
"description": "Address line 2"
},
"company[postal_location][address_3]": {
"type": "string",
"description": "Address line 3"
},
"company[postal_location][city]": {
"type": "string",
"description": "City"
},
"company[postal_location][state]": {
"type": "string",
"description": "State"
},
"company[postal_location][full_name]": {
"type": "string",
"description": "Full name"
},
"company[postal_location][postal_code]": {
"type": "string",
"description": "Zip code"
},
"company[postal_location][country]": {
"type": "string",
"description": "Country"
},
"company[postal_location][created_at]": {
"type": "string",
"description": "Postal address creation date time - iso8601"
},
"company[postal_location][updated_at]": {
"type": "string",
"description": "Postal address last update date time - iso8601"
},
"company[billing_location][address_1]": {
"type": "string",
"description": "Address line 1"
},
"company[billing_location][address_2]": {
"type": "string",
"description": "Address line 2"
},
"company[billing_location][address_3]": {
"type": "string",
"description": "Address line 3"
},
"company[billing_location][city]": {
"type": "string",
"description": "City"
},
"company[billing_location][state]": {
"type": "string",
"description": "State"
},
"company[billing_location][full_name]": {
"type": "string",
"description": "Full name"
},
"company[billing_location][postal_code]": {
"type": "string",
"description": "Zip code"
},
"company[billing_location][country]": {
"type": "string",
"description": "Country"
},
"company[billing_location][created_at]": {
"type": "string",
"description": "Postal address creation date time - iso8601"
},
"company[billing_location][updated_at]": {
"type": "string",
"description": "Postal address last update date time - iso8601"
},
"company[industries][][id]": {
"type": "array",
"items": {
"type": "number"
}
},
"company[logo]": {
"type": "string",
"description": "Company logo image"
},
"company[corporate_name]": {
"type": "string",
"description": "Company corporate name"
},
"company[company_identifier]": {
"type": "string",
"description": "Company identifier"
},
"company[group_name]": {
"type": "string",
"description": "Company group name"
},
"company[company_number]": {
"type": "string",
"description": "Company number"
},
"company[juridiction]": {
"type": "string",
"description": "Company juridiction (Country Code)"
},
"company[siret_nb]": {
"type": "string",
"description": "Company siret number"
},
"company[siren_nb]": {
"type": "string",
"description": "Company siren number"
},
"company[website_url]": {
"type": "string",
"description": "Company website url"
},
"company[blog_rss_url]": {
"type": "string",
"description": "Company blog rss url"
},
"company[twitter_id]": {
"type": "string",
"description": "Company twitter account"
},
"company[facebook_id]": {
"type": "string",
"description": "Company facebook account"
},
"company[contact_info_phone1]": {
"type": "string",
"description": "Contact info phone number 1"
},
"company[contact_info_phone2]": {
"type": "string",
"description": "Contact info phone number 2"
},
"company[contact_info_fax]": {
"type": "string",
"description": "Contact info fax number"
},
"company[short_description]": {
"type": "string",
"description": "Company short description"
},
"company[long_description]": {
"type": "string",
"description": "Company long description"
},
"company[founded_year]": {
"type": "string",
"description": "Company founded year"
},
"company[video_url]": {
"type": "string",
"description": "Company videdo url"
},
"company[angel_list_url]": {
"type": "string",
"description": "Company angel list url"
},
"company[linkedin_url]": {
"type": "string",
"description": "Company linkedin url"
},
"company[linkedin_id]": {
"type": "string",
"description": "Company linkedin id"
},
"company[admin_comment]": {
"type": "string",
"description": "Admin comment"
},
"company[annual_revenue]": {
"type": "string",
"description": "Company annual revenue"
},
"company[external_job_board]": {
"type": "string",
"description": "Company external job board"
},
"company[status]": {
"type": "string",
"description": "Company status: draft: 0, checked: 1"
},
"company[activity_status]": {
"type": "string",
"description": "Company activity status: active: 0, ceased: 1"
},
"company[code_naf]": {
"type": "string",
"description": "Company code NAF"
},
"company[email]": {
"type": "string",
"description": "Contact email"
},
"company[do_not_contact]": {
"type": "boolean",
"description": "Do not contact ?"
},
"company[code_ape_id]": {
"type": "string",
"description": "Company code APE ID"
},
"company[xing_url]": {
"type": "string",
"description": "Company Xing url"
},
"company[xing_id]": {
"type": "string",
"description": "Company Xing account"
},
"company[created_at]": {
"type": "string",
"description": "Company creation date time - iso8601"
},
"company[updated_at]": {
"type": "string",
"description": "Company last update date time - iso8601"
},
"company[external_id]": {
"type": "string",
"description": "Company external identifier"
},
"company[employee_count_range]": {
"type": "string",
"description": "Company number of employees"
}
},
"required": [
"company[name]",
"company[industries][][id]"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Add a new company
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"name": {
"type": "string",
"description": "Company full name"
},
"corporate_name": {
"type": "string",
"description": "Company corporate name"
},
"company_identifier": {
"type": "string",
"description": "Company identifier"
},
"group_name": {
"type": "string",
"description": "Company group name"
},
"company_number": {
"type": "string",
"description": "Company number"
},
"juridiction": {
"type": "string",
"description": "Company juridiction (Country Code)"
},
"siret_nb": {
"type": "string",
"description": "Company siret number"
},
"siren_nb": {
"type": "string",
"description": "Company siren number"
},
"website_url": {
"type": "string",
"description": "Company website url"
},
"blog_rss_url": {
"type": "string",
"description": "Company blog rss url"
},
"twitter_id": {
"type": "string",
"description": "Company twitter account"
},
"facebook_id": {
"type": "string",
"description": "Company facebook account"
},
"contact_info_phone1": {
"type": "string",
"description": "Contact info phone number 1"
},
"contact_info_phone2": {
"type": "string",
"description": "Contact info phone number 2"
},
"contact_info_fax": {
"type": "string",
"description": "Contact info fax number"
},
"short_description": {
"type": "string",
"description": "Company short description"
},
"long_description": {
"type": "string",
"description": "Company long description"
},
"founded_year": {
"type": "string",
"description": "Company founded year"
},
"video_url": {
"type": "string",
"description": "Company videdo url"
},
"angel_list_url": {
"type": "string",
"description": "Company angel list url"
},
"linkedin_url": {
"type": "string",
"description": "Company linkedin url"
},
"linkedin_id": {
"type": "string",
"description": "Company linkedin id"
},
"admin_comment": {
"type": "string",
"description": "Admin comment"
},
"annual_revenue": {
"type": "string",
"description": "Company annual revenue"
},
"external_job_board": {
"type": "string",
"description": "Company external job board"
},
"status": {
"type": "string",
"description": "Company status: draft: 0, checked: 1"
},
"activity_status": {
"type": "string",
"description": "Company activity status: active: 0, ceased: 1"
},
"code_naf": {
"type": "string",
"description": "Company code NAF"
},
"email": {
"type": "string",
"description": "Contact email"
},
"do_not_contact": {
"type": "boolean",
"description": "Do not contact ?"
},
"code_ape_id": {
"type": "string",
"description": "Company code APE ID"
},
"xing_url": {
"type": "string",
"description": "Company Xing url"
},
"xing_id": {
"type": "string",
"description": "Company Xing account"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Company creation date time - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Company last update date time - iso8601"
},
"external_id": {
"type": "string",
"description": "Company external identifier"
},
"employee_count_range": {
"type": "string",
"enum": [
"1",
"2-10",
"11-50",
"51-200",
"201-500",
"501-1000",
"1001-5000",
"5001-10000",
"10000+"
],
"description": "Company number of employees"
},
"industries": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"name": {
"type": "string",
"description": "Industry name"
}
},
"description": "IndustryStudy model"
},
"description": "Company industries"
},
"postal_location": {
"description": "Company postal address",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"address_1": {
"type": "string",
"description": "Address line 1"
},
"address_2": {
"type": "string",
"description": "Address line 2"
},
"address_3": {
"type": "string",
"description": "Address line 3"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "State"
},
"full_name": {
"type": "string",
"description": "Full name"
},
"postal_code": {
"type": "string",
"description": "Zip code"
},
"country": {
"type": "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"
],
"description": "Country"
},
"default_billing_address": {
"type": "boolean",
"description": "is the default billing address for the user ?"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Postal address creation date time - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Postal address last update date time - iso8601"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "User ID linked to postal address"
}
}
},
"billing_location": {
"description": "Company billing address",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"address_1": {
"type": "string",
"description": "Address line 1"
},
"address_2": {
"type": "string",
"description": "Address line 2"
},
"address_3": {
"type": "string",
"description": "Address line 3"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "State"
},
"full_name": {
"type": "string",
"description": "Full name"
},
"postal_code": {
"type": "string",
"description": "Zip code"
},
"country": {
"type": "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"
],
"description": "Country"
},
"default_billing_address": {
"type": "boolean",
"description": "is the default billing address for the user ?"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Postal address creation date time - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Postal address last update date time - iso8601"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "User ID linked to postal address"
}
}
},
"logo": {
"type": "string",
"description": "Company logo url"
}
},
"description": "Companies::Company model"
}Validations Failed
Schema
{
"type": "object",
"properties": {
"status": {
"type": "integer",
"format": "int32",
"description": "Status Code"
},
"errors": {
"type": "string",
"description": "Errors list"
}
},
"description": "Error model"
}Add a new companyPOST/api/admin/v1/companies
Return the created company.
GET /api/admin/v1/companies/id?key=
Responses
Get company profile
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"name": {
"type": "string",
"description": "Company full name"
},
"corporate_name": {
"type": "string",
"description": "Company corporate name"
},
"company_identifier": {
"type": "string",
"description": "Company identifier"
},
"group_name": {
"type": "string",
"description": "Company group name"
},
"company_number": {
"type": "string",
"description": "Company number"
},
"juridiction": {
"type": "string",
"description": "Company juridiction (Country Code)"
},
"siret_nb": {
"type": "string",
"description": "Company siret number"
},
"siren_nb": {
"type": "string",
"description": "Company siren number"
},
"website_url": {
"type": "string",
"description": "Company website url"
},
"blog_rss_url": {
"type": "string",
"description": "Company blog rss url"
},
"twitter_id": {
"type": "string",
"description": "Company twitter account"
},
"facebook_id": {
"type": "string",
"description": "Company facebook account"
},
"contact_info_phone1": {
"type": "string",
"description": "Contact info phone number 1"
},
"contact_info_phone2": {
"type": "string",
"description": "Contact info phone number 2"
},
"contact_info_fax": {
"type": "string",
"description": "Contact info fax number"
},
"short_description": {
"type": "string",
"description": "Company short description"
},
"long_description": {
"type": "string",
"description": "Company long description"
},
"founded_year": {
"type": "string",
"description": "Company founded year"
},
"video_url": {
"type": "string",
"description": "Company videdo url"
},
"angel_list_url": {
"type": "string",
"description": "Company angel list url"
},
"linkedin_url": {
"type": "string",
"description": "Company linkedin url"
},
"linkedin_id": {
"type": "string",
"description": "Company linkedin id"
},
"admin_comment": {
"type": "string",
"description": "Admin comment"
},
"annual_revenue": {
"type": "string",
"description": "Company annual revenue"
},
"external_job_board": {
"type": "string",
"description": "Company external job board"
},
"status": {
"type": "string",
"description": "Company status: draft: 0, checked: 1"
},
"activity_status": {
"type": "string",
"description": "Company activity status: active: 0, ceased: 1"
},
"code_naf": {
"type": "string",
"description": "Company code NAF"
},
"email": {
"type": "string",
"description": "Contact email"
},
"do_not_contact": {
"type": "boolean",
"description": "Do not contact ?"
},
"code_ape_id": {
"type": "string",
"description": "Company code APE ID"
},
"xing_url": {
"type": "string",
"description": "Company Xing url"
},
"xing_id": {
"type": "string",
"description": "Company Xing account"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Company creation date time - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Company last update date time - iso8601"
},
"external_id": {
"type": "string",
"description": "Company external identifier"
},
"employee_count_range": {
"type": "string",
"enum": [
"1",
"2-10",
"11-50",
"51-200",
"201-500",
"501-1000",
"1001-5000",
"5001-10000",
"10000+"
],
"description": "Company number of employees"
},
"industries": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"name": {
"type": "string",
"description": "Industry name"
}
},
"description": "IndustryStudy model"
},
"description": "Company industries"
},
"postal_location": {
"description": "Company postal address",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"address_1": {
"type": "string",
"description": "Address line 1"
},
"address_2": {
"type": "string",
"description": "Address line 2"
},
"address_3": {
"type": "string",
"description": "Address line 3"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "State"
},
"full_name": {
"type": "string",
"description": "Full name"
},
"postal_code": {
"type": "string",
"description": "Zip code"
},
"country": {
"type": "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"
],
"description": "Country"
},
"default_billing_address": {
"type": "boolean",
"description": "is the default billing address for the user ?"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Postal address creation date time - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Postal address last update date time - iso8601"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "User ID linked to postal address"
}
}
},
"billing_location": {
"description": "Company billing address",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"address_1": {
"type": "string",
"description": "Address line 1"
},
"address_2": {
"type": "string",
"description": "Address line 2"
},
"address_3": {
"type": "string",
"description": "Address line 3"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "State"
},
"full_name": {
"type": "string",
"description": "Full name"
},
"postal_code": {
"type": "string",
"description": "Zip code"
},
"country": {
"type": "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"
],
"description": "Country"
},
"default_billing_address": {
"type": "boolean",
"description": "is the default billing address for the user ?"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Postal address creation date time - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Postal address last update date time - iso8601"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "User ID linked to postal address"
}
}
},
"logo": {
"type": "string",
"description": "Company logo url"
}
},
"description": "Companies::Company model"
}Get company profileGET/api/admin/v1/companies/{id}{?key}
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.
URI Parameters
- id
string(required)- key
string(required)
PUT /api/admin/v1/companies/id
Requests
Body
{
"key": "Hello, world!",
"company[postal_location][address_1]": "Hello, world!",
"company[postal_location][address_2]": "Hello, world!",
"company[postal_location][address_3]": "Hello, world!",
"company[postal_location][city]": "Hello, world!",
"company[postal_location][state]": "Hello, world!",
"company[postal_location][full_name]": "Hello, world!",
"company[postal_location][postal_code]": "Hello, world!",
"company[postal_location][country]": "Hello, world!",
"company[postal_location][created_at]": "Hello, world!",
"company[postal_location][updated_at]": "Hello, world!",
"company[billing_location][address_1]": "Hello, world!",
"company[billing_location][address_2]": "Hello, world!",
"company[billing_location][address_3]": "Hello, world!",
"company[billing_location][city]": "Hello, world!",
"company[billing_location][state]": "Hello, world!",
"company[billing_location][full_name]": "Hello, world!",
"company[billing_location][postal_code]": "Hello, world!",
"company[billing_location][country]": "Hello, world!",
"company[billing_location][created_at]": "Hello, world!",
"company[billing_location][updated_at]": "Hello, world!",
"company[industries][][id]": [
1
],
"company[logo]": "Hello, world!",
"company[name]": "Hello, world!",
"company[corporate_name]": "Hello, world!",
"company[company_identifier]": "Hello, world!",
"company[group_name]": "Hello, world!",
"company[company_number]": "Hello, world!",
"company[juridiction]": "Hello, world!",
"company[siret_nb]": "Hello, world!",
"company[siren_nb]": "Hello, world!",
"company[website_url]": "Hello, world!",
"company[blog_rss_url]": "Hello, world!",
"company[twitter_id]": "Hello, world!",
"company[facebook_id]": "Hello, world!",
"company[contact_info_phone1]": "Hello, world!",
"company[contact_info_phone2]": "Hello, world!",
"company[contact_info_fax]": "Hello, world!",
"company[short_description]": "Hello, world!",
"company[long_description]": "Hello, world!",
"company[founded_year]": "Hello, world!",
"company[video_url]": "Hello, world!",
"company[angel_list_url]": "Hello, world!",
"company[linkedin_url]": "Hello, world!",
"company[linkedin_id]": "Hello, world!",
"company[admin_comment]": "Hello, world!",
"company[annual_revenue]": "Hello, world!",
"company[external_job_board]": "Hello, world!",
"company[status]": "Hello, world!",
"company[activity_status]": "Hello, world!",
"company[code_naf]": "Hello, world!",
"company[email]": "Hello, world!",
"company[do_not_contact]": true,
"company[code_ape_id]": "Hello, world!",
"company[xing_url]": "Hello, world!",
"company[xing_id]": "Hello, world!",
"company[created_at]": "Hello, world!",
"company[updated_at]": "Hello, world!",
"company[external_id]": "Hello, world!",
"company[employee_count_range]": "Hello, world!"
}Schema
{
"type": "object",
"properties": {
"key": {
"type": "string"
},
"company[postal_location][address_1]": {
"type": "string",
"description": "Address line 1"
},
"company[postal_location][address_2]": {
"type": "string",
"description": "Address line 2"
},
"company[postal_location][address_3]": {
"type": "string",
"description": "Address line 3"
},
"company[postal_location][city]": {
"type": "string",
"description": "City"
},
"company[postal_location][state]": {
"type": "string",
"description": "State"
},
"company[postal_location][full_name]": {
"type": "string",
"description": "Full name"
},
"company[postal_location][postal_code]": {
"type": "string",
"description": "Zip code"
},
"company[postal_location][country]": {
"type": "string",
"description": "Country"
},
"company[postal_location][created_at]": {
"type": "string",
"description": "Postal address creation date time - iso8601"
},
"company[postal_location][updated_at]": {
"type": "string",
"description": "Postal address last update date time - iso8601"
},
"company[billing_location][address_1]": {
"type": "string",
"description": "Address line 1"
},
"company[billing_location][address_2]": {
"type": "string",
"description": "Address line 2"
},
"company[billing_location][address_3]": {
"type": "string",
"description": "Address line 3"
},
"company[billing_location][city]": {
"type": "string",
"description": "City"
},
"company[billing_location][state]": {
"type": "string",
"description": "State"
},
"company[billing_location][full_name]": {
"type": "string",
"description": "Full name"
},
"company[billing_location][postal_code]": {
"type": "string",
"description": "Zip code"
},
"company[billing_location][country]": {
"type": "string",
"description": "Country"
},
"company[billing_location][created_at]": {
"type": "string",
"description": "Postal address creation date time - iso8601"
},
"company[billing_location][updated_at]": {
"type": "string",
"description": "Postal address last update date time - iso8601"
},
"company[industries][][id]": {
"type": "array",
"items": {
"type": "number"
}
},
"company[logo]": {
"type": "string",
"description": "Company logo image"
},
"company[name]": {
"type": "string",
"description": "Company full name"
},
"company[corporate_name]": {
"type": "string",
"description": "Company corporate name"
},
"company[company_identifier]": {
"type": "string",
"description": "Company identifier"
},
"company[group_name]": {
"type": "string",
"description": "Company group name"
},
"company[company_number]": {
"type": "string",
"description": "Company number"
},
"company[juridiction]": {
"type": "string",
"description": "Company juridiction (Country Code)"
},
"company[siret_nb]": {
"type": "string",
"description": "Company siret number"
},
"company[siren_nb]": {
"type": "string",
"description": "Company siren number"
},
"company[website_url]": {
"type": "string",
"description": "Company website url"
},
"company[blog_rss_url]": {
"type": "string",
"description": "Company blog rss url"
},
"company[twitter_id]": {
"type": "string",
"description": "Company twitter account"
},
"company[facebook_id]": {
"type": "string",
"description": "Company facebook account"
},
"company[contact_info_phone1]": {
"type": "string",
"description": "Contact info phone number 1"
},
"company[contact_info_phone2]": {
"type": "string",
"description": "Contact info phone number 2"
},
"company[contact_info_fax]": {
"type": "string",
"description": "Contact info fax number"
},
"company[short_description]": {
"type": "string",
"description": "Company short description"
},
"company[long_description]": {
"type": "string",
"description": "Company long description"
},
"company[founded_year]": {
"type": "string",
"description": "Company founded year"
},
"company[video_url]": {
"type": "string",
"description": "Company videdo url"
},
"company[angel_list_url]": {
"type": "string",
"description": "Company angel list url"
},
"company[linkedin_url]": {
"type": "string",
"description": "Company linkedin url"
},
"company[linkedin_id]": {
"type": "string",
"description": "Company linkedin id"
},
"company[admin_comment]": {
"type": "string",
"description": "Admin comment"
},
"company[annual_revenue]": {
"type": "string",
"description": "Company annual revenue"
},
"company[external_job_board]": {
"type": "string",
"description": "Company external job board"
},
"company[status]": {
"type": "string",
"description": "Company status: draft: 0, checked: 1"
},
"company[activity_status]": {
"type": "string",
"description": "Company activity status: active: 0, ceased: 1"
},
"company[code_naf]": {
"type": "string",
"description": "Company code NAF"
},
"company[email]": {
"type": "string",
"description": "Contact email"
},
"company[do_not_contact]": {
"type": "boolean",
"description": "Do not contact ?"
},
"company[code_ape_id]": {
"type": "string",
"description": "Company code APE ID"
},
"company[xing_url]": {
"type": "string",
"description": "Company Xing url"
},
"company[xing_id]": {
"type": "string",
"description": "Company Xing account"
},
"company[created_at]": {
"type": "string",
"description": "Company creation date time - iso8601"
},
"company[updated_at]": {
"type": "string",
"description": "Company last update date time - iso8601"
},
"company[external_id]": {
"type": "string",
"description": "Company external identifier"
},
"company[employee_count_range]": {
"type": "string",
"description": "Company number of employees"
}
},
"required": [
"company[industries][][id]"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Update existing company
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"name": {
"type": "string",
"description": "Company full name"
},
"corporate_name": {
"type": "string",
"description": "Company corporate name"
},
"company_identifier": {
"type": "string",
"description": "Company identifier"
},
"group_name": {
"type": "string",
"description": "Company group name"
},
"company_number": {
"type": "string",
"description": "Company number"
},
"juridiction": {
"type": "string",
"description": "Company juridiction (Country Code)"
},
"siret_nb": {
"type": "string",
"description": "Company siret number"
},
"siren_nb": {
"type": "string",
"description": "Company siren number"
},
"website_url": {
"type": "string",
"description": "Company website url"
},
"blog_rss_url": {
"type": "string",
"description": "Company blog rss url"
},
"twitter_id": {
"type": "string",
"description": "Company twitter account"
},
"facebook_id": {
"type": "string",
"description": "Company facebook account"
},
"contact_info_phone1": {
"type": "string",
"description": "Contact info phone number 1"
},
"contact_info_phone2": {
"type": "string",
"description": "Contact info phone number 2"
},
"contact_info_fax": {
"type": "string",
"description": "Contact info fax number"
},
"short_description": {
"type": "string",
"description": "Company short description"
},
"long_description": {
"type": "string",
"description": "Company long description"
},
"founded_year": {
"type": "string",
"description": "Company founded year"
},
"video_url": {
"type": "string",
"description": "Company videdo url"
},
"angel_list_url": {
"type": "string",
"description": "Company angel list url"
},
"linkedin_url": {
"type": "string",
"description": "Company linkedin url"
},
"linkedin_id": {
"type": "string",
"description": "Company linkedin id"
},
"admin_comment": {
"type": "string",
"description": "Admin comment"
},
"annual_revenue": {
"type": "string",
"description": "Company annual revenue"
},
"external_job_board": {
"type": "string",
"description": "Company external job board"
},
"status": {
"type": "string",
"description": "Company status: draft: 0, checked: 1"
},
"activity_status": {
"type": "string",
"description": "Company activity status: active: 0, ceased: 1"
},
"code_naf": {
"type": "string",
"description": "Company code NAF"
},
"email": {
"type": "string",
"description": "Contact email"
},
"do_not_contact": {
"type": "boolean",
"description": "Do not contact ?"
},
"code_ape_id": {
"type": "string",
"description": "Company code APE ID"
},
"xing_url": {
"type": "string",
"description": "Company Xing url"
},
"xing_id": {
"type": "string",
"description": "Company Xing account"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Company creation date time - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Company last update date time - iso8601"
},
"external_id": {
"type": "string",
"description": "Company external identifier"
},
"employee_count_range": {
"type": "string",
"enum": [
"1",
"2-10",
"11-50",
"51-200",
"201-500",
"501-1000",
"1001-5000",
"5001-10000",
"10000+"
],
"description": "Company number of employees"
},
"industries": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"name": {
"type": "string",
"description": "Industry name"
}
},
"description": "IndustryStudy model"
},
"description": "Company industries"
},
"postal_location": {
"description": "Company postal address",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"address_1": {
"type": "string",
"description": "Address line 1"
},
"address_2": {
"type": "string",
"description": "Address line 2"
},
"address_3": {
"type": "string",
"description": "Address line 3"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "State"
},
"full_name": {
"type": "string",
"description": "Full name"
},
"postal_code": {
"type": "string",
"description": "Zip code"
},
"country": {
"type": "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"
],
"description": "Country"
},
"default_billing_address": {
"type": "boolean",
"description": "is the default billing address for the user ?"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Postal address creation date time - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Postal address last update date time - iso8601"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "User ID linked to postal address"
}
}
},
"billing_location": {
"description": "Company billing address",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"address_1": {
"type": "string",
"description": "Address line 1"
},
"address_2": {
"type": "string",
"description": "Address line 2"
},
"address_3": {
"type": "string",
"description": "Address line 3"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "State"
},
"full_name": {
"type": "string",
"description": "Full name"
},
"postal_code": {
"type": "string",
"description": "Zip code"
},
"country": {
"type": "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"
],
"description": "Country"
},
"default_billing_address": {
"type": "boolean",
"description": "is the default billing address for the user ?"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Postal address creation date time - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Postal address last update date time - iso8601"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "User ID linked to postal address"
}
}
},
"logo": {
"type": "string",
"description": "Company logo url"
}
},
"description": "Companies::Company model"
}Validations Failed
Schema
{
"type": "object",
"properties": {
"status": {
"type": "integer",
"format": "int32",
"description": "Status Code"
},
"errors": {
"type": "string",
"description": "Errors list"
}
},
"description": "Error model"
}Update existing companyPUT/api/admin/v1/companies/{id}
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.
URI Parameters
- id
string(required)Company ID
DELETE /api/admin/v1/companies/id?key=
Responses
Delete company
Delete companyDELETE/api/admin/v1/companies/{id}{?key}
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.
URI Parameters
- id
string(required)- key
string(required)
news ¶
Operations about news
GET /api/admin/v1/news/categories
Responses
Get News Categories
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"name": {
"type": "string",
"description": "Name of the category"
}
},
"description": "NetworkCategoryCompact model"
}Get News CategoriesGET/api/admin/v1/news/categories
Return this network News Categories.
GET /api/admin/v1/news?page=&per_page=
Responses
Get all news posts
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "News post creation date"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "News post last update date"
},
"subject": {
"type": "string",
"description": "Title of the news post"
},
"published_at": {
"type": "string",
"format": "date-time",
"description": "News post publication date"
},
"feedable_at": {
"type": "string",
"format": "date-time",
"description": "News post feedable date (if scheduled for later)"
},
"content": {
"type": "string",
"description": "Content of the News post"
},
"published": {
"type": "boolean",
"description": "Is the News post published ?"
},
"public": {
"type": "boolean",
"description": "Is the News post public ?"
},
"visible_on_index_page": {
"type": "boolean",
"description": "Is the News post visible in the index page ?"
},
"visible_on_feed": {
"type": "boolean",
"description": "Is the News post visible in the live feed ?"
},
"pinned": {
"type": "boolean",
"description": "Is the News post pinned in the feed ?"
},
"seo_title": {
"type": "string",
"description": "SEO Customization of the news post"
},
"seo_description": {
"type": "string",
"description": "SEO Customization of the news post"
},
"canonical_url": {
"type": "string",
"description": "Canonical URL of the news post"
},
"network_category_ids": {
"type": "integer",
"format": "int32",
"description": "Network categories linked to the news post"
},
"topic_ids": {
"type": "integer",
"format": "int32",
"description": "Topics linked to the news post"
},
"network_event_ids": {
"type": "integer",
"format": "int32",
"description": "Events linked to the news post"
},
"publish_on_network": {
"type": "boolean",
"description": "If the news is linked to a topic: is it also published for the network ?"
},
"cover_picture": {
"type": "object",
"properties": {
"default-url": {
"type": "string"
},
"small-url": {
"type": "string"
},
"medium-url": {
"type": "string"
}
},
"description": "URLs of the Cover Picture"
}
},
"description": "NewsPost model"
}Get all news postsGET/api/admin/v1/news{?page,per_page}
Return an array of newst 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"
}URI Parameters
- page
string(required)Page of results to fetch.
- per_page
string(required)Number of results to return per page.
POST /api/admin/v1/news
Requests
Body
{
"locale": "Hello, world!",
"news_post[subject]": "Hello, world!",
"news_post[content]": "Hello, world!",
"news_post[created_at]": "Hello, world!",
"news_post[updated_at]": "Hello, world!",
"news_post[published_at]": "Hello, world!",
"news_post[feedable_at]": "Hello, world!",
"news_post[published]": true,
"news_post[public]": true,
"news_post[visible_on_index_page]": true,
"news_post[visible_on_feed]": true,
"news_post[pinned]": true,
"news_post[seo_title]": "Hello, world!",
"news_post[seo_description]": "Hello, world!",
"news_post[canonical_url]": "Hello, world!",
"news_post[network_category_ids][]": [
1
],
"news_post[topic_ids][]": [
1
],
"news_post[network_event_ids][]": [
1
],
"news_post[publish_on_network]": true,
"news_post[cover_picture]": "Hello, world!"
}Schema
{
"type": "object",
"properties": {
"locale": {
"type": "string"
},
"news_post[subject]": {
"type": "string",
"description": "Title of the news"
},
"news_post[content]": {
"type": "string",
"description": "Content of the news"
},
"news_post[created_at]": {
"type": "string",
"description": "News post creation date"
},
"news_post[updated_at]": {
"type": "string",
"description": "News post last update date"
},
"news_post[published_at]": {
"type": "string",
"description": "News post publication date"
},
"news_post[feedable_at]": {
"type": "string",
"description": "News post feedable date (if scheduled for later)"
},
"news_post[published]": {
"type": "boolean",
"description": "Is the News post published ?"
},
"news_post[public]": {
"type": "boolean",
"description": "Is the News post public ?"
},
"news_post[visible_on_index_page]": {
"type": "boolean",
"description": "Is the News post visible in the index page ?"
},
"news_post[visible_on_feed]": {
"type": "boolean",
"description": "Is the News post visible in the live feed ?"
},
"news_post[pinned]": {
"type": "boolean",
"description": "Is the News post pinned in the feed ?"
},
"news_post[seo_title]": {
"type": "string",
"description": "SEO Customization of the news post"
},
"news_post[seo_description]": {
"type": "string",
"description": "SEO Customization of the news post"
},
"news_post[canonical_url]": {
"type": "string",
"description": "Canonical URL of the news post"
},
"news_post[network_category_ids][]": {
"type": "array",
"items": {
"type": "number"
},
"description": "Network categories linked to the news post"
},
"news_post[topic_ids][]": {
"type": "array",
"items": {
"type": "number"
},
"description": "Topics linked to the news post"
},
"news_post[network_event_ids][]": {
"type": "array",
"items": {
"type": "number"
},
"description": "Events linked to the news post"
},
"news_post[publish_on_network]": {
"type": "boolean",
"description": "If the news is linked to a topic: is it also published for the network ?"
},
"news_post[cover_picture]": {
"type": "string",
"description": "Cover picture of the News"
}
},
"required": [
"news_post[subject]",
"news_post[content]"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Add a new post
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "News post creation date"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "News post last update date"
},
"subject": {
"type": "string",
"description": "Title of the news post"
},
"published_at": {
"type": "string",
"format": "date-time",
"description": "News post publication date"
},
"feedable_at": {
"type": "string",
"format": "date-time",
"description": "News post feedable date (if scheduled for later)"
},
"content": {
"type": "string",
"description": "Content of the News post"
},
"published": {
"type": "boolean",
"description": "Is the News post published ?"
},
"public": {
"type": "boolean",
"description": "Is the News post public ?"
},
"visible_on_index_page": {
"type": "boolean",
"description": "Is the News post visible in the index page ?"
},
"visible_on_feed": {
"type": "boolean",
"description": "Is the News post visible in the live feed ?"
},
"pinned": {
"type": "boolean",
"description": "Is the News post pinned in the feed ?"
},
"seo_title": {
"type": "string",
"description": "SEO Customization of the news post"
},
"seo_description": {
"type": "string",
"description": "SEO Customization of the news post"
},
"canonical_url": {
"type": "string",
"description": "Canonical URL of the news post"
},
"network_category_ids": {
"type": "integer",
"format": "int32",
"description": "Network categories linked to the news post"
},
"topic_ids": {
"type": "integer",
"format": "int32",
"description": "Topics linked to the news post"
},
"network_event_ids": {
"type": "integer",
"format": "int32",
"description": "Events linked to the news post"
},
"publish_on_network": {
"type": "boolean",
"description": "If the news is linked to a topic: is it also published for the network ?"
},
"cover_picture": {
"type": "object",
"properties": {
"default-url": {
"type": "string"
},
"small-url": {
"type": "string"
},
"medium-url": {
"type": "string"
}
},
"description": "URLs of the Cover Picture"
}
},
"description": "NewsPost model"
}Validations Failed
Schema
{
"type": "object",
"properties": {
"status": {
"type": "integer",
"format": "int32",
"description": "Status Code"
},
"errors": {
"type": "string",
"description": "Errors list"
}
},
"description": "Error model"
}Add a new postPOST/api/admin/v1/news
Return the created post.
GET /api/admin/v1/news/id?locale=
Responses
Get news post
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "News post creation date"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "News post last update date"
},
"subject": {
"type": "string",
"description": "Title of the news post"
},
"published_at": {
"type": "string",
"format": "date-time",
"description": "News post publication date"
},
"feedable_at": {
"type": "string",
"format": "date-time",
"description": "News post feedable date (if scheduled for later)"
},
"content": {
"type": "string",
"description": "Content of the News post"
},
"published": {
"type": "boolean",
"description": "Is the News post published ?"
},
"public": {
"type": "boolean",
"description": "Is the News post public ?"
},
"visible_on_index_page": {
"type": "boolean",
"description": "Is the News post visible in the index page ?"
},
"visible_on_feed": {
"type": "boolean",
"description": "Is the News post visible in the live feed ?"
},
"pinned": {
"type": "boolean",
"description": "Is the News post pinned in the feed ?"
},
"seo_title": {
"type": "string",
"description": "SEO Customization of the news post"
},
"seo_description": {
"type": "string",
"description": "SEO Customization of the news post"
},
"canonical_url": {
"type": "string",
"description": "Canonical URL of the news post"
},
"network_category_ids": {
"type": "integer",
"format": "int32",
"description": "Network categories linked to the news post"
},
"topic_ids": {
"type": "integer",
"format": "int32",
"description": "Topics linked to the news post"
},
"network_event_ids": {
"type": "integer",
"format": "int32",
"description": "Events linked to the news post"
},
"publish_on_network": {
"type": "boolean",
"description": "If the news is linked to a topic: is it also published for the network ?"
},
"cover_picture": {
"type": "object",
"properties": {
"default-url": {
"type": "string"
},
"small-url": {
"type": "string"
},
"medium-url": {
"type": "string"
}
},
"description": "URLs of the Cover Picture"
}
},
"description": "NewsPost model"
}Get news postGET/api/admin/v1/news/{id}{?locale}
Return the news post based on its ID
URI Parameters
- id
string(required)- locale
string(required)
PUT /api/admin/v1/news/id
Requests
Body
{
"locale": "Hello, world!",
"news_post[created_at]": "Hello, world!",
"news_post[updated_at]": "Hello, world!",
"news_post[subject]": "Hello, world!",
"news_post[published_at]": "Hello, world!",
"news_post[feedable_at]": "Hello, world!",
"news_post[content]": "Hello, world!",
"news_post[published]": true,
"news_post[public]": true,
"news_post[visible_on_index_page]": true,
"news_post[visible_on_feed]": true,
"news_post[pinned]": true,
"news_post[seo_title]": "Hello, world!",
"news_post[seo_description]": "Hello, world!",
"news_post[canonical_url]": "Hello, world!",
"news_post[network_category_ids][]": [
1
],
"news_post[topic_ids][]": [
1
],
"news_post[network_event_ids][]": [
1
],
"news_post[publish_on_network]": true,
"news_post[cover_picture]": "Hello, world!"
}Schema
{
"type": "object",
"properties": {
"locale": {
"type": "string"
},
"news_post[created_at]": {
"type": "string",
"description": "News post creation date"
},
"news_post[updated_at]": {
"type": "string",
"description": "News post last update date"
},
"news_post[subject]": {
"type": "string",
"description": "Title of the news post"
},
"news_post[published_at]": {
"type": "string",
"description": "News post publication date"
},
"news_post[feedable_at]": {
"type": "string",
"description": "News post feedable date (if scheduled for later)"
},
"news_post[content]": {
"type": "string",
"description": "Content of the News post"
},
"news_post[published]": {
"type": "boolean",
"description": "Is the News post published ?"
},
"news_post[public]": {
"type": "boolean",
"description": "Is the News post public ?"
},
"news_post[visible_on_index_page]": {
"type": "boolean",
"description": "Is the News post visible in the index page ?"
},
"news_post[visible_on_feed]": {
"type": "boolean",
"description": "Is the News post visible in the live feed ?"
},
"news_post[pinned]": {
"type": "boolean",
"description": "Is the News post pinned in the feed ?"
},
"news_post[seo_title]": {
"type": "string",
"description": "SEO Customization of the news post"
},
"news_post[seo_description]": {
"type": "string",
"description": "SEO Customization of the news post"
},
"news_post[canonical_url]": {
"type": "string",
"description": "Canonical URL of the news post"
},
"news_post[network_category_ids][]": {
"type": "array",
"items": {
"type": "number"
},
"description": "Network categories linked to the news post"
},
"news_post[topic_ids][]": {
"type": "array",
"items": {
"type": "number"
},
"description": "Topics linked to the news post"
},
"news_post[network_event_ids][]": {
"type": "array",
"items": {
"type": "number"
},
"description": "Events linked to the news post"
},
"news_post[publish_on_network]": {
"type": "boolean",
"description": "If the news is linked to a topic: is it also published for the network ?"
},
"news_post[cover_picture]": {
"type": "string",
"description": "Cover picture of the Customizable page"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Update existing news post
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "News post creation date"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "News post last update date"
},
"subject": {
"type": "string",
"description": "Title of the news post"
},
"published_at": {
"type": "string",
"format": "date-time",
"description": "News post publication date"
},
"feedable_at": {
"type": "string",
"format": "date-time",
"description": "News post feedable date (if scheduled for later)"
},
"content": {
"type": "string",
"description": "Content of the News post"
},
"published": {
"type": "boolean",
"description": "Is the News post published ?"
},
"public": {
"type": "boolean",
"description": "Is the News post public ?"
},
"visible_on_index_page": {
"type": "boolean",
"description": "Is the News post visible in the index page ?"
},
"visible_on_feed": {
"type": "boolean",
"description": "Is the News post visible in the live feed ?"
},
"pinned": {
"type": "boolean",
"description": "Is the News post pinned in the feed ?"
},
"seo_title": {
"type": "string",
"description": "SEO Customization of the news post"
},
"seo_description": {
"type": "string",
"description": "SEO Customization of the news post"
},
"canonical_url": {
"type": "string",
"description": "Canonical URL of the news post"
},
"network_category_ids": {
"type": "integer",
"format": "int32",
"description": "Network categories linked to the news post"
},
"topic_ids": {
"type": "integer",
"format": "int32",
"description": "Topics linked to the news post"
},
"network_event_ids": {
"type": "integer",
"format": "int32",
"description": "Events linked to the news post"
},
"publish_on_network": {
"type": "boolean",
"description": "If the news is linked to a topic: is it also published for the network ?"
},
"cover_picture": {
"type": "object",
"properties": {
"default-url": {
"type": "string"
},
"small-url": {
"type": "string"
},
"medium-url": {
"type": "string"
}
},
"description": "URLs of the Cover Picture"
}
},
"description": "NewsPost model"
}Validations Failed
Schema
{
"type": "object",
"properties": {
"status": {
"type": "integer",
"format": "int32",
"description": "Status Code"
},
"errors": {
"type": "string",
"description": "Errors list"
}
},
"description": "Error model"
}Update existing news postPUT/api/admin/v1/news/{id}
Return the updated news post profile based on its ID
URI Parameters
- id
string(required)
DELETE /api/admin/v1/news/id
Responses
Delete news post
Delete news postDELETE/api/admin/v1/news/{id}
Delete the news post based on its ID
URI Parameters
- id
string(required)
POST /api/admin/v1/news/id/duplicate
Responses
Duplicate new post
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "News post creation date"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "News post last update date"
},
"subject": {
"type": "string",
"description": "Title of the news post"
},
"published_at": {
"type": "string",
"format": "date-time",
"description": "News post publication date"
},
"feedable_at": {
"type": "string",
"format": "date-time",
"description": "News post feedable date (if scheduled for later)"
},
"content": {
"type": "string",
"description": "Content of the News post"
},
"published": {
"type": "boolean",
"description": "Is the News post published ?"
},
"public": {
"type": "boolean",
"description": "Is the News post public ?"
},
"visible_on_index_page": {
"type": "boolean",
"description": "Is the News post visible in the index page ?"
},
"visible_on_feed": {
"type": "boolean",
"description": "Is the News post visible in the live feed ?"
},
"pinned": {
"type": "boolean",
"description": "Is the News post pinned in the feed ?"
},
"seo_title": {
"type": "string",
"description": "SEO Customization of the news post"
},
"seo_description": {
"type": "string",
"description": "SEO Customization of the news post"
},
"canonical_url": {
"type": "string",
"description": "Canonical URL of the news post"
},
"network_category_ids": {
"type": "integer",
"format": "int32",
"description": "Network categories linked to the news post"
},
"topic_ids": {
"type": "integer",
"format": "int32",
"description": "Topics linked to the news post"
},
"network_event_ids": {
"type": "integer",
"format": "int32",
"description": "Events linked to the news post"
},
"publish_on_network": {
"type": "boolean",
"description": "If the news is linked to a topic: is it also published for the network ?"
},
"cover_picture": {
"type": "object",
"properties": {
"default-url": {
"type": "string"
},
"small-url": {
"type": "string"
},
"medium-url": {
"type": "string"
}
},
"description": "URLs of the Cover Picture"
}
},
"description": "NewsPost model"
}Validations Failed
Schema
{
"type": "object",
"properties": {
"status": {
"type": "integer",
"format": "int32",
"description": "Status Code"
},
"errors": {
"type": "string",
"description": "Errors list"
}
},
"description": "Error model"
}Duplicate new postPOST/api/admin/v1/news/{id}/duplicate
Return the duplicated post.
URI Parameters
- id
string(required)
roles ¶
Operations about roles
GET /api/admin/v1/roles
Responses
Get Roles
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"name": {
"type": "string",
"description": "Role name"
},
"description": {
"type": "string",
"description": "Role description"
},
"default": {
"type": "boolean",
"description": "Is the default Role ?"
},
"rights": {
"type": "array",
"items": {
"type": "string"
},
"description": "Rights name associated to the Role"
}
},
"description": "Role model"
}Get RolesGET/api/admin/v1/roles
Return this network Roles.
GET /api/admin/v1/roles/id
Responses
Get Role
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"name": {
"type": "string",
"description": "Role name"
},
"description": {
"type": "string",
"description": "Role description"
},
"default": {
"type": "boolean",
"description": "Is the default Role ?"
},
"rights": {
"type": "array",
"items": {
"type": "string"
},
"description": "Rights name associated to the Role"
}
},
"description": "Role model"
}business_opportunities ¶
Operations about business_opportunities
GET /api/admin/v1/business_opportunities?page=&per_page=
Responses
Get all business opportunities
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Business Opportunity unique identifier"
},
"title": {
"type": "string",
"description": "Business Opportunity title"
},
"description": {
"type": "string",
"description": "Business Opportunity description"
},
"yearly_salary": {
"type": "integer",
"format": "int32",
"description": "Business Opportunity yearly salary"
},
"monthly_salary": {
"type": "integer",
"format": "int32",
"description": "Business Opportunity monthly salary"
},
"daily_salary": {
"type": "integer",
"format": "int32",
"description": "Business Opportunity daily salary"
},
"currency": {
"type": "string",
"description": "Business Opportunity salary currency"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Business Opportunity creation date time - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Business Opportunity last update date time - iso8601"
},
"expires_at": {
"type": "string",
"format": "date-time",
"description": "Business Opportunity expiration date time - iso8601"
},
"renewed_at": {
"type": "string",
"format": "date-time",
"description": "Business Opportunity renewal date time - iso8601"
},
"start_date": {
"type": "string",
"format": "date-time",
"description": "Vacancy starting date"
},
"duration": {
"type": "string",
"description": "Business Opportunity duration"
},
"company_name": {
"type": "string",
"description": "Company offering the business opportunity"
},
"company_id": {
"type": "integer",
"format": "int32",
"description": "Linked Organization unique identifier"
},
"url": {
"type": "string",
"description": "URL related to Business Opportunity"
},
"email": {
"type": "string",
"description": "Business Opportunity contact email"
},
"kind": {
"type": "string",
"enum": [
"full_time_job",
"find_job",
"short_term_project",
"find_a_team_member",
"find_mentorship",
"find_contacts",
"offer_internship",
"find_internship",
"call",
"voluntary_opportunity",
"other"
],
"description": "Business kind of opportunity"
},
"contract_type": {
"type": "string",
"enum": [
"permanent",
"fixed_term",
"part_time",
"freelance",
"vie",
"via",
"apprenticeship",
"professional",
"other"
],
"description": "Business opportunity contract type"
},
"experience_type": {
"type": "string",
"enum": [
"between_0_and_2",
"between_3_and_5",
"between_6_and_10",
"more_than_10",
"doesnt_matter"
],
"description": "Business opportunity experience needed"
},
"status": {
"type": "string",
"enum": [
"pending",
"approved",
"rejected"
],
"description": "Business Opportunity approval status"
},
"apply_by": {
"type": "string",
"enum": [
"nothing",
"contact_email",
"external_link"
],
"description": "Business Opportunity apply by method"
},
"location": {
"description": "Business Opportunity location",
"type": "object",
"properties": {
"city": {
"type": "string",
"description": "City"
},
"country": {
"type": "string",
"description": "Country"
},
"country_code": {
"type": "string",
"description": "ISO3166-2 Country code"
},
"address": {
"type": "string",
"description": "Address"
},
"lat": {
"type": "number",
"format": "float",
"description": "Latitude"
},
"lng": {
"type": "number",
"format": "float",
"description": "Longitude"
}
}
},
"creator_id": {
"type": "integer",
"format": "int32",
"description": "Creator ID (Hivebrite IDs for admins and users)"
},
"creator_type": {
"type": "string",
"description": "Creator type"
},
"salary": {
"type": "string",
"description": "Business Opportunity salary (only used with opportunities from external providers)"
},
"external_provider_ref": {
"type": "string",
"description": "Business Opportunity reference for external provider"
},
"external_provider": {
"type": "string",
"description": "Business Opportunity external provider service"
},
"public": {
"type": "boolean",
"description": "Is the Business Opportunity public ?"
},
"custom_attributes": {
"type": "array",
"items": {
"type": "object"
},
"description": "Array of customizable attributes with name, value and type"
},
"topic_ids": {
"type": "integer",
"format": "int32",
"description": "Group IDs linked to the Business Opportunity"
},
"industry_ids": {
"type": "integer",
"format": "int32",
"description": "Industries related to the Business Opportunity"
},
"draft": {
"type": "boolean",
"description": "Business Opportunity is a draft ? (default to false)"
},
"pinned_on_index_page": {
"type": "boolean",
"description": "Is the opportunity pinned in the Opportunities tab ?"
},
"external_recruiter": {
"description": "External recruiter information",
"type": "object",
"properties": {
"username": {
"type": "string",
"description": "External Recruiter username"
},
"email": {
"type": "string",
"description": "External Recruiter email"
},
"phone_number": {
"type": "string",
"description": "External Recruiter phone number"
}
}
},
"remote": {
"type": "boolean",
"description": "Can the opportunity be done remotely ?"
}
},
"description": "BusinessOpportunity::Request model"
}Get all business opportunitiesGET/api/admin/v1/business_opportunities{?page,per_page}
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"
}URI Parameters
- page
string(required)Page of results to fetch.
- per_page
string(required)Number of results to return per page.
POST /api/admin/v1/business_opportunities
Requests
Body
{
"business_opportunity[title]": "Hello, world!",
"business_opportunity[company_id]": "Hello, world!",
"business_opportunity[company_name]": "Hello, world!",
"business_opportunity[email]": "Hello, world!",
"business_opportunity[description]": "Hello, world!",
"business_opportunity[kind]": "Hello, world!",
"business_opportunity[location]": "Hello, world!",
"business_opportunity[yearly_salary]": 1,
"business_opportunity[monthly_salary]": 1,
"business_opportunity[daily_salary]": 1,
"business_opportunity[created_at]": "Hello, world!",
"business_opportunity[updated_at]": "Hello, world!",
"business_opportunity[expires_at]": "Hello, world!",
"business_opportunity[renewed_at]": "Hello, world!",
"business_opportunity[start_date]": "Hello, world!",
"business_opportunity[duration]": "Hello, world!",
"business_opportunity[url]": "Hello, world!",
"business_opportunity[contract_type]": "Hello, world!",
"business_opportunity[experience_type]": "Hello, world!",
"business_opportunity[status]": "Hello, world!",
"business_opportunity[apply_by]": "Hello, world!",
"business_opportunity[external_provider_ref]": "Hello, world!",
"business_opportunity[public]": true,
"business_opportunity[custom_attributes][]": [],
"business_opportunity[topic_ids][]": [
1
],
"business_opportunity[industry_ids][]": [
1
],
"business_opportunity[draft]": true,
"business_opportunity[pinned_on_index_page]": true,
"business_opportunity[external_recruiter]": "Hello, world!",
"business_opportunity[remote]": true,
"business_opportunity[currency]": "Hello, world!"
}Schema
{
"type": "object",
"properties": {
"business_opportunity[title]": {
"type": "string",
"description": "Business opportunity title"
},
"business_opportunity[company_id]": {
"type": "string",
"description": "Identifier of company offering the business opportunity (required if no company name is provided)"
},
"business_opportunity[company_name]": {
"type": "string",
"description": "Company offering the business opportunity (required if no company Id is provided)"
},
"business_opportunity[email]": {
"type": "string",
"description": "Business Opportunity contact email"
},
"business_opportunity[description]": {
"type": "string",
"description": "Business Opportunity description"
},
"business_opportunity[kind]": {
"type": "string",
"description": "Business kind of opportunity"
},
"business_opportunity[location]": {
"type": "string",
"description": "Business opportunity address location"
},
"business_opportunity[yearly_salary]": {
"type": "number",
"description": "Business Opportunity yearly salary"
},
"business_opportunity[monthly_salary]": {
"type": "number",
"description": "Business Opportunity monthly salary"
},
"business_opportunity[daily_salary]": {
"type": "number",
"description": "Business Opportunity daily salary"
},
"business_opportunity[created_at]": {
"type": "string",
"description": "Business Opportunity creation date time - iso8601"
},
"business_opportunity[updated_at]": {
"type": "string",
"description": "Business Opportunity last update date time - iso8601"
},
"business_opportunity[expires_at]": {
"type": "string",
"description": "Business Opportunity expiration date time - iso8601"
},
"business_opportunity[renewed_at]": {
"type": "string",
"description": "Business Opportunity renewal date time - iso8601"
},
"business_opportunity[start_date]": {
"type": "string",
"description": "Vacancy starting date"
},
"business_opportunity[duration]": {
"type": "string",
"description": "Business Opportunity duration"
},
"business_opportunity[url]": {
"type": "string",
"description": "URL related to Business Opportunity"
},
"business_opportunity[contract_type]": {
"type": "string",
"description": "Business opportunity contract type"
},
"business_opportunity[experience_type]": {
"type": "string",
"description": "Business opportunity experience needed"
},
"business_opportunity[status]": {
"type": "string",
"description": "Business Opportunity approval status"
},
"business_opportunity[apply_by]": {
"type": "string",
"description": "Business Opportunity apply by method"
},
"business_opportunity[external_provider_ref]": {
"type": "string",
"description": "Business Opportunity reference for external provider"
},
"business_opportunity[public]": {
"type": "boolean",
"description": "Is the Business Opportunity public ?"
},
"business_opportunity[custom_attributes][]": {
"type": "array",
"description": "Array of customizable attributes with name, value and type\n\n+"
},
"business_opportunity[topic_ids][]": {
"type": "array",
"items": {
"type": "number"
},
"description": "Group IDs linked to the Business Opportunity"
},
"business_opportunity[industry_ids][]": {
"type": "array",
"items": {
"type": "number"
},
"description": "Industries related to the Business Opportunity"
},
"business_opportunity[draft]": {
"type": "boolean",
"description": "Business Opportunity is a draft ? (default to false)"
},
"business_opportunity[pinned_on_index_page]": {
"type": "boolean",
"description": "Is the opportunity pinned in the Opportunities tab ?"
},
"business_opportunity[external_recruiter]": {
"type": "string",
"description": "External recruiter information"
},
"business_opportunity[remote]": {
"type": "boolean",
"description": "Can the opportunity be done remotely ?"
},
"business_opportunity[currency]": {
"type": "string",
"description": "Salary currency"
}
},
"required": [
"business_opportunity[title]",
"business_opportunity[email]",
"business_opportunity[kind]",
"business_opportunity[currency]"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Add a new business opportunity
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Business Opportunity unique identifier"
},
"title": {
"type": "string",
"description": "Business Opportunity title"
},
"description": {
"type": "string",
"description": "Business Opportunity description"
},
"yearly_salary": {
"type": "integer",
"format": "int32",
"description": "Business Opportunity yearly salary"
},
"monthly_salary": {
"type": "integer",
"format": "int32",
"description": "Business Opportunity monthly salary"
},
"daily_salary": {
"type": "integer",
"format": "int32",
"description": "Business Opportunity daily salary"
},
"currency": {
"type": "string",
"description": "Business Opportunity salary currency"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Business Opportunity creation date time - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Business Opportunity last update date time - iso8601"
},
"expires_at": {
"type": "string",
"format": "date-time",
"description": "Business Opportunity expiration date time - iso8601"
},
"renewed_at": {
"type": "string",
"format": "date-time",
"description": "Business Opportunity renewal date time - iso8601"
},
"start_date": {
"type": "string",
"format": "date-time",
"description": "Vacancy starting date"
},
"duration": {
"type": "string",
"description": "Business Opportunity duration"
},
"company_name": {
"type": "string",
"description": "Company offering the business opportunity"
},
"company_id": {
"type": "integer",
"format": "int32",
"description": "Linked Organization unique identifier"
},
"url": {
"type": "string",
"description": "URL related to Business Opportunity"
},
"email": {
"type": "string",
"description": "Business Opportunity contact email"
},
"kind": {
"type": "string",
"enum": [
"full_time_job",
"find_job",
"short_term_project",
"find_a_team_member",
"find_mentorship",
"find_contacts",
"offer_internship",
"find_internship",
"call",
"voluntary_opportunity",
"other"
],
"description": "Business kind of opportunity"
},
"contract_type": {
"type": "string",
"enum": [
"permanent",
"fixed_term",
"part_time",
"freelance",
"vie",
"via",
"apprenticeship",
"professional",
"other"
],
"description": "Business opportunity contract type"
},
"experience_type": {
"type": "string",
"enum": [
"between_0_and_2",
"between_3_and_5",
"between_6_and_10",
"more_than_10",
"doesnt_matter"
],
"description": "Business opportunity experience needed"
},
"status": {
"type": "string",
"enum": [
"pending",
"approved",
"rejected"
],
"description": "Business Opportunity approval status"
},
"apply_by": {
"type": "string",
"enum": [
"nothing",
"contact_email",
"external_link"
],
"description": "Business Opportunity apply by method"
},
"location": {
"description": "Business Opportunity location",
"type": "object",
"properties": {
"city": {
"type": "string",
"description": "City"
},
"country": {
"type": "string",
"description": "Country"
},
"country_code": {
"type": "string",
"description": "ISO3166-2 Country code"
},
"address": {
"type": "string",
"description": "Address"
},
"lat": {
"type": "number",
"format": "float",
"description": "Latitude"
},
"lng": {
"type": "number",
"format": "float",
"description": "Longitude"
}
}
},
"creator_id": {
"type": "integer",
"format": "int32",
"description": "Creator ID (Hivebrite IDs for admins and users)"
},
"creator_type": {
"type": "string",
"description": "Creator type"
},
"salary": {
"type": "string",
"description": "Business Opportunity salary (only used with opportunities from external providers)"
},
"external_provider_ref": {
"type": "string",
"description": "Business Opportunity reference for external provider"
},
"external_provider": {
"type": "string",
"description": "Business Opportunity external provider service"
},
"public": {
"type": "boolean",
"description": "Is the Business Opportunity public ?"
},
"custom_attributes": {
"type": "array",
"items": {
"type": "object"
},
"description": "Array of customizable attributes with name, value and type"
},
"topic_ids": {
"type": "integer",
"format": "int32",
"description": "Group IDs linked to the Business Opportunity"
},
"industry_ids": {
"type": "integer",
"format": "int32",
"description": "Industries related to the Business Opportunity"
},
"draft": {
"type": "boolean",
"description": "Business Opportunity is a draft ? (default to false)"
},
"pinned_on_index_page": {
"type": "boolean",
"description": "Is the opportunity pinned in the Opportunities tab ?"
},
"external_recruiter": {
"description": "External recruiter information",
"type": "object",
"properties": {
"username": {
"type": "string",
"description": "External Recruiter username"
},
"email": {
"type": "string",
"description": "External Recruiter email"
},
"phone_number": {
"type": "string",
"description": "External Recruiter phone number"
}
}
},
"remote": {
"type": "boolean",
"description": "Can the opportunity be done remotely ?"
}
},
"description": "BusinessOpportunity::Request model"
}Validations Failed
Schema
{
"type": "object",
"properties": {
"status": {
"type": "integer",
"format": "int32",
"description": "Status Code"
},
"errors": {
"type": "string",
"description": "Errors list"
}
},
"description": "Error model"
}Add a new business opportunityPOST/api/admin/v1/business_opportunities
Return the created business opportunity.
GET /api/admin/v1/business_opportunities/id
Responses
Get business opportunity profile
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Business Opportunity unique identifier"
},
"title": {
"type": "string",
"description": "Business Opportunity title"
},
"description": {
"type": "string",
"description": "Business Opportunity description"
},
"yearly_salary": {
"type": "integer",
"format": "int32",
"description": "Business Opportunity yearly salary"
},
"monthly_salary": {
"type": "integer",
"format": "int32",
"description": "Business Opportunity monthly salary"
},
"daily_salary": {
"type": "integer",
"format": "int32",
"description": "Business Opportunity daily salary"
},
"currency": {
"type": "string",
"description": "Business Opportunity salary currency"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Business Opportunity creation date time - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Business Opportunity last update date time - iso8601"
},
"expires_at": {
"type": "string",
"format": "date-time",
"description": "Business Opportunity expiration date time - iso8601"
},
"renewed_at": {
"type": "string",
"format": "date-time",
"description": "Business Opportunity renewal date time - iso8601"
},
"start_date": {
"type": "string",
"format": "date-time",
"description": "Vacancy starting date"
},
"duration": {
"type": "string",
"description": "Business Opportunity duration"
},
"company_name": {
"type": "string",
"description": "Company offering the business opportunity"
},
"company_id": {
"type": "integer",
"format": "int32",
"description": "Linked Organization unique identifier"
},
"url": {
"type": "string",
"description": "URL related to Business Opportunity"
},
"email": {
"type": "string",
"description": "Business Opportunity contact email"
},
"kind": {
"type": "string",
"enum": [
"full_time_job",
"find_job",
"short_term_project",
"find_a_team_member",
"find_mentorship",
"find_contacts",
"offer_internship",
"find_internship",
"call",
"voluntary_opportunity",
"other"
],
"description": "Business kind of opportunity"
},
"contract_type": {
"type": "string",
"enum": [
"permanent",
"fixed_term",
"part_time",
"freelance",
"vie",
"via",
"apprenticeship",
"professional",
"other"
],
"description": "Business opportunity contract type"
},
"experience_type": {
"type": "string",
"enum": [
"between_0_and_2",
"between_3_and_5",
"between_6_and_10",
"more_than_10",
"doesnt_matter"
],
"description": "Business opportunity experience needed"
},
"status": {
"type": "string",
"enum": [
"pending",
"approved",
"rejected"
],
"description": "Business Opportunity approval status"
},
"apply_by": {
"type": "string",
"enum": [
"nothing",
"contact_email",
"external_link"
],
"description": "Business Opportunity apply by method"
},
"location": {
"description": "Business Opportunity location",
"type": "object",
"properties": {
"city": {
"type": "string",
"description": "City"
},
"country": {
"type": "string",
"description": "Country"
},
"country_code": {
"type": "string",
"description": "ISO3166-2 Country code"
},
"address": {
"type": "string",
"description": "Address"
},
"lat": {
"type": "number",
"format": "float",
"description": "Latitude"
},
"lng": {
"type": "number",
"format": "float",
"description": "Longitude"
}
}
},
"creator_id": {
"type": "integer",
"format": "int32",
"description": "Creator ID (Hivebrite IDs for admins and users)"
},
"creator_type": {
"type": "string",
"description": "Creator type"
},
"salary": {
"type": "string",
"description": "Business Opportunity salary (only used with opportunities from external providers)"
},
"external_provider_ref": {
"type": "string",
"description": "Business Opportunity reference for external provider"
},
"external_provider": {
"type": "string",
"description": "Business Opportunity external provider service"
},
"public": {
"type": "boolean",
"description": "Is the Business Opportunity public ?"
},
"custom_attributes": {
"type": "array",
"items": {
"type": "object"
},
"description": "Array of customizable attributes with name, value and type"
},
"topic_ids": {
"type": "integer",
"format": "int32",
"description": "Group IDs linked to the Business Opportunity"
},
"industry_ids": {
"type": "integer",
"format": "int32",
"description": "Industries related to the Business Opportunity"
},
"draft": {
"type": "boolean",
"description": "Business Opportunity is a draft ? (default to false)"
},
"pinned_on_index_page": {
"type": "boolean",
"description": "Is the opportunity pinned in the Opportunities tab ?"
},
"external_recruiter": {
"description": "External recruiter information",
"type": "object",
"properties": {
"username": {
"type": "string",
"description": "External Recruiter username"
},
"email": {
"type": "string",
"description": "External Recruiter email"
},
"phone_number": {
"type": "string",
"description": "External Recruiter phone number"
}
}
},
"remote": {
"type": "boolean",
"description": "Can the opportunity be done remotely ?"
}
},
"description": "BusinessOpportunity::Request model"
}Get business opportunity profileGET/api/admin/v1/business_opportunities/{id}
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.
URI Parameters
- id
string(required)
PUT /api/admin/v1/business_opportunities/id
Requests
Body
{
"location": "Hello, world!",
"business_opportunity[company_name]": "Hello, world!",
"business_opportunity[company_id]": "Hello, world!",
"business_opportunity[title]": "Hello, world!",
"business_opportunity[description]": "Hello, world!",
"business_opportunity[yearly_salary]": 1,
"business_opportunity[monthly_salary]": 1,
"business_opportunity[daily_salary]": 1,
"business_opportunity[currency]": "Hello, world!",
"business_opportunity[created_at]": "Hello, world!",
"business_opportunity[updated_at]": "Hello, world!",
"business_opportunity[expires_at]": "Hello, world!",
"business_opportunity[renewed_at]": "Hello, world!",
"business_opportunity[start_date]": "Hello, world!",
"business_opportunity[duration]": "Hello, world!",
"business_opportunity[url]": "Hello, world!",
"business_opportunity[email]": "Hello, world!",
"business_opportunity[kind]": "Hello, world!",
"business_opportunity[contract_type]": "Hello, world!",
"business_opportunity[experience_type]": "Hello, world!",
"business_opportunity[status]": "Hello, world!",
"business_opportunity[apply_by]": "Hello, world!",
"business_opportunity[external_provider_ref]": "Hello, world!",
"business_opportunity[public]": true,
"business_opportunity[custom_attributes][]": [],
"business_opportunity[topic_ids][]": [
1
],
"business_opportunity[industry_ids][]": [
1
],
"business_opportunity[draft]": true,
"business_opportunity[pinned_on_index_page]": true,
"business_opportunity[external_recruiter]": "Hello, world!",
"business_opportunity[remote]": true
}Schema
{
"type": "object",
"properties": {
"location": {
"type": "string",
"description": "Business opportunity address location"
},
"business_opportunity[company_name]": {
"type": "string",
"description": "Company offering the business opportunity"
},
"business_opportunity[company_id]": {
"type": "string",
"description": "Identifier of company offering the business opportunity"
},
"business_opportunity[title]": {
"type": "string",
"description": "Business Opportunity title"
},
"business_opportunity[description]": {
"type": "string",
"description": "Business Opportunity description"
},
"business_opportunity[yearly_salary]": {
"type": "number",
"description": "Business Opportunity yearly salary"
},
"business_opportunity[monthly_salary]": {
"type": "number",
"description": "Business Opportunity monthly salary"
},
"business_opportunity[daily_salary]": {
"type": "number",
"description": "Business Opportunity daily salary"
},
"business_opportunity[currency]": {
"type": "string",
"description": "Business Opportunity salary currency"
},
"business_opportunity[created_at]": {
"type": "string",
"description": "Business Opportunity creation date time - iso8601"
},
"business_opportunity[updated_at]": {
"type": "string",
"description": "Business Opportunity last update date time - iso8601"
},
"business_opportunity[expires_at]": {
"type": "string",
"description": "Business Opportunity expiration date time - iso8601"
},
"business_opportunity[renewed_at]": {
"type": "string",
"description": "Business Opportunity renewal date time - iso8601"
},
"business_opportunity[start_date]": {
"type": "string",
"description": "Vacancy starting date"
},
"business_opportunity[duration]": {
"type": "string",
"description": "Business Opportunity duration"
},
"business_opportunity[url]": {
"type": "string",
"description": "URL related to Business Opportunity"
},
"business_opportunity[email]": {
"type": "string",
"description": "Business Opportunity contact email"
},
"business_opportunity[kind]": {
"type": "string",
"description": "Business kind of opportunity"
},
"business_opportunity[contract_type]": {
"type": "string",
"description": "Business opportunity contract type"
},
"business_opportunity[experience_type]": {
"type": "string",
"description": "Business opportunity experience needed"
},
"business_opportunity[status]": {
"type": "string",
"description": "Business Opportunity approval status"
},
"business_opportunity[apply_by]": {
"type": "string",
"description": "Business Opportunity apply by method"
},
"business_opportunity[external_provider_ref]": {
"type": "string",
"description": "Business Opportunity reference for external provider"
},
"business_opportunity[public]": {
"type": "boolean",
"description": "Is the Business Opportunity public ?"
},
"business_opportunity[custom_attributes][]": {
"type": "array",
"description": "Array of customizable attributes with name, value and type\n\n+"
},
"business_opportunity[topic_ids][]": {
"type": "array",
"items": {
"type": "number"
},
"description": "Group IDs linked to the Business Opportunity"
},
"business_opportunity[industry_ids][]": {
"type": "array",
"items": {
"type": "number"
},
"description": "Industries related to the Business Opportunity"
},
"business_opportunity[draft]": {
"type": "boolean",
"description": "Business Opportunity is a draft ? (default to false)"
},
"business_opportunity[pinned_on_index_page]": {
"type": "boolean",
"description": "Is the opportunity pinned in the Opportunities tab ?"
},
"business_opportunity[external_recruiter]": {
"type": "string",
"description": "External recruiter information"
},
"business_opportunity[remote]": {
"type": "boolean",
"description": "Can the opportunity be done remotely ?"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Update existing business opportunity
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Business Opportunity unique identifier"
},
"title": {
"type": "string",
"description": "Business Opportunity title"
},
"description": {
"type": "string",
"description": "Business Opportunity description"
},
"yearly_salary": {
"type": "integer",
"format": "int32",
"description": "Business Opportunity yearly salary"
},
"monthly_salary": {
"type": "integer",
"format": "int32",
"description": "Business Opportunity monthly salary"
},
"daily_salary": {
"type": "integer",
"format": "int32",
"description": "Business Opportunity daily salary"
},
"currency": {
"type": "string",
"description": "Business Opportunity salary currency"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Business Opportunity creation date time - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Business Opportunity last update date time - iso8601"
},
"expires_at": {
"type": "string",
"format": "date-time",
"description": "Business Opportunity expiration date time - iso8601"
},
"renewed_at": {
"type": "string",
"format": "date-time",
"description": "Business Opportunity renewal date time - iso8601"
},
"start_date": {
"type": "string",
"format": "date-time",
"description": "Vacancy starting date"
},
"duration": {
"type": "string",
"description": "Business Opportunity duration"
},
"company_name": {
"type": "string",
"description": "Company offering the business opportunity"
},
"company_id": {
"type": "integer",
"format": "int32",
"description": "Linked Organization unique identifier"
},
"url": {
"type": "string",
"description": "URL related to Business Opportunity"
},
"email": {
"type": "string",
"description": "Business Opportunity contact email"
},
"kind": {
"type": "string",
"enum": [
"full_time_job",
"find_job",
"short_term_project",
"find_a_team_member",
"find_mentorship",
"find_contacts",
"offer_internship",
"find_internship",
"call",
"voluntary_opportunity",
"other"
],
"description": "Business kind of opportunity"
},
"contract_type": {
"type": "string",
"enum": [
"permanent",
"fixed_term",
"part_time",
"freelance",
"vie",
"via",
"apprenticeship",
"professional",
"other"
],
"description": "Business opportunity contract type"
},
"experience_type": {
"type": "string",
"enum": [
"between_0_and_2",
"between_3_and_5",
"between_6_and_10",
"more_than_10",
"doesnt_matter"
],
"description": "Business opportunity experience needed"
},
"status": {
"type": "string",
"enum": [
"pending",
"approved",
"rejected"
],
"description": "Business Opportunity approval status"
},
"apply_by": {
"type": "string",
"enum": [
"nothing",
"contact_email",
"external_link"
],
"description": "Business Opportunity apply by method"
},
"location": {
"description": "Business Opportunity location",
"type": "object",
"properties": {
"city": {
"type": "string",
"description": "City"
},
"country": {
"type": "string",
"description": "Country"
},
"country_code": {
"type": "string",
"description": "ISO3166-2 Country code"
},
"address": {
"type": "string",
"description": "Address"
},
"lat": {
"type": "number",
"format": "float",
"description": "Latitude"
},
"lng": {
"type": "number",
"format": "float",
"description": "Longitude"
}
}
},
"creator_id": {
"type": "integer",
"format": "int32",
"description": "Creator ID (Hivebrite IDs for admins and users)"
},
"creator_type": {
"type": "string",
"description": "Creator type"
},
"salary": {
"type": "string",
"description": "Business Opportunity salary (only used with opportunities from external providers)"
},
"external_provider_ref": {
"type": "string",
"description": "Business Opportunity reference for external provider"
},
"external_provider": {
"type": "string",
"description": "Business Opportunity external provider service"
},
"public": {
"type": "boolean",
"description": "Is the Business Opportunity public ?"
},
"custom_attributes": {
"type": "array",
"items": {
"type": "object"
},
"description": "Array of customizable attributes with name, value and type"
},
"topic_ids": {
"type": "integer",
"format": "int32",
"description": "Group IDs linked to the Business Opportunity"
},
"industry_ids": {
"type": "integer",
"format": "int32",
"description": "Industries related to the Business Opportunity"
},
"draft": {
"type": "boolean",
"description": "Business Opportunity is a draft ? (default to false)"
},
"pinned_on_index_page": {
"type": "boolean",
"description": "Is the opportunity pinned in the Opportunities tab ?"
},
"external_recruiter": {
"description": "External recruiter information",
"type": "object",
"properties": {
"username": {
"type": "string",
"description": "External Recruiter username"
},
"email": {
"type": "string",
"description": "External Recruiter email"
},
"phone_number": {
"type": "string",
"description": "External Recruiter phone number"
}
}
},
"remote": {
"type": "boolean",
"description": "Can the opportunity be done remotely ?"
}
},
"description": "BusinessOpportunity::Request model"
}Validations Failed
Schema
{
"type": "object",
"properties": {
"status": {
"type": "integer",
"format": "int32",
"description": "Status Code"
},
"errors": {
"type": "string",
"description": "Errors list"
}
},
"description": "Error model"
}Update existing business opportunityPUT/api/admin/v1/business_opportunities/{id}
Return the updated business opportunity profile based on its ID
Updates the business opportunity matching its ID.
URI Parameters
- id
string(required)Business Opportunity ID
DELETE /api/admin/v1/business_opportunities/id
Responses
Delete business opportunity
Delete business opportunityDELETE/api/admin/v1/business_opportunities/{id}
Delete the business opportunity based on its ID
Delete the business opportunity matching its ID.
URI Parameters
- id
string(required)
receipts ¶
Operations about receipts
GET /api/admin/v1/receipts
Responses
Get all receipts
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"external_id": {
"type": "string",
"description": "External ID"
},
"receipt_items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"quantity": {
"type": "integer",
"format": "int32",
"description": "Receipt number"
},
"unit_price": {
"type": "number",
"format": "float",
"description": "Unit price"
},
"total_price": {
"type": "number",
"format": "float",
"description": "Total Price"
},
"vat_name": {
"type": "string",
"description": "The name or identifier of the value-added tax (VAT) applicable to the product or service."
},
"vat_rate": {
"type": "number",
"format": "float",
"description": "The percentage rate of the value-added tax (VAT) applicable to the product or service."
},
"product_type": {
"type": "string",
"description": "Item bought"
},
"product_id": {
"type": "integer",
"format": "int32",
"description": "ID of the item bought (membership, sign-up payment order, Donation order, event attendee)"
},
"fund_id": {
"type": "integer",
"format": "int32",
"description": "ID of the Donation Fund for the Donation receipt"
}
}
}
},
"receipt_number": {
"type": "string",
"description": "Receipt number"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Creation date - iso8601"
},
"vat_amount": {
"type": "number",
"format": "float",
"description": "VAT %"
},
"total_excl_tax": {
"type": "number",
"format": "float",
"description": "total, excluding taxes"
},
"total_incl_tax": {
"type": "number",
"format": "float",
"description": "total, including taxes"
},
"billing_address": {
"description": "Billing address",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"address_1": {
"type": "string",
"description": "Address line 1"
},
"address_2": {
"type": "string",
"description": "Address line 2"
},
"address_3": {
"type": "string",
"description": "Address line 3"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "State"
},
"full_name": {
"type": "string",
"description": "Full name"
},
"postal_code": {
"type": "string",
"description": "Zip code"
},
"country": {
"type": "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"
],
"description": "Country"
},
"default_billing_address": {
"type": "boolean",
"description": "is the default billing address for the user ?"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Postal address creation date time - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Postal address last update date time - iso8601"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "User ID linked to postal address"
}
}
},
"shipping_address": {
"description": "Shipping address",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"address_1": {
"type": "string",
"description": "Address line 1"
},
"address_2": {
"type": "string",
"description": "Address line 2"
},
"address_3": {
"type": "string",
"description": "Address line 3"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "State"
},
"full_name": {
"type": "string",
"description": "Full name"
},
"postal_code": {
"type": "string",
"description": "Zip code"
},
"country": {
"type": "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"
],
"description": "Country"
},
"default_billing_address": {
"type": "boolean",
"description": "is the default billing address for the user ?"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Postal address creation date time - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Postal address last update date time - iso8601"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "User ID linked to postal address"
}
}
},
"firstname": {
"type": "string",
"description": "buyer firstname"
},
"lastname": {
"type": "string",
"description": "buyer lastname"
},
"email": {
"type": "string",
"description": "buyer email"
},
"payment_status": {
"type": "string",
"enum": [
"paid",
"not_paid",
"pending",
"failed",
"canceled"
],
"description": "Payment status"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "User ID linked to the receipt"
},
"payment_gateway_informations": {
"type": "string",
"description": "Informations returned from the payment gateway for this payment"
},
"payment_account_id": {
"type": "integer",
"format": "int32",
"description": "ID of the payment account linked to the Receipt"
}
},
"description": "Receipt model"
}Get all receiptsGET/api/admin/v1/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"
}URI Parameters
- page
string(required)Page of results to fetch.
- per_page
string(required)Number of results to return per page.
- created_since
string(required)- order
string(required)
GET /api/admin/v1/receipts/id
Responses
Get receipt
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"external_id": {
"type": "string",
"description": "External ID"
},
"receipt_items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"quantity": {
"type": "integer",
"format": "int32",
"description": "Receipt number"
},
"unit_price": {
"type": "number",
"format": "float",
"description": "Unit price"
},
"total_price": {
"type": "number",
"format": "float",
"description": "Total Price"
},
"vat_name": {
"type": "string",
"description": "The name or identifier of the value-added tax (VAT) applicable to the product or service."
},
"vat_rate": {
"type": "number",
"format": "float",
"description": "The percentage rate of the value-added tax (VAT) applicable to the product or service."
},
"product_type": {
"type": "string",
"description": "Item bought"
},
"product_id": {
"type": "integer",
"format": "int32",
"description": "ID of the item bought (membership, sign-up payment order, Donation order, event attendee)"
},
"fund_id": {
"type": "integer",
"format": "int32",
"description": "ID of the Donation Fund for the Donation receipt"
}
}
}
},
"receipt_number": {
"type": "string",
"description": "Receipt number"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Creation date - iso8601"
},
"vat_amount": {
"type": "number",
"format": "float",
"description": "VAT %"
},
"total_excl_tax": {
"type": "number",
"format": "float",
"description": "total, excluding taxes"
},
"total_incl_tax": {
"type": "number",
"format": "float",
"description": "total, including taxes"
},
"billing_address": {
"description": "Billing address",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"address_1": {
"type": "string",
"description": "Address line 1"
},
"address_2": {
"type": "string",
"description": "Address line 2"
},
"address_3": {
"type": "string",
"description": "Address line 3"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "State"
},
"full_name": {
"type": "string",
"description": "Full name"
},
"postal_code": {
"type": "string",
"description": "Zip code"
},
"country": {
"type": "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"
],
"description": "Country"
},
"default_billing_address": {
"type": "boolean",
"description": "is the default billing address for the user ?"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Postal address creation date time - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Postal address last update date time - iso8601"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "User ID linked to postal address"
}
}
},
"shipping_address": {
"description": "Shipping address",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"address_1": {
"type": "string",
"description": "Address line 1"
},
"address_2": {
"type": "string",
"description": "Address line 2"
},
"address_3": {
"type": "string",
"description": "Address line 3"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "State"
},
"full_name": {
"type": "string",
"description": "Full name"
},
"postal_code": {
"type": "string",
"description": "Zip code"
},
"country": {
"type": "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"
],
"description": "Country"
},
"default_billing_address": {
"type": "boolean",
"description": "is the default billing address for the user ?"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Postal address creation date time - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Postal address last update date time - iso8601"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "User ID linked to postal address"
}
}
},
"firstname": {
"type": "string",
"description": "buyer firstname"
},
"lastname": {
"type": "string",
"description": "buyer lastname"
},
"email": {
"type": "string",
"description": "buyer email"
},
"payment_status": {
"type": "string",
"enum": [
"paid",
"not_paid",
"pending",
"failed",
"canceled"
],
"description": "Payment status"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "User ID linked to the receipt"
},
"payment_gateway_informations": {
"type": "string",
"description": "Informations returned from the payment gateway for this payment"
},
"payment_account_id": {
"type": "integer",
"format": "int32",
"description": "ID of the payment account linked to the Receipt"
}
},
"description": "Receipt model"
}Get receiptGET/api/admin/v1/receipts/{id}
Return the receipt based on its ID
Find the receipt matching its ID.
URI Parameters
- id
string(required)
PUT /api/admin/v1/receipts/id
Requests
Body
{
"receipt[payment_status]": "Hello, world!",
"receipt[external_id]": "Hello, world!"
}Schema
{
"type": "object",
"properties": {
"receipt[payment_status]": {
"type": "string"
},
"receipt[external_id]": {
"type": "string"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Update receipt
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"external_id": {
"type": "string",
"description": "External ID"
},
"receipt_items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"quantity": {
"type": "integer",
"format": "int32",
"description": "Receipt number"
},
"unit_price": {
"type": "number",
"format": "float",
"description": "Unit price"
},
"total_price": {
"type": "number",
"format": "float",
"description": "Total Price"
},
"vat_name": {
"type": "string",
"description": "The name or identifier of the value-added tax (VAT) applicable to the product or service."
},
"vat_rate": {
"type": "number",
"format": "float",
"description": "The percentage rate of the value-added tax (VAT) applicable to the product or service."
},
"product_type": {
"type": "string",
"description": "Item bought"
},
"product_id": {
"type": "integer",
"format": "int32",
"description": "ID of the item bought (membership, sign-up payment order, Donation order, event attendee)"
},
"fund_id": {
"type": "integer",
"format": "int32",
"description": "ID of the Donation Fund for the Donation receipt"
}
}
}
},
"receipt_number": {
"type": "string",
"description": "Receipt number"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Creation date - iso8601"
},
"vat_amount": {
"type": "number",
"format": "float",
"description": "VAT %"
},
"total_excl_tax": {
"type": "number",
"format": "float",
"description": "total, excluding taxes"
},
"total_incl_tax": {
"type": "number",
"format": "float",
"description": "total, including taxes"
},
"billing_address": {
"description": "Billing address",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"address_1": {
"type": "string",
"description": "Address line 1"
},
"address_2": {
"type": "string",
"description": "Address line 2"
},
"address_3": {
"type": "string",
"description": "Address line 3"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "State"
},
"full_name": {
"type": "string",
"description": "Full name"
},
"postal_code": {
"type": "string",
"description": "Zip code"
},
"country": {
"type": "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"
],
"description": "Country"
},
"default_billing_address": {
"type": "boolean",
"description": "is the default billing address for the user ?"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Postal address creation date time - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Postal address last update date time - iso8601"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "User ID linked to postal address"
}
}
},
"shipping_address": {
"description": "Shipping address",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"address_1": {
"type": "string",
"description": "Address line 1"
},
"address_2": {
"type": "string",
"description": "Address line 2"
},
"address_3": {
"type": "string",
"description": "Address line 3"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "State"
},
"full_name": {
"type": "string",
"description": "Full name"
},
"postal_code": {
"type": "string",
"description": "Zip code"
},
"country": {
"type": "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"
],
"description": "Country"
},
"default_billing_address": {
"type": "boolean",
"description": "is the default billing address for the user ?"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Postal address creation date time - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Postal address last update date time - iso8601"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "User ID linked to postal address"
}
}
},
"firstname": {
"type": "string",
"description": "buyer firstname"
},
"lastname": {
"type": "string",
"description": "buyer lastname"
},
"email": {
"type": "string",
"description": "buyer email"
},
"payment_status": {
"type": "string",
"enum": [
"paid",
"not_paid",
"pending",
"failed",
"canceled"
],
"description": "Payment status"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "User ID linked to the receipt"
},
"payment_gateway_informations": {
"type": "string",
"description": "Informations returned from the payment gateway for this payment"
},
"payment_account_id": {
"type": "integer",
"format": "int32",
"description": "ID of the payment account linked to the Receipt"
}
},
"description": "Receipt model"
}Update receiptPUT/api/admin/v1/receipts/{id}
Update the receipt
Find the receipt matching its ID and update its payment parameter, external_id.
URI Parameters
- id
string(required)
pages_customizable ¶
Operations about pages_customizables
GET /api/admin/v1/pages_customizable?owner=&owner_id=
Responses
Get Pages Customizable
Schema
{
"type": "object",
"properties": {
"pages_customizable": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"slug": {
"type": "string",
"description": "short name to access Customizable Page"
},
"identifier": {
"type": "string",
"description": "Defines feature page"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Customizable Page creation date"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Customizable Page last update date"
}
}
}
}
},
"description": "PagesCustomizable model"
}Get Pages CustomizableGET/api/admin/v1/pages_customizable{?owner,owner_id}
Return this network Customizable Page.
URI Parameters
- owner
string(required)- owner_id
number(required)
POST /api/admin/v1/pages_customizable
Requests
Body
{
"locale": "Hello, world!",
"owner": "Hello, world!",
"owner_id": 1,
"page_customizable[menu_name]": "Hello, world!",
"page_customizable[external]": true,
"page_customizable[url]": "Hello, world!",
"page_customizable[slug]": "Hello, world!",
"page_customizable[identifier]": "Hello, world!",
"page_customizable[created_at]": "Hello, world!",
"page_customizable[updated_at]": "Hello, world!",
"page_customizable[title]": "Hello, world!",
"page_customizable[short_description]": "Hello, world!",
"page_customizable[content]": "Hello, world!",
"page_customizable[seo_title]": "Hello, world!",
"page_customizable[seo_description]": "Hello, world!",
"page_customizable[enable_emphasize]": true,
"page_customizable[open_in_new_tab]": true,
"page_customizable[draft]": true,
"page_customizable[display_public]": true,
"page_customizable[display_private]": true,
"page_customizable[accessible_status]": "Hello, world!",
"page_customizable[sub_network_ids][]": [
1
],
"page_customizable[memberships_type_ids][]": [
1
],
"page_customizable[role_ids][]": [
1
],
"page_customizable[filter_type_is_and]": true,
"page_customizable[page_customizable_ids][]": [
1
],
"page_customizable[cover_picture]": "Hello, world!",
"page_customizable[delete_picture]": true
}Schema
{
"type": "object",
"properties": {
"locale": {
"type": "string"
},
"owner": {
"type": "string",
"default": "network"
},
"owner_id": {
"type": "number"
},
"page_customizable[menu_name]": {
"type": "string",
"description": "Name of the tab"
},
"page_customizable[external]": {
"type": "boolean",
"description": "Is the Customizable Page an external link ?"
},
"page_customizable[url]": {
"type": "string"
},
"page_customizable[slug]": {
"type": "string",
"description": "short name to access Customizable Page"
},
"page_customizable[identifier]": {
"type": "string",
"description": "Defines feature page"
},
"page_customizable[created_at]": {
"type": "string",
"description": "Customizable Page creation date"
},
"page_customizable[updated_at]": {
"type": "string",
"description": "Customizable Page last update date"
},
"page_customizable[title]": {
"type": "string",
"description": "Title of the Customizable Page"
},
"page_customizable[short_description]": {
"type": "string",
"description": "Short Description of the Customizable Page"
},
"page_customizable[content]": {
"type": "string",
"description": "Content of the Customizable Page"
},
"page_customizable[seo_title]": {
"type": "string",
"description": "SEO Title of the Customizable Page"
},
"page_customizable[seo_description]": {
"type": "string",
"description": "SEO Description of the Cutomizable Page"
},
"page_customizable[enable_emphasize]": {
"type": "boolean",
"description": "Dim the banner"
},
"page_customizable[open_in_new_tab]": {
"type": "boolean",
"description": "Does the link opens in a new tab ?"
},
"page_customizable[draft]": {
"type": "boolean",
"description": "Is the Customizable Page in draft mode or not"
},
"page_customizable[display_public]": {
"type": "boolean",
"description": "Tab is displayed on public pages"
},
"page_customizable[display_private]": {
"type": "boolean",
"description": "Tab is displayed on private pages"
},
"page_customizable[accessible_status]": {
"type": "string",
"description": "Who can access the Customizable Page via URL; value 'access_restricted' enables filtering parameters"
},
"page_customizable[sub_network_ids][]": {
"type": "array",
"items": {
"type": "number"
},
"description": "Filtering parameter: people belonging to these clusters / sub networks"
},
"page_customizable[memberships_type_ids][]": {
"type": "array",
"items": {
"type": "number"
},
"description": "Filtering parameter: people having these kinds of memberships"
},
"page_customizable[role_ids][]": {
"type": "array",
"items": {
"type": "number"
},
"description": "Filtering parameter: people having these role"
},
"page_customizable[filter_type_is_and]": {
"type": "boolean",
"description": "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][]": {
"type": "array",
"items": {
"type": "number"
},
"description": "IDs of child Customizable pages"
},
"page_customizable[cover_picture]": {
"type": "string",
"description": "Cover picture of the Customizable page"
},
"page_customizable[delete_picture]": {
"type": "boolean"
}
},
"required": [
"owner_id",
"page_customizable[url]"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Create Page Customizable
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"slug": {
"type": "string",
"description": "short name to access Customizable Page"
},
"identifier": {
"type": "string",
"description": "Defines feature page"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Customizable Page creation date"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Customizable Page last update date"
},
"menu_name": {
"type": "string",
"description": "Name of the tab"
},
"title": {
"type": "string",
"description": "Title of the Customizable Page"
},
"short_description": {
"type": "string",
"description": "Short Description of the Customizable Page"
},
"content": {
"type": "string",
"description": "Content of the Customizable Page"
},
"url": {
"type": "string",
"description": "Destination URL if it is an external link"
},
"external": {
"type": "boolean",
"description": "Is the Customizable Page an external link ?"
},
"seo_title": {
"type": "string",
"description": "SEO Title of the Customizable Page"
},
"seo_description": {
"type": "string",
"description": "SEO Description of the Cutomizable Page"
},
"enable_emphasize": {
"type": "boolean",
"description": "Dim the banner"
},
"open_in_new_tab": {
"type": "boolean",
"description": "Does the link opens in a new tab ?"
},
"draft": {
"type": "boolean",
"description": "Is the Customizable Page in draft mode or not"
},
"display_public": {
"type": "boolean",
"description": "Tab is displayed on public pages"
},
"display_private": {
"type": "boolean",
"description": "Tab is displayed on private pages"
},
"accessible_status": {
"type": "string",
"enum": [
"access_public",
"access_private",
"access_restricted"
],
"description": "Who can access the Customizable Page via URL; value 'access_restricted' enables filtering parameters"
},
"cover_picture": {
"type": "object",
"properties": {
"default-url": {
"type": "string",
"description": "Customizable Page default cover picture url"
},
"medium-url": {
"type": "string",
"description": "Customizable Page medium cover picture url"
}
},
"description": "URL of the Cover Picture"
},
"sub_network_ids": {
"type": "integer",
"format": "int32",
"description": "Filtering parameter: people belonging to these clusters / sub networks"
},
"memberships_type_ids": {
"type": "integer",
"format": "int32",
"description": "Filtering parameter: people having these kinds of memberships"
},
"role_ids": {
"type": "integer",
"format": "int32",
"description": "Filtering parameter: people having these role"
},
"filter_type_is_and": {
"type": "boolean",
"description": "Filtering parameters are using a OR logic if this param is FALSE. a AND logic is used if set to true"
},
"page_customizable_ids": {
"type": "integer",
"format": "int32",
"description": "IDs of child Customizable pages"
}
},
"description": "PageCustomizable model"
}Create Page CustomizablePOST/api/admin/v1/pages_customizable
Create a network Customizable Page.
GET /api/admin/v1/pages_customizable/id?locale=&owner=&owner_id=
Responses
Get Page Customizable
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"slug": {
"type": "string",
"description": "short name to access Customizable Page"
},
"identifier": {
"type": "string",
"description": "Defines feature page"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Customizable Page creation date"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Customizable Page last update date"
},
"menu_name": {
"type": "string",
"description": "Name of the tab"
},
"title": {
"type": "string",
"description": "Title of the Customizable Page"
},
"short_description": {
"type": "string",
"description": "Short Description of the Customizable Page"
},
"content": {
"type": "string",
"description": "Content of the Customizable Page"
},
"url": {
"type": "string",
"description": "Destination URL if it is an external link"
},
"external": {
"type": "boolean",
"description": "Is the Customizable Page an external link ?"
},
"seo_title": {
"type": "string",
"description": "SEO Title of the Customizable Page"
},
"seo_description": {
"type": "string",
"description": "SEO Description of the Cutomizable Page"
},
"enable_emphasize": {
"type": "boolean",
"description": "Dim the banner"
},
"open_in_new_tab": {
"type": "boolean",
"description": "Does the link opens in a new tab ?"
},
"draft": {
"type": "boolean",
"description": "Is the Customizable Page in draft mode or not"
},
"display_public": {
"type": "boolean",
"description": "Tab is displayed on public pages"
},
"display_private": {
"type": "boolean",
"description": "Tab is displayed on private pages"
},
"accessible_status": {
"type": "string",
"enum": [
"access_public",
"access_private",
"access_restricted"
],
"description": "Who can access the Customizable Page via URL; value 'access_restricted' enables filtering parameters"
},
"cover_picture": {
"type": "object",
"properties": {
"default-url": {
"type": "string",
"description": "Customizable Page default cover picture url"
},
"medium-url": {
"type": "string",
"description": "Customizable Page medium cover picture url"
}
},
"description": "URL of the Cover Picture"
},
"sub_network_ids": {
"type": "integer",
"format": "int32",
"description": "Filtering parameter: people belonging to these clusters / sub networks"
},
"memberships_type_ids": {
"type": "integer",
"format": "int32",
"description": "Filtering parameter: people having these kinds of memberships"
},
"role_ids": {
"type": "integer",
"format": "int32",
"description": "Filtering parameter: people having these role"
},
"filter_type_is_and": {
"type": "boolean",
"description": "Filtering parameters are using a OR logic if this param is FALSE. a AND logic is used if set to true"
},
"page_customizable_ids": {
"type": "integer",
"format": "int32",
"description": "IDs of child Customizable pages"
}
},
"description": "PageCustomizable model"
}Get Page CustomizableGET/api/admin/v1/pages_customizable/{id}{?locale,owner,owner_id}
Return a network Customizable Page using its id or slug.
URI Parameters
- id
string(required)- locale
string(required)- owner
string(required)- owner_id
number(required)
PUT /api/admin/v1/pages_customizable/id
Requests
Body
{
"locale": "Hello, world!",
"owner": "Hello, world!",
"owner_id": 1,
"page_customizable[external]": true,
"page_customizable[url]": "Hello, world!",
"page_customizable[delete_picture]": true,
"page_customizable[slug]": "Hello, world!",
"page_customizable[identifier]": "Hello, world!",
"page_customizable[created_at]": "Hello, world!",
"page_customizable[updated_at]": "Hello, world!",
"page_customizable[menu_name]": "Hello, world!",
"page_customizable[title]": "Hello, world!",
"page_customizable[short_description]": "Hello, world!",
"page_customizable[content]": "Hello, world!",
"page_customizable[seo_title]": "Hello, world!",
"page_customizable[seo_description]": "Hello, world!",
"page_customizable[enable_emphasize]": true,
"page_customizable[open_in_new_tab]": true,
"page_customizable[draft]": true,
"page_customizable[display_public]": true,
"page_customizable[display_private]": true,
"page_customizable[accessible_status]": "Hello, world!",
"page_customizable[sub_network_ids][]": [
1
],
"page_customizable[memberships_type_ids][]": [
1
],
"page_customizable[role_ids][]": [
1
],
"page_customizable[filter_type_is_and]": true,
"page_customizable[page_customizable_ids][]": [
1
],
"page_customizable[cover_picture]": "Hello, world!"
}Schema
{
"type": "object",
"properties": {
"locale": {
"type": "string"
},
"owner": {
"type": "string",
"default": "network"
},
"owner_id": {
"type": "number"
},
"page_customizable[external]": {
"type": "boolean",
"description": "Is the Customizable Page an external link ?"
},
"page_customizable[url]": {
"type": "string"
},
"page_customizable[delete_picture]": {
"type": "boolean"
},
"page_customizable[slug]": {
"type": "string",
"description": "short name to access Customizable Page"
},
"page_customizable[identifier]": {
"type": "string",
"description": "Defines feature page"
},
"page_customizable[created_at]": {
"type": "string",
"description": "Customizable Page creation date"
},
"page_customizable[updated_at]": {
"type": "string",
"description": "Customizable Page last update date"
},
"page_customizable[menu_name]": {
"type": "string",
"description": "Name of the tab"
},
"page_customizable[title]": {
"type": "string",
"description": "Title of the Customizable Page"
},
"page_customizable[short_description]": {
"type": "string",
"description": "Short Description of the Customizable Page"
},
"page_customizable[content]": {
"type": "string",
"description": "Content of the Customizable Page"
},
"page_customizable[seo_title]": {
"type": "string",
"description": "SEO Title of the Customizable Page"
},
"page_customizable[seo_description]": {
"type": "string",
"description": "SEO Description of the Cutomizable Page"
},
"page_customizable[enable_emphasize]": {
"type": "boolean",
"description": "Dim the banner"
},
"page_customizable[open_in_new_tab]": {
"type": "boolean",
"description": "Does the link opens in a new tab ?"
},
"page_customizable[draft]": {
"type": "boolean",
"description": "Is the Customizable Page in draft mode or not"
},
"page_customizable[display_public]": {
"type": "boolean",
"description": "Tab is displayed on public pages"
},
"page_customizable[display_private]": {
"type": "boolean",
"description": "Tab is displayed on private pages"
},
"page_customizable[accessible_status]": {
"type": "string",
"description": "Who can access the Customizable Page via URL; value 'access_restricted' enables filtering parameters"
},
"page_customizable[sub_network_ids][]": {
"type": "array",
"items": {
"type": "number"
},
"description": "Filtering parameter: people belonging to these clusters / sub networks"
},
"page_customizable[memberships_type_ids][]": {
"type": "array",
"items": {
"type": "number"
},
"description": "Filtering parameter: people having these kinds of memberships"
},
"page_customizable[role_ids][]": {
"type": "array",
"items": {
"type": "number"
},
"description": "Filtering parameter: people having these role"
},
"page_customizable[filter_type_is_and]": {
"type": "boolean",
"description": "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][]": {
"type": "array",
"items": {
"type": "number"
},
"description": "IDs of child Customizable pages"
},
"page_customizable[cover_picture]": {
"type": "string",
"description": "Cover picture of the Customizable page"
}
},
"required": [
"owner_id",
"page_customizable[url]"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Update Page Customizable
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"slug": {
"type": "string",
"description": "short name to access Customizable Page"
},
"identifier": {
"type": "string",
"description": "Defines feature page"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Customizable Page creation date"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Customizable Page last update date"
},
"menu_name": {
"type": "string",
"description": "Name of the tab"
},
"title": {
"type": "string",
"description": "Title of the Customizable Page"
},
"short_description": {
"type": "string",
"description": "Short Description of the Customizable Page"
},
"content": {
"type": "string",
"description": "Content of the Customizable Page"
},
"url": {
"type": "string",
"description": "Destination URL if it is an external link"
},
"external": {
"type": "boolean",
"description": "Is the Customizable Page an external link ?"
},
"seo_title": {
"type": "string",
"description": "SEO Title of the Customizable Page"
},
"seo_description": {
"type": "string",
"description": "SEO Description of the Cutomizable Page"
},
"enable_emphasize": {
"type": "boolean",
"description": "Dim the banner"
},
"open_in_new_tab": {
"type": "boolean",
"description": "Does the link opens in a new tab ?"
},
"draft": {
"type": "boolean",
"description": "Is the Customizable Page in draft mode or not"
},
"display_public": {
"type": "boolean",
"description": "Tab is displayed on public pages"
},
"display_private": {
"type": "boolean",
"description": "Tab is displayed on private pages"
},
"accessible_status": {
"type": "string",
"enum": [
"access_public",
"access_private",
"access_restricted"
],
"description": "Who can access the Customizable Page via URL; value 'access_restricted' enables filtering parameters"
},
"cover_picture": {
"type": "object",
"properties": {
"default-url": {
"type": "string",
"description": "Customizable Page default cover picture url"
},
"medium-url": {
"type": "string",
"description": "Customizable Page medium cover picture url"
}
},
"description": "URL of the Cover Picture"
},
"sub_network_ids": {
"type": "integer",
"format": "int32",
"description": "Filtering parameter: people belonging to these clusters / sub networks"
},
"memberships_type_ids": {
"type": "integer",
"format": "int32",
"description": "Filtering parameter: people having these kinds of memberships"
},
"role_ids": {
"type": "integer",
"format": "int32",
"description": "Filtering parameter: people having these role"
},
"filter_type_is_and": {
"type": "boolean",
"description": "Filtering parameters are using a OR logic if this param is FALSE. a AND logic is used if set to true"
},
"page_customizable_ids": {
"type": "integer",
"format": "int32",
"description": "IDs of child Customizable pages"
}
},
"description": "PageCustomizable model"
}Update Page CustomizablePUT/api/admin/v1/pages_customizable/{id}
Update a network Customizable Page using its id or slug.
URI Parameters
- id
string(required)
DELETE /api/admin/v1/pages_customizable/id
Responses
Delete Customizable Page
Delete Customizable PageDELETE/api/admin/v1/pages_customizable/{id}
Deletes the specified customizable page
URI Parameters
- id
string(required)
approvals ¶
Operations about approvals
GET /api/admin/v1/approvals
Responses
Get approvals list
Schema
{
"type": "object",
"properties": {
"approvals": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"email": {
"type": "string",
"description": "Email submitted"
},
"lastname": {
"type": "string",
"description": "Lastname submitted"
},
"firstname": {
"type": "string",
"description": "Firstname Submitted"
}
}
}
}
},
"description": "Approvals model"
}Get approvals listGET/api/admin/v1/approvals
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"
}URI Parameters
- page
string(required)Page of results to fetch.
- per_page
string(required)Number of results to return per page.
- filter
string(required)
GET /api/admin/v1/approvals/id
Responses
Get approval detail
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"email": {
"type": "string",
"description": "Email submitted"
},
"lastname": {
"type": "string",
"description": "Lastname submitted"
},
"firstname": {
"type": "string",
"description": "Firstname Submitted"
},
"maidenname": {
"type": "string",
"description": "maidenname submitted"
},
"honorary_title": {
"type": "string",
"enum": [
"mr",
"mrs",
"ms",
"dr",
"prof"
],
"description": "Honorary title submitted"
},
"gender": {
"type": "string",
"enum": [
"female",
"male",
"other"
],
"description": "gender (male/female/other) submitted"
},
"birthday": {
"type": "string",
"format": "date",
"description": "birthday submitted"
},
"birthplace": {
"type": "string",
"description": "birth place submitted"
},
"awards": {
"type": "string",
"description": "awards submitted"
},
"mobile_perso": {
"type": "string",
"description": "mobile perso number submitted"
},
"mobile_pro": {
"type": "string",
"description": "mobile pro number submitted"
},
"landline_perso": {
"type": "string",
"description": "landline perso number submitted"
},
"landline_pro": {
"type": "string",
"description": "landline pro number submitted"
},
"headline": {
"type": "string",
"description": "headline submitted"
},
"summary": {
"type": "string",
"description": "summary submitted"
},
"prefix_name": {
"type": "string",
"description": "prefix name submitted"
},
"suffix_name": {
"type": "string",
"description": "suffix name submitted"
},
"status": {
"type": "string",
"description": "status of the Request to join"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Request to join creation date time - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Request to join last update date time - iso8601"
},
"citizenship_country_codes": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of ISO-3166-2 citizenship country codes"
},
"sub_networks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"title": {
"type": "string",
"description": "Sub Network title"
}
},
"description": "SubNetwork model"
},
"description": "List of sub network names"
},
"industries": {
"description": "Industries linked to request to join",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"name": {
"type": "string",
"description": "Industry name"
}
}
},
"skills": {
"description": "Skills linked to request to join",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"name": {
"type": "string",
"description": "Skill name"
}
}
},
"custom_attributes": {
"type": "array",
"items": {
"type": "object"
},
"description": "Array of customizable attributes with name, value and type"
},
"user": {
"description": "User linked to request to join",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"email": {
"type": "string",
"description": "User email"
},
"name": {
"type": "string",
"description": "User full name"
},
"sub_network_ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": "IDs list of user sub networks"
},
"extended_updated_at": {
"type": "string",
"format": "date-time",
"description": "User full profile ( with experiences, educations, customs) last update date time - iso8601"
}
}
}
},
"description": "Approvals::Network model"
}Get approval detailGET/api/admin/v1/approvals/{id}
Get a specified approval request
URI Parameters
- id
number(required)
DELETE /api/admin/v1/approvals/id
Responses
Delete approval
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"email": {
"type": "string",
"description": "Email submitted"
},
"lastname": {
"type": "string",
"description": "Lastname submitted"
},
"firstname": {
"type": "string",
"description": "Firstname Submitted"
},
"maidenname": {
"type": "string",
"description": "maidenname submitted"
},
"honorary_title": {
"type": "string",
"enum": [
"mr",
"mrs",
"ms",
"dr",
"prof"
],
"description": "Honorary title submitted"
},
"gender": {
"type": "string",
"enum": [
"female",
"male",
"other"
],
"description": "gender (male/female/other) submitted"
},
"birthday": {
"type": "string",
"format": "date",
"description": "birthday submitted"
},
"birthplace": {
"type": "string",
"description": "birth place submitted"
},
"awards": {
"type": "string",
"description": "awards submitted"
},
"mobile_perso": {
"type": "string",
"description": "mobile perso number submitted"
},
"mobile_pro": {
"type": "string",
"description": "mobile pro number submitted"
},
"landline_perso": {
"type": "string",
"description": "landline perso number submitted"
},
"landline_pro": {
"type": "string",
"description": "landline pro number submitted"
},
"headline": {
"type": "string",
"description": "headline submitted"
},
"summary": {
"type": "string",
"description": "summary submitted"
},
"prefix_name": {
"type": "string",
"description": "prefix name submitted"
},
"suffix_name": {
"type": "string",
"description": "suffix name submitted"
},
"status": {
"type": "string",
"description": "status of the Request to join"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Request to join creation date time - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Request to join last update date time - iso8601"
},
"citizenship_country_codes": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of ISO-3166-2 citizenship country codes"
},
"sub_networks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"title": {
"type": "string",
"description": "Sub Network title"
}
},
"description": "SubNetwork model"
},
"description": "List of sub network names"
},
"industries": {
"description": "Industries linked to request to join",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"name": {
"type": "string",
"description": "Industry name"
}
}
},
"skills": {
"description": "Skills linked to request to join",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"name": {
"type": "string",
"description": "Skill name"
}
}
},
"custom_attributes": {
"type": "array",
"items": {
"type": "object"
},
"description": "Array of customizable attributes with name, value and type"
},
"user": {
"description": "User linked to request to join",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"email": {
"type": "string",
"description": "User email"
},
"name": {
"type": "string",
"description": "User full name"
},
"sub_network_ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": "IDs list of user sub networks"
},
"extended_updated_at": {
"type": "string",
"format": "date-time",
"description": "User full profile ( with experiences, educations, customs) last update date time - iso8601"
}
}
}
},
"description": "Approvals::Network model"
}Delete approvalDELETE/api/admin/v1/approvals/{id}
Delete the specified approval
URI Parameters
- id
number(required)
POST /api/admin/v1/approvals/id/reject
Requests
Body
{
"send_email": true
}Schema
{
"type": "object",
"properties": {
"send_email": {
"type": "boolean"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Reject request to join
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"email": {
"type": "string",
"description": "Email submitted"
},
"lastname": {
"type": "string",
"description": "Lastname submitted"
},
"firstname": {
"type": "string",
"description": "Firstname Submitted"
},
"maidenname": {
"type": "string",
"description": "maidenname submitted"
},
"honorary_title": {
"type": "string",
"enum": [
"mr",
"mrs",
"ms",
"dr",
"prof"
],
"description": "Honorary title submitted"
},
"gender": {
"type": "string",
"enum": [
"female",
"male",
"other"
],
"description": "gender (male/female/other) submitted"
},
"birthday": {
"type": "string",
"format": "date",
"description": "birthday submitted"
},
"birthplace": {
"type": "string",
"description": "birth place submitted"
},
"awards": {
"type": "string",
"description": "awards submitted"
},
"mobile_perso": {
"type": "string",
"description": "mobile perso number submitted"
},
"mobile_pro": {
"type": "string",
"description": "mobile pro number submitted"
},
"landline_perso": {
"type": "string",
"description": "landline perso number submitted"
},
"landline_pro": {
"type": "string",
"description": "landline pro number submitted"
},
"headline": {
"type": "string",
"description": "headline submitted"
},
"summary": {
"type": "string",
"description": "summary submitted"
},
"prefix_name": {
"type": "string",
"description": "prefix name submitted"
},
"suffix_name": {
"type": "string",
"description": "suffix name submitted"
},
"status": {
"type": "string",
"description": "status of the Request to join"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Request to join creation date time - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Request to join last update date time - iso8601"
},
"citizenship_country_codes": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of ISO-3166-2 citizenship country codes"
},
"sub_networks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"title": {
"type": "string",
"description": "Sub Network title"
}
},
"description": "SubNetwork model"
},
"description": "List of sub network names"
},
"industries": {
"description": "Industries linked to request to join",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"name": {
"type": "string",
"description": "Industry name"
}
}
},
"skills": {
"description": "Skills linked to request to join",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"name": {
"type": "string",
"description": "Skill name"
}
}
},
"custom_attributes": {
"type": "array",
"items": {
"type": "object"
},
"description": "Array of customizable attributes with name, value and type"
},
"user": {
"description": "User linked to request to join",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"email": {
"type": "string",
"description": "User email"
},
"name": {
"type": "string",
"description": "User full name"
},
"sub_network_ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": "IDs list of user sub networks"
},
"extended_updated_at": {
"type": "string",
"format": "date-time",
"description": "User full profile ( with experiences, educations, customs) last update date time - iso8601"
}
}
}
},
"description": "Approvals::Network model"
}Reject request to joinPOST/api/admin/v1/approvals/{id}/reject
Reject the approval request
URI Parameters
- id
number(required)
POST /api/admin/v1/approvals/id/approve
Requests
Body
{
"send_email": true,
"send_activation": true
}Schema
{
"type": "object",
"properties": {
"send_email": {
"type": "boolean"
},
"send_activation": {
"type": "boolean"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Approve request to join
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"email": {
"type": "string",
"description": "Email submitted"
},
"lastname": {
"type": "string",
"description": "Lastname submitted"
},
"firstname": {
"type": "string",
"description": "Firstname Submitted"
},
"maidenname": {
"type": "string",
"description": "maidenname submitted"
},
"honorary_title": {
"type": "string",
"enum": [
"mr",
"mrs",
"ms",
"dr",
"prof"
],
"description": "Honorary title submitted"
},
"gender": {
"type": "string",
"enum": [
"female",
"male",
"other"
],
"description": "gender (male/female/other) submitted"
},
"birthday": {
"type": "string",
"format": "date",
"description": "birthday submitted"
},
"birthplace": {
"type": "string",
"description": "birth place submitted"
},
"awards": {
"type": "string",
"description": "awards submitted"
},
"mobile_perso": {
"type": "string",
"description": "mobile perso number submitted"
},
"mobile_pro": {
"type": "string",
"description": "mobile pro number submitted"
},
"landline_perso": {
"type": "string",
"description": "landline perso number submitted"
},
"landline_pro": {
"type": "string",
"description": "landline pro number submitted"
},
"headline": {
"type": "string",
"description": "headline submitted"
},
"summary": {
"type": "string",
"description": "summary submitted"
},
"prefix_name": {
"type": "string",
"description": "prefix name submitted"
},
"suffix_name": {
"type": "string",
"description": "suffix name submitted"
},
"status": {
"type": "string",
"description": "status of the Request to join"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Request to join creation date time - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Request to join last update date time - iso8601"
},
"citizenship_country_codes": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of ISO-3166-2 citizenship country codes"
},
"sub_networks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"title": {
"type": "string",
"description": "Sub Network title"
}
},
"description": "SubNetwork model"
},
"description": "List of sub network names"
},
"industries": {
"description": "Industries linked to request to join",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"name": {
"type": "string",
"description": "Industry name"
}
}
},
"skills": {
"description": "Skills linked to request to join",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"name": {
"type": "string",
"description": "Skill name"
}
}
},
"custom_attributes": {
"type": "array",
"items": {
"type": "object"
},
"description": "Array of customizable attributes with name, value and type"
},
"user": {
"description": "User linked to request to join",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"email": {
"type": "string",
"description": "User email"
},
"name": {
"type": "string",
"description": "User full name"
},
"sub_network_ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": "IDs list of user sub networks"
},
"extended_updated_at": {
"type": "string",
"format": "date-time",
"description": "User full profile ( with experiences, educations, customs) last update date time - iso8601"
}
}
}
},
"description": "Approvals::Network model"
}Approve request to joinPOST/api/admin/v1/approvals/{id}/approve
Accept the approval request
URI Parameters
- id
number(required)
POST /api/admin/v1/approvals/id/link
Requests
Body
{
"send_email": true,
"user_id": "Hello, world!",
"key": "Hello, world!",
"send_activation": true
}Schema
{
"type": "object",
"properties": {
"send_email": {
"type": "boolean"
},
"user_id": {
"type": "string"
},
"key": {
"type": "string"
},
"send_activation": {
"type": "boolean"
}
},
"required": [
"user_id"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
link request to join to existing user
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"email": {
"type": "string",
"description": "Email submitted"
},
"lastname": {
"type": "string",
"description": "Lastname submitted"
},
"firstname": {
"type": "string",
"description": "Firstname Submitted"
},
"maidenname": {
"type": "string",
"description": "maidenname submitted"
},
"honorary_title": {
"type": "string",
"enum": [
"mr",
"mrs",
"ms",
"dr",
"prof"
],
"description": "Honorary title submitted"
},
"gender": {
"type": "string",
"enum": [
"female",
"male",
"other"
],
"description": "gender (male/female/other) submitted"
},
"birthday": {
"type": "string",
"format": "date",
"description": "birthday submitted"
},
"birthplace": {
"type": "string",
"description": "birth place submitted"
},
"awards": {
"type": "string",
"description": "awards submitted"
},
"mobile_perso": {
"type": "string",
"description": "mobile perso number submitted"
},
"mobile_pro": {
"type": "string",
"description": "mobile pro number submitted"
},
"landline_perso": {
"type": "string",
"description": "landline perso number submitted"
},
"landline_pro": {
"type": "string",
"description": "landline pro number submitted"
},
"headline": {
"type": "string",
"description": "headline submitted"
},
"summary": {
"type": "string",
"description": "summary submitted"
},
"prefix_name": {
"type": "string",
"description": "prefix name submitted"
},
"suffix_name": {
"type": "string",
"description": "suffix name submitted"
},
"status": {
"type": "string",
"description": "status of the Request to join"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Request to join creation date time - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Request to join last update date time - iso8601"
},
"citizenship_country_codes": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of ISO-3166-2 citizenship country codes"
},
"sub_networks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"title": {
"type": "string",
"description": "Sub Network title"
}
},
"description": "SubNetwork model"
},
"description": "List of sub network names"
},
"industries": {
"description": "Industries linked to request to join",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"name": {
"type": "string",
"description": "Industry name"
}
}
},
"skills": {
"description": "Skills linked to request to join",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"name": {
"type": "string",
"description": "Skill name"
}
}
},
"custom_attributes": {
"type": "array",
"items": {
"type": "object"
},
"description": "Array of customizable attributes with name, value and type"
},
"user": {
"description": "User linked to request to join",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"email": {
"type": "string",
"description": "User email"
},
"name": {
"type": "string",
"description": "User full name"
},
"sub_network_ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": "IDs list of user sub networks"
},
"extended_updated_at": {
"type": "string",
"format": "date-time",
"description": "User full profile ( with experiences, educations, customs) last update date time - iso8601"
}
}
}
},
"description": "Approvals::Network model"
}link request to join to existing userPOST/api/admin/v1/approvals/{id}/link
Link the approval to an existing user
URI Parameters
- id
number(required)
versions ¶
Operations about versions
GET /api/admin/v1/versions/deleted
Responses
Get deleted items
Schema
{
"type": "object",
"properties": {
"item_id": {
"type": "integer",
"format": "int32",
"description": "ID of the item on which the event occured"
},
"item_type": {
"type": "string",
"description": "Type of the item on which the event occured"
},
"event": {
"type": "string",
"description": "Type of event (deletion)"
},
"action_by": {
"type": "object",
"description": "Identity of the person having performed the action"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Date when the event occured - iso8601."
}
},
"description": "Version model"
}Get deleted itemsGET/api/admin/v1/versions/deleted
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"
}URI Parameters
- page
string(required)Page of results to fetch.
- per_page
string(required)Number of results to return per page.
- deleted_since
string(required)
network_events ¶
Operations about network_events
GET /api/admin/v2/network_events/tickets
Responses
Ticket Index
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of this Ticket Event"
},
"event_id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of this Ticket Event"
},
"description": {
"type": "string",
"description": "Ticket Event Description"
},
"name": {
"type": "string",
"description": "Ticket Event Name"
},
"price": {
"type": "number",
"format": "float",
"description": "Ticket Event price"
},
"number": {
"type": "integer",
"format": "int32",
"description": "Number of tickets for the event"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Ticket Event creation date - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Ticket Event update date - iso8601"
},
"currency": {
"type": "string",
"description": "ISO code of the Currency of the Ticket Event"
},
"internal_ticket": {
"type": "boolean",
"description": "Are visitors restricted from buying this Ticket Event ?"
},
"maximum_per_person": {
"type": "integer",
"format": "int32",
"description": "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"
},
"expiry_date": {
"type": "string",
"format": "date-time",
"description": "Ticket Event expiration date (people won't be able to buy ) - iso8601"
},
"discarded_at": {
"type": "string",
"format": "date-time",
"description": "Ticket Event discard date (people can't buy tickets discarded) - iso8601"
},
"attendee_ids": {
"type": "integer",
"format": "int32",
"description": "Attendees of this Ticket Event"
},
"customizable_attribute_ids": {
"type": "integer",
"format": "int32",
"description": "Customizable Attributes set for this Network Event"
}
},
"description": "TicketEntity model"
}Ticket IndexGET/api/admin/v2/network_events/tickets
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"
}URI Parameters
- event_id
string(required)- updated_since
string(required)
GET /api/admin/v2/network_events/tickets/id
Responses
Ticket Details
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of this Ticket Event"
},
"event_id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of this Ticket Event"
},
"description": {
"type": "string",
"description": "Ticket Event Description"
},
"name": {
"type": "string",
"description": "Ticket Event Name"
},
"price": {
"type": "number",
"format": "float",
"description": "Ticket Event price"
},
"number": {
"type": "integer",
"format": "int32",
"description": "Number of tickets for the event"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Ticket Event creation date - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Ticket Event update date - iso8601"
},
"currency": {
"type": "string",
"description": "ISO code of the Currency of the Ticket Event"
},
"internal_ticket": {
"type": "boolean",
"description": "Are visitors restricted from buying this Ticket Event ?"
},
"maximum_per_person": {
"type": "integer",
"format": "int32",
"description": "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"
},
"expiry_date": {
"type": "string",
"format": "date-time",
"description": "Ticket Event expiration date (people won't be able to buy ) - iso8601"
},
"discarded_at": {
"type": "string",
"format": "date-time",
"description": "Ticket Event discard date (people can't buy tickets discarded) - iso8601"
},
"attendee_ids": {
"type": "integer",
"format": "int32",
"description": "Attendees of this Ticket Event"
},
"customizable_attribute_ids": {
"type": "integer",
"format": "int32",
"description": "Customizable Attributes set for this Network Event"
}
},
"description": "TicketEntity model"
}Ticket DetailsGET/api/admin/v2/network_events/tickets/{id}
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.
URI Parameters
- id
number(required)
DELETE /api/admin/v2/network_events/tickets/id
Responses
Ticket Deletion
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of this Ticket Event"
},
"event_id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of this Ticket Event"
},
"description": {
"type": "string",
"description": "Ticket Event Description"
},
"name": {
"type": "string",
"description": "Ticket Event Name"
},
"price": {
"type": "number",
"format": "float",
"description": "Ticket Event price"
},
"number": {
"type": "integer",
"format": "int32",
"description": "Number of tickets for the event"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Ticket Event creation date - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Ticket Event update date - iso8601"
},
"currency": {
"type": "string",
"description": "ISO code of the Currency of the Ticket Event"
},
"internal_ticket": {
"type": "boolean",
"description": "Are visitors restricted from buying this Ticket Event ?"
},
"maximum_per_person": {
"type": "integer",
"format": "int32",
"description": "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"
},
"expiry_date": {
"type": "string",
"format": "date-time",
"description": "Ticket Event expiration date (people won't be able to buy ) - iso8601"
},
"discarded_at": {
"type": "string",
"format": "date-time",
"description": "Ticket Event discard date (people can't buy tickets discarded) - iso8601"
},
"attendee_ids": {
"type": "integer",
"format": "int32",
"description": "Attendees of this Ticket Event"
},
"customizable_attribute_ids": {
"type": "integer",
"format": "int32",
"description": "Customizable Attributes set for this Network Event"
}
},
"description": "TicketEntity model"
}Ticket DeletionDELETE/api/admin/v2/network_events/tickets/{id}
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.
URI Parameters
- id
number(required)
PUT /api/admin/v2/network_events/tickets/id
Requests
Body
{
"ticket[description]": "Hello, world!",
"ticket[name]": "Hello, world!",
"ticket[price]": 1,
"ticket[number]": 1,
"ticket[currency]": "Hello, world!",
"ticket[internal_ticket]": true,
"ticket[maximum_per_person]": 1,
"ticket[expiry_date]": "Hello, world!"
}Schema
{
"type": "object",
"properties": {
"ticket[description]": {
"type": "string",
"description": "Ticket Event Description"
},
"ticket[name]": {
"type": "string",
"description": "Ticket Event Name"
},
"ticket[price]": {
"type": "number",
"description": "Ticket Event price"
},
"ticket[number]": {
"type": "number",
"description": "Number of tickets for the event"
},
"ticket[currency]": {
"type": "string",
"description": "ISO code of the Currency of the Ticket Event"
},
"ticket[internal_ticket]": {
"type": "boolean",
"description": "Are visitors restricted from buying this Ticket Event ?"
},
"ticket[maximum_per_person]": {
"type": "number",
"description": "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]": {
"type": "string",
"description": "Ticket Event expiration date (people won't be able to buy ) - iso8601"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Ticket Update
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of this Ticket Event"
},
"event_id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of this Ticket Event"
},
"description": {
"type": "string",
"description": "Ticket Event Description"
},
"name": {
"type": "string",
"description": "Ticket Event Name"
},
"price": {
"type": "number",
"format": "float",
"description": "Ticket Event price"
},
"number": {
"type": "integer",
"format": "int32",
"description": "Number of tickets for the event"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Ticket Event creation date - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Ticket Event update date - iso8601"
},
"currency": {
"type": "string",
"description": "ISO code of the Currency of the Ticket Event"
},
"internal_ticket": {
"type": "boolean",
"description": "Are visitors restricted from buying this Ticket Event ?"
},
"maximum_per_person": {
"type": "integer",
"format": "int32",
"description": "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"
},
"expiry_date": {
"type": "string",
"format": "date-time",
"description": "Ticket Event expiration date (people won't be able to buy ) - iso8601"
},
"discarded_at": {
"type": "string",
"format": "date-time",
"description": "Ticket Event discard date (people can't buy tickets discarded) - iso8601"
},
"attendee_ids": {
"type": "integer",
"format": "int32",
"description": "Attendees of this Ticket Event"
},
"customizable_attribute_ids": {
"type": "integer",
"format": "int32",
"description": "Customizable Attributes set for this Network Event"
}
},
"description": "TicketEntity model"
}Ticket UpdatePUT/api/admin/v2/network_events/tickets/{id}
Ticket Update
URI Parameters
- id
number(required)
POST /api/admin/v2/network_events/tickets/ticket_id/customizable_attributes/link
Requests
Body
{
"customizable_attribute_id": "Hello, world!"
}Schema
{
"type": "object",
"properties": {
"customizable_attribute_id": {
"type": "string"
}
},
"required": [
"customizable_attribute_id"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Customization Attribute Link
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"customizable_id": {
"type": "integer",
"format": "int32",
"description": "Customizable ID"
},
"type": {
"type": "string",
"enum": [
"CustomizableAttribute::Boolean",
"CustomizableAttribute::Date",
"CustomizableAttribute::DoubleSelect",
"CustomizableAttribute::Number",
"CustomizableAttribute::Select",
"CustomizableAttribute::Text"
],
"description": "Customizable Attribute type"
},
"customizable_type": {
"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",
"mentorships",
"mentorships_mentee",
"mentorships_mentor",
"ne_event",
"ne_ticket",
"topic_approval",
"topic_mentorships",
"topic_mentorships_mentee",
"topic_mentorships_mentor",
"user",
"ventures_venture"
],
"description": "Customizable Attribute associated model (User, Experience)"
},
"name": {
"type": "string",
"description": "Customizable Attribute name"
},
"display_name": {
"type": "string",
"description": "Customizable Attribute displayed name"
},
"tooltip": {
"type": "string",
"description": "Customizable Attribute tooltip"
},
"placeholder": {
"type": "string",
"description": "Customizable Attribute placeholder"
},
"multi": {
"type": "boolean",
"description": "Customizable Attribute multi activated ?"
},
"text_size": {
"type": "integer",
"format": "int32",
"description": "Customizable Attribute text_size"
},
"visibility": {
"type": "string",
"enum": [
"admin_only",
"tagged_user",
"everybody",
"not_visible"
],
"description": "Customizable Attribute visibility"
},
"user_editable": {
"type": "boolean",
"description": "Customizable Attribute editable by the user ?"
},
"required": {
"type": "boolean",
"description": "Customizable Attribute required ?"
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "Customizable Attribute array of options"
},
"json_options": {
"type": "object",
"description": "Customizable Attribute json options (for double select)"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Customizable Attribute creation date"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Customizable Attribute last update date"
},
"selected_value": {
"type": "string",
"description": "Customizable Attribute selected value"
}
},
"description": "CustomizableAttribute model"
}Customization Attribute LinkPOST/api/admin/v2/network_events/tickets/{ticket_id}/customizable_attributes/link
Link
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.
URI Parameters
- ticket_id
string(required)
DELETE /api/admin/v2/network_events/tickets/ticket_id/customizable_attributes/id
Responses
Customizable Attribute Unlink
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"customizable_id": {
"type": "integer",
"format": "int32",
"description": "Customizable ID"
},
"type": {
"type": "string",
"enum": [
"CustomizableAttribute::Boolean",
"CustomizableAttribute::Date",
"CustomizableAttribute::DoubleSelect",
"CustomizableAttribute::Number",
"CustomizableAttribute::Select",
"CustomizableAttribute::Text"
],
"description": "Customizable Attribute type"
},
"customizable_type": {
"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",
"mentorships",
"mentorships_mentee",
"mentorships_mentor",
"ne_event",
"ne_ticket",
"topic_approval",
"topic_mentorships",
"topic_mentorships_mentee",
"topic_mentorships_mentor",
"user",
"ventures_venture"
],
"description": "Customizable Attribute associated model (User, Experience)"
},
"name": {
"type": "string",
"description": "Customizable Attribute name"
},
"display_name": {
"type": "string",
"description": "Customizable Attribute displayed name"
},
"tooltip": {
"type": "string",
"description": "Customizable Attribute tooltip"
},
"placeholder": {
"type": "string",
"description": "Customizable Attribute placeholder"
},
"multi": {
"type": "boolean",
"description": "Customizable Attribute multi activated ?"
},
"text_size": {
"type": "integer",
"format": "int32",
"description": "Customizable Attribute text_size"
},
"visibility": {
"type": "string",
"enum": [
"admin_only",
"tagged_user",
"everybody",
"not_visible"
],
"description": "Customizable Attribute visibility"
},
"user_editable": {
"type": "boolean",
"description": "Customizable Attribute editable by the user ?"
},
"required": {
"type": "boolean",
"description": "Customizable Attribute required ?"
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "Customizable Attribute array of options"
},
"json_options": {
"type": "object",
"description": "Customizable Attribute json options (for double select)"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Customizable Attribute creation date"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Customizable Attribute last update date"
},
"selected_value": {
"type": "string",
"description": "Customizable Attribute selected value"
}
},
"description": "CustomizableAttribute model"
}Customizable Attribute UnlinkDELETE/api/admin/v2/network_events/tickets/{ticket_id}/customizable_attributes/{id}
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.
URI Parameters
- ticket_id
number(required)- id
string(required)
POST /api/admin/v2/network_events/event_id/tickets
Requests
Body
{
"ticket[name]": "Hello, world!",
"ticket[price]": 1,
"ticket[currency]": "Hello, world!",
"ticket[number]": 1,
"ticket[description]": "Hello, world!",
"ticket[internal_ticket]": true,
"ticket[maximum_per_person]": 1,
"ticket[expiry_date]": "Hello, world!"
}Schema
{
"type": "object",
"properties": {
"ticket[name]": {
"type": "string"
},
"ticket[price]": {
"type": "number"
},
"ticket[currency]": {
"type": "string"
},
"ticket[number]": {
"type": "number"
},
"ticket[description]": {
"type": "string",
"description": "Ticket Event Description"
},
"ticket[internal_ticket]": {
"type": "boolean",
"description": "Are visitors restricted from buying this Ticket Event ?"
},
"ticket[maximum_per_person]": {
"type": "number",
"description": "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]": {
"type": "string",
"description": "Ticket Event expiration date (people won't be able to buy ) - iso8601"
}
},
"required": [
"ticket[name]",
"ticket[price]",
"ticket[currency]",
"ticket[number]"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Ticket Creation
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of this Ticket Event"
},
"event_id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of this Ticket Event"
},
"description": {
"type": "string",
"description": "Ticket Event Description"
},
"name": {
"type": "string",
"description": "Ticket Event Name"
},
"price": {
"type": "number",
"format": "float",
"description": "Ticket Event price"
},
"number": {
"type": "integer",
"format": "int32",
"description": "Number of tickets for the event"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Ticket Event creation date - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Ticket Event update date - iso8601"
},
"currency": {
"type": "string",
"description": "ISO code of the Currency of the Ticket Event"
},
"internal_ticket": {
"type": "boolean",
"description": "Are visitors restricted from buying this Ticket Event ?"
},
"maximum_per_person": {
"type": "integer",
"format": "int32",
"description": "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"
},
"expiry_date": {
"type": "string",
"format": "date-time",
"description": "Ticket Event expiration date (people won't be able to buy ) - iso8601"
},
"discarded_at": {
"type": "string",
"format": "date-time",
"description": "Ticket Event discard date (people can't buy tickets discarded) - iso8601"
},
"attendee_ids": {
"type": "integer",
"format": "int32",
"description": "Attendees of this Ticket Event"
},
"customizable_attribute_ids": {
"type": "integer",
"format": "int32",
"description": "Customizable Attributes set for this Network Event"
}
},
"description": "TicketEntity model"
}Ticket CreationPOST/api/admin/v2/network_events/{event_id}/tickets
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’.
URI Parameters
- event_id
number(required)
GET /api/admin/v2/network_events/bookings
Responses
Booking Index
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of this Booking"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "User ID for this Booking"
},
"receipt_id": {
"type": "integer",
"format": "int32",
"description": "Receipt ID linked to this Booking"
},
"firstname": {
"type": "string",
"description": "Firstname"
},
"lastname": {
"type": "string",
"description": "Lastname"
},
"email": {
"type": "string",
"description": "Email"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Booking creation date - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Booking update date - iso8601"
},
"payment_status": {
"type": "string",
"enum": [
"paid",
"not_paid",
"refunded",
"cancelled",
"cancelled_by_admin"
],
"description": "Payment status of the Booking"
},
"cancelled_at": {
"type": "string",
"format": "date-time",
"description": "Booking cancellation date - iso8601"
},
"added_by_admin": {
"type": "boolean",
"description": "Added by an admin"
},
"added_by_admin_id": {
"type": "integer",
"format": "int32",
"description": "ID of the admin who add the user to this booking"
},
"attendee_ids": {
"type": "integer",
"format": "int32",
"description": "Attendees of this Booking"
}
},
"description": "BookingEntity model"
}Booking IndexGET/api/admin/v2/network_events/bookings
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"
}URI Parameters
- event_id
string(required)- updated_since
string(required)
GET /api/admin/v2/network_events/bookings/id
Responses
Booking Details
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of this Booking"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "User ID for this Booking"
},
"receipt_id": {
"type": "integer",
"format": "int32",
"description": "Receipt ID linked to this Booking"
},
"firstname": {
"type": "string",
"description": "Firstname"
},
"lastname": {
"type": "string",
"description": "Lastname"
},
"email": {
"type": "string",
"description": "Email"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Booking creation date - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Booking update date - iso8601"
},
"payment_status": {
"type": "string",
"enum": [
"paid",
"not_paid",
"refunded",
"cancelled",
"cancelled_by_admin"
],
"description": "Payment status of the Booking"
},
"cancelled_at": {
"type": "string",
"format": "date-time",
"description": "Booking cancellation date - iso8601"
},
"added_by_admin": {
"type": "boolean",
"description": "Added by an admin"
},
"added_by_admin_id": {
"type": "integer",
"format": "int32",
"description": "ID of the admin who add the user to this booking"
},
"attendee_ids": {
"type": "integer",
"format": "int32",
"description": "Attendees of this Booking"
}
},
"description": "BookingEntity model"
}Booking DetailsGET/api/admin/v2/network_events/bookings/{id}
Get a booking
Attendees can be retrieved on /api/admin/v2/network_events/attendees
URI Parameters
- id
number(required)
DELETE /api/admin/v2/network_events/bookings/id
Responses
Booking Deletion
Booking DeletionDELETE/api/admin/v2/network_events/bookings/{id}
Deletes a booking
Deletes the booking object and all the attendees attached to it.
URI Parameters
- id
number(required)
PUT /api/admin/v2/network_events/bookings/id
Requests
Body
{
"booking[attendees][][id]": [
1
],
"booking[attendees][][customizable_attributes][]": [],
"booking[attendees][][firstname]": [],
"booking[attendees][][lastname]": [],
"booking[attendees][][email]": [],
"booking[attendees][][company_name]": [],
"booking[attendees][][mobile_phone]": [],
"booking[attendees][][custom_field_1]": [],
"booking[attendees][][custom_field_2]": [],
"booking[attendees][][custom_field_3]": [],
"booking[attendees][][participation_status]": [],
"booking[attendees][][note]": [],
"booking[attendees][][booking_id]": [
1
],
"booking[user_id]": 1,
"booking[firstname]": "Hello, world!",
"booking[lastname]": "Hello, world!",
"booking[email]": "Hello, world!",
"booking[payment_status]": "Hello, world!",
"booking[added_by_admin]": true,
"booking[added_by_admin_id]": 1
}Schema
{
"type": "object",
"properties": {
"booking[attendees][][id]": {
"type": "array",
"items": {
"type": "number"
}
},
"booking[attendees][][customizable_attributes][]": {
"type": "array",
"description": "+"
},
"booking[attendees][][firstname]": {
"type": "array",
"description": "Firstname\n\n+"
},
"booking[attendees][][lastname]": {
"type": "array",
"description": "Lastname\n\n+"
},
"booking[attendees][][email]": {
"type": "array",
"description": "Email\n\n+"
},
"booking[attendees][][company_name]": {
"type": "array",
"description": "Organization name\n\n+"
},
"booking[attendees][][mobile_phone]": {
"type": "array",
"description": "Phone number\n\n+"
},
"booking[attendees][][custom_field_1]": {
"type": "array",
"description": "Ticket custom field 1\n\n+"
},
"booking[attendees][][custom_field_2]": {
"type": "array",
"description": "Ticket custom field 2\n\n+"
},
"booking[attendees][][custom_field_3]": {
"type": "array",
"description": "Ticket custom field 3\n\n+"
},
"booking[attendees][][participation_status]": {
"type": "array",
"description": "Participation status of the Attendee\n\n+"
},
"booking[attendees][][note]": {
"type": "array",
"description": "Note regarding the Attendee\n\n+"
},
"booking[attendees][][booking_id]": {
"type": "array",
"items": {
"type": "number"
},
"description": "ID of the booking"
},
"booking[user_id]": {
"type": "number",
"description": "User ID for this Booking"
},
"booking[firstname]": {
"type": "string",
"description": "Firstname"
},
"booking[lastname]": {
"type": "string",
"description": "Lastname"
},
"booking[email]": {
"type": "string",
"description": "Email"
},
"booking[payment_status]": {
"type": "string",
"description": "Payment status of the Booking"
},
"booking[added_by_admin]": {
"type": "boolean",
"description": "Added by an admin"
},
"booking[added_by_admin_id]": {
"type": "number",
"description": "ID of the admin who add the user to this booking"
}
},
"required": [
"booking[attendees][][id]"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Booking Update
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of this Booking"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "User ID for this Booking"
},
"receipt_id": {
"type": "integer",
"format": "int32",
"description": "Receipt ID linked to this Booking"
},
"firstname": {
"type": "string",
"description": "Firstname"
},
"lastname": {
"type": "string",
"description": "Lastname"
},
"email": {
"type": "string",
"description": "Email"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Booking creation date - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Booking update date - iso8601"
},
"payment_status": {
"type": "string",
"enum": [
"paid",
"not_paid",
"refunded",
"cancelled",
"cancelled_by_admin"
],
"description": "Payment status of the Booking"
},
"cancelled_at": {
"type": "string",
"format": "date-time",
"description": "Booking cancellation date - iso8601"
},
"added_by_admin": {
"type": "boolean",
"description": "Added by an admin"
},
"added_by_admin_id": {
"type": "integer",
"format": "int32",
"description": "ID of the admin who add the user to this booking"
},
"attendee_ids": {
"type": "integer",
"format": "int32",
"description": "Attendees of this Booking"
}
},
"description": "BookingEntity model"
}Booking UpdatePUT/api/admin/v2/network_events/bookings/{id}
Booking Update
URI Parameters
- id
number(required)
POST /api/admin/v2/network_events/event_id/bookings
Requests
Body
{
"booking[user_id]": 1,
"booking[firstname]": "Hello, world!",
"booking[lastname]": "Hello, world!",
"booking[email]": "Hello, world!",
"booking[attendees][][user_id]": [
1
],
"booking[attendees][][firstname]": [],
"booking[attendees][][lastname]": [],
"booking[attendees][][email]": [],
"booking[attendees][][customizable_attributes][]": [],
"booking[attendees][][company_name]": [],
"booking[attendees][][mobile_phone]": [],
"booking[attendees][][custom_field_1]": [],
"booking[attendees][][custom_field_2]": [],
"booking[attendees][][custom_field_3]": [],
"booking[attendees][][participation_status]": [],
"booking[attendees][][note]": [],
"booking[attendees][][ticket_id]": [
1
],
"booking[attendees][][booking_id]": [
1
],
"booking[attendees][][event_id]": [
1
],
"booking[payment_status]": "Hello, world!",
"booking[added_by_admin]": true,
"booking[added_by_admin_id]": 1
}Schema
{
"type": "object",
"properties": {
"booking[user_id]": {
"type": "number"
},
"booking[firstname]": {
"type": "string"
},
"booking[lastname]": {
"type": "string"
},
"booking[email]": {
"type": "string"
},
"booking[attendees][][user_id]": {
"type": "array",
"items": {
"type": "number"
}
},
"booking[attendees][][firstname]": {
"type": "array",
"description": "+"
},
"booking[attendees][][lastname]": {
"type": "array",
"description": "+"
},
"booking[attendees][][email]": {
"type": "array",
"description": "+"
},
"booking[attendees][][customizable_attributes][]": {
"type": "array",
"description": "+"
},
"booking[attendees][][company_name]": {
"type": "array",
"description": "Organization name\n\n+"
},
"booking[attendees][][mobile_phone]": {
"type": "array",
"description": "Phone number\n\n+"
},
"booking[attendees][][custom_field_1]": {
"type": "array",
"description": "Ticket custom field 1\n\n+"
},
"booking[attendees][][custom_field_2]": {
"type": "array",
"description": "Ticket custom field 2\n\n+"
},
"booking[attendees][][custom_field_3]": {
"type": "array",
"description": "Ticket custom field 3\n\n+"
},
"booking[attendees][][participation_status]": {
"type": "array",
"description": "Participation status of the Attendee\n\n+"
},
"booking[attendees][][note]": {
"type": "array",
"description": "Note regarding the Attendee\n\n+"
},
"booking[attendees][][ticket_id]": {
"type": "array",
"items": {
"type": "number"
},
"description": "ID of the ticket purchased"
},
"booking[attendees][][booking_id]": {
"type": "array",
"items": {
"type": "number"
},
"description": "ID of the booking"
},
"booking[attendees][][event_id]": {
"type": "array",
"items": {
"type": "number"
},
"description": "Event ID attended"
},
"booking[payment_status]": {
"type": "string",
"description": "Payment status of the Booking"
},
"booking[added_by_admin]": {
"type": "boolean",
"description": "Added by an admin"
},
"booking[added_by_admin_id]": {
"type": "number",
"description": "ID of the admin who add the user to this booking"
}
},
"required": [
"booking[firstname]",
"booking[lastname]",
"booking[email]",
"booking[attendees][][firstname]",
"booking[attendees][][lastname]",
"booking[attendees][][email]"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Booking Creation
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of this Booking"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "User ID for this Booking"
},
"receipt_id": {
"type": "integer",
"format": "int32",
"description": "Receipt ID linked to this Booking"
},
"firstname": {
"type": "string",
"description": "Firstname"
},
"lastname": {
"type": "string",
"description": "Lastname"
},
"email": {
"type": "string",
"description": "Email"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Booking creation date - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Booking update date - iso8601"
},
"payment_status": {
"type": "string",
"enum": [
"paid",
"not_paid",
"refunded",
"cancelled",
"cancelled_by_admin"
],
"description": "Payment status of the Booking"
},
"cancelled_at": {
"type": "string",
"format": "date-time",
"description": "Booking cancellation date - iso8601"
},
"added_by_admin": {
"type": "boolean",
"description": "Added by an admin"
},
"added_by_admin_id": {
"type": "integer",
"format": "int32",
"description": "ID of the admin who add the user to this booking"
},
"attendee_ids": {
"type": "integer",
"format": "int32",
"description": "Attendees of this Booking"
}
},
"description": "BookingEntity model"
}Booking CreationPOST/api/admin/v2/network_events/{event_id}/bookings
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
]
}
]URI Parameters
- event_id
number(required)
GET /api/admin/v2/network_events/attendees
Responses
Attendees Index
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of this Attendee"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "User ID for this Attendee"
},
"firstname": {
"type": "string",
"description": "Firstname"
},
"lastname": {
"type": "string",
"description": "Lastname"
},
"email": {
"type": "string",
"description": "Email"
},
"company_name": {
"type": "string",
"description": "Organization name"
},
"mobile_phone": {
"type": "string",
"description": "Phone number"
},
"custom_field_1": {
"type": "string",
"description": "Ticket custom field 1"
},
"custom_field_2": {
"type": "string",
"description": "Ticket custom field 2"
},
"custom_field_3": {
"type": "string",
"description": "Ticket custom field 3"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Attendee creation date - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Attendee update date - iso8601"
},
"participation_status": {
"type": "string",
"enum": [
"planned",
"show",
"no_show",
"canceled",
"cancelled_by_admin",
"refunded"
],
"description": "Participation status of the Attendee"
},
"note": {
"type": "string",
"description": "Note regarding the Attendee"
},
"ticket_id": {
"type": "integer",
"format": "int32",
"description": "ID of the ticket purchased"
},
"booking_id": {
"type": "integer",
"format": "int32",
"description": "ID of the booking"
},
"event_id": {
"type": "integer",
"format": "int32",
"description": "Event ID attended"
},
"customizable_attributes": {
"type": "array",
"items": {
"type": "object"
},
"description": "Array of customizable attributes with name and value"
}
},
"description": "AttendeeEntity model"
}Attendees IndexGET/api/admin/v2/network_events/attendees
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"
}URI Parameters
- event_id
string(required)- booking_id
string(required)- updated_since
string(required)
GET /api/admin/v2/network_events/attendees/id
Responses
Attendee Details
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of this Attendee"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "User ID for this Attendee"
},
"firstname": {
"type": "string",
"description": "Firstname"
},
"lastname": {
"type": "string",
"description": "Lastname"
},
"email": {
"type": "string",
"description": "Email"
},
"company_name": {
"type": "string",
"description": "Organization name"
},
"mobile_phone": {
"type": "string",
"description": "Phone number"
},
"custom_field_1": {
"type": "string",
"description": "Ticket custom field 1"
},
"custom_field_2": {
"type": "string",
"description": "Ticket custom field 2"
},
"custom_field_3": {
"type": "string",
"description": "Ticket custom field 3"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Attendee creation date - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Attendee update date - iso8601"
},
"participation_status": {
"type": "string",
"enum": [
"planned",
"show",
"no_show",
"canceled",
"cancelled_by_admin",
"refunded"
],
"description": "Participation status of the Attendee"
},
"note": {
"type": "string",
"description": "Note regarding the Attendee"
},
"ticket_id": {
"type": "integer",
"format": "int32",
"description": "ID of the ticket purchased"
},
"booking_id": {
"type": "integer",
"format": "int32",
"description": "ID of the booking"
},
"event_id": {
"type": "integer",
"format": "int32",
"description": "Event ID attended"
},
"customizable_attributes": {
"type": "array",
"items": {
"type": "object"
},
"description": "Array of customizable attributes with name and value"
}
},
"description": "AttendeeEntity model"
}Attendee DetailsGET/api/admin/v2/network_events/attendees/{id}
Get an Attendee
URI Parameters
- id
number(required)
DELETE /api/admin/v2/network_events/attendees/id
Responses
Attendee Deletion
Attendee DeletionDELETE/api/admin/v2/network_events/attendees/{id}
Delete an Attendee
Delete the attendee from the booking.
URI Parameters
- id
number(required)
PUT /api/admin/v2/network_events/attendees/id
Requests
Body
{
"attendee[customizable_attributes][]": [],
"attendee[firstname]": "Hello, world!",
"attendee[lastname]": "Hello, world!",
"attendee[email]": "Hello, world!",
"attendee[company_name]": "Hello, world!",
"attendee[mobile_phone]": "Hello, world!",
"attendee[custom_field_1]": "Hello, world!",
"attendee[custom_field_2]": "Hello, world!",
"attendee[custom_field_3]": "Hello, world!",
"attendee[participation_status]": "Hello, world!",
"attendee[note]": "Hello, world!"
}Schema
{
"type": "object",
"properties": {
"attendee[customizable_attributes][]": {
"type": "array",
"description": "+"
},
"attendee[firstname]": {
"type": "string",
"description": "Firstname"
},
"attendee[lastname]": {
"type": "string",
"description": "Lastname"
},
"attendee[email]": {
"type": "string",
"description": "Email"
},
"attendee[company_name]": {
"type": "string",
"description": "Organization name"
},
"attendee[mobile_phone]": {
"type": "string",
"description": "Phone number"
},
"attendee[custom_field_1]": {
"type": "string",
"description": "Ticket custom field 1"
},
"attendee[custom_field_2]": {
"type": "string",
"description": "Ticket custom field 2"
},
"attendee[custom_field_3]": {
"type": "string",
"description": "Ticket custom field 3"
},
"attendee[participation_status]": {
"type": "string",
"description": "Participation status of the Attendee"
},
"attendee[note]": {
"type": "string",
"description": "Note regarding the Attendee"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Attendee Update
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of this Attendee"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "User ID for this Attendee"
},
"firstname": {
"type": "string",
"description": "Firstname"
},
"lastname": {
"type": "string",
"description": "Lastname"
},
"email": {
"type": "string",
"description": "Email"
},
"company_name": {
"type": "string",
"description": "Organization name"
},
"mobile_phone": {
"type": "string",
"description": "Phone number"
},
"custom_field_1": {
"type": "string",
"description": "Ticket custom field 1"
},
"custom_field_2": {
"type": "string",
"description": "Ticket custom field 2"
},
"custom_field_3": {
"type": "string",
"description": "Ticket custom field 3"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Attendee creation date - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Attendee update date - iso8601"
},
"participation_status": {
"type": "string",
"enum": [
"planned",
"show",
"no_show",
"canceled",
"cancelled_by_admin",
"refunded"
],
"description": "Participation status of the Attendee"
},
"note": {
"type": "string",
"description": "Note regarding the Attendee"
},
"ticket_id": {
"type": "integer",
"format": "int32",
"description": "ID of the ticket purchased"
},
"booking_id": {
"type": "integer",
"format": "int32",
"description": "ID of the booking"
},
"event_id": {
"type": "integer",
"format": "int32",
"description": "Event ID attended"
},
"customizable_attributes": {
"type": "array",
"items": {
"type": "object"
},
"description": "Array of customizable attributes with name and value"
}
},
"description": "AttendeeEntity model"
}Attendee UpdatePUT/api/admin/v2/network_events/attendees/{id}
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
]
}URI Parameters
- id
number(required)
GET /api/admin/v2/network_events/event_id/rsvp?user_id=&status=&updated_since=&participation_status=
Responses
RSVP Index
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of this Response"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "User ID for this Response"
},
"visible": {
"type": "boolean",
"description": "Response is visible on public pages"
},
"status": {
"type": "string",
"enum": [
"attend",
"maybe_attend",
"cancel",
"cancelled_by_admin"
],
"description": "User Response to event"
},
"participation_status": {
"type": "string",
"enum": [
"pending",
"did_not_attend",
"attended"
],
"description": "RSVP event participation status"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Response creation date - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Response update date - iso8601"
}
},
"description": "RSVPEntity model"
}RSVP IndexGET/api/admin/v2/network_events/{event_id}/rsvp{?user_id,status,updated_since,participation_status}
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"
}URI Parameters
- event_id
number(required)- user_id
string(required)- status
string(required)- updated_since
string(required)- participation_status
string(required)
POST /api/admin/v2/network_events/event_id/rsvp
Requests
Body
{
"rsvp[user_id]": 1,
"rsvp[status]": "Hello, world!",
"rsvp[participation_status]": "Hello, world!",
"rsvp[visible]": true
}Schema
{
"type": "object",
"properties": {
"rsvp[user_id]": {
"type": "number"
},
"rsvp[status]": {
"type": "string"
},
"rsvp[participation_status]": {
"type": "string"
},
"rsvp[visible]": {
"type": "boolean"
}
},
"required": [
"rsvp[user_id]",
"rsvp[status]",
"rsvp[visible]"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
RSVP Creation
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of this Response"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "User ID for this Response"
},
"visible": {
"type": "boolean",
"description": "Response is visible on public pages"
},
"status": {
"type": "string",
"enum": [
"attend",
"maybe_attend",
"cancel",
"cancelled_by_admin"
],
"description": "User Response to event"
},
"participation_status": {
"type": "string",
"enum": [
"pending",
"did_not_attend",
"attended"
],
"description": "RSVP event participation status"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Response creation date - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Response update date - iso8601"
}
},
"description": "RSVPEntity model"
}RSVP CreationPOST/api/admin/v2/network_events/{event_id}/rsvp
RSVP creation
Required params are :
a user ID
rsvp visibility
status in [attend maybe_attend cancel cancelled_by_admin]
URI Parameters
- event_id
number(required)
GET /api/admin/v2/network_events/event_id/rsvp/id
Responses
RSVP Details
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of this Response"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "User ID for this Response"
},
"visible": {
"type": "boolean",
"description": "Response is visible on public pages"
},
"status": {
"type": "string",
"enum": [
"attend",
"maybe_attend",
"cancel",
"cancelled_by_admin"
],
"description": "User Response to event"
},
"participation_status": {
"type": "string",
"enum": [
"pending",
"did_not_attend",
"attended"
],
"description": "RSVP event participation status"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Response creation date - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Response update date - iso8601"
}
},
"description": "RSVPEntity model"
}RSVP DetailsGET/api/admin/v2/network_events/{event_id}/rsvp/{id}
Get a rsvp
URI Parameters
- event_id
number(required)- id
number(required)
DELETE /api/admin/v2/network_events/event_id/rsvp/id
Responses
RSVP Deletion
RSVP DeletionDELETE/api/admin/v2/network_events/{event_id}/rsvp/{id}
Deletes a rsvp
Deletes the rsvp object.
URI Parameters
- event_id
number(required)- id
number(required)
PUT /api/admin/v2/network_events/event_id/rsvp/id
Requests
Body
{
"rsvp[status]": "Hello, world!",
"rsvp[participation_status]": "Hello, world!",
"rsvp[visibile]": true
}Schema
{
"type": "object",
"properties": {
"rsvp[status]": {
"type": "string"
},
"rsvp[participation_status]": {
"type": "string"
},
"rsvp[visibile]": {
"type": "boolean"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
RSVP Update
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of this Response"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "User ID for this Response"
},
"visible": {
"type": "boolean",
"description": "Response is visible on public pages"
},
"status": {
"type": "string",
"enum": [
"attend",
"maybe_attend",
"cancel",
"cancelled_by_admin"
],
"description": "User Response to event"
},
"participation_status": {
"type": "string",
"enum": [
"pending",
"did_not_attend",
"attended"
],
"description": "RSVP event participation status"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Response creation date - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Response update date - iso8601"
}
},
"description": "RSVPEntity model"
}RSVP UpdatePUT/api/admin/v2/network_events/{event_id}/rsvp/{id}
RSVP Update
URI Parameters
- event_id
number(required)- id
number(required)
GET /api/admin/v2/network_events?parent=®istration_type=&parent_id=&updated_since=&start_date_before=&start_date_after=&end_date_before=&end_date_after=
Responses
Network Event Index
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of this Network Event"
},
"title": {
"type": "string",
"description": "Title of this Network Event"
},
"venue": {
"type": "string",
"description": "Name of the venue of this Network Event"
},
"start_date": {
"type": "string",
"format": "date-time",
"description": "Network Event start date time - iso8601"
},
"end_date": {
"type": "string",
"format": "date-time",
"description": "Network Event end date time - iso8601"
},
"description": {
"type": "string",
"description": "Network Event Description"
},
"registration_type": {
"type": "string",
"description": "Event registration type"
},
"location": {
"description": "Event location",
"type": "object",
"properties": {
"city": {
"type": "string",
"description": "City"
},
"country": {
"type": "string",
"description": "Country"
},
"country_code": {
"type": "string",
"description": "ISO3166-2 Country code"
},
"address": {
"type": "string",
"description": "Address"
},
"lat": {
"type": "number",
"format": "float",
"description": "Latitude"
},
"lng": {
"type": "number",
"format": "float",
"description": "Longitude"
}
}
},
"webinar_url": {
"type": "string",
"description": "This will display a virtual link for registered users at the start time of your event. Please enter http(s):// before the link."
},
"logo": {
"type": "string",
"description": "URL to the logo of the network Event"
},
"contact_email": {
"type": "string",
"description": "Network Event contact email"
},
"contact_phone_number": {
"type": "string",
"description": "Network Event contact phone number"
},
"published_at": {
"type": "string",
"format": "date-time",
"description": "Network Event publish date - iso8601"
},
"feedable_at": {
"type": "string",
"format": "date-time",
"description": "Network Event feed date - iso8601 / is used to sort items in a reverse chronological order in the live feed "
},
"cancelled": {
"type": "string",
"description": "Network event is cancelled ?"
},
"cancelled_at": {
"type": "string",
"format": "date-time",
"description": "Date and time the network event was cancelled at - iso8601"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Network Event creation date - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Network Event update date - iso8601"
},
"public": {
"type": "boolean",
"description": "Network Event is displayed to visitors on public pages ?"
},
"total_tickets": {
"type": "integer",
"format": "int32",
"description": "Total number of tickets that can be sold. (0 or nil: unlimited), must be nil or greater than 0"
},
"tickets_due_date": {
"type": "string",
"format": "date-time",
"description": "Network Event tickets due date time - iso8601 / Date after which tickets won't be purchasable"
},
"max_tickets_per_user": {
"type": "integer",
"format": "int32",
"description": "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"
},
"cover_picture": {
"type": "string",
"description": "URL to the logo of the network Event"
},
"organizer": {
"type": "string",
"description": "Network Event organizer name"
},
"timezone": {
"type": "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"
],
"description": "Network Event in which the timezone applies"
},
"hide_from_general_list": {
"type": "boolean",
"description": "Hide Group Event from global event list and global live feed"
},
"visible_on_index_page": {
"type": "boolean",
"description": "Network Event is visible in global events list"
},
"visible_on_livefeed": {
"type": "boolean",
"description": "Network Event is visible in the live feed"
},
"send_confirmation_email": {
"type": "boolean",
"description": "Attendees receive a confirmation email after registering?"
},
"show_participants": {
"type": "boolean",
"description": "Attendees are displayed on the connected pages?"
},
"public_show_participants": {
"type": "boolean",
"description": "Attendees are displayed on the public pages?"
},
"attendees_can_pay_later": {
"type": "boolean",
"description": "Attendees can pay later?"
},
"public_attendees_can_pay_later": {
"type": "boolean",
"description": "External attendees can pay later?"
},
"users_can_cancel_participation": {
"type": "boolean",
"description": "Internal attendes can cancel their participation?"
},
"display_price_tag": {
"type": "boolean",
"description": "Display price tag on Event Card and Event Details page?"
},
"cancellation_deadline_for_users": {
"type": "integer",
"format": "int32",
"description": "Users can cancel their participation up to this number of days before the beginning of the Network Event"
},
"send_cancellation_email": {
"type": "boolean",
"description": "Attendees receive a confirmation email after cancellation?"
},
"display_refund_policy": {
"type": "boolean",
"description": "Display a refund policy when registering to the Network Event?"
},
"refund_policy_content": {
"type": "string",
"description": "Refund policy of the Network Event"
},
"receipts_enabled": {
"type": "boolean",
"description": "Send a Receipt to attendees after they bought their tickets for the Network Event"
},
"seo_title": {
"type": "string",
"description": "Customizable SEO title for search engine"
},
"seo_description": {
"type": "string",
"description": "Customizable SEO description for search engine"
},
"canonical_url": {
"type": "string",
"description": "Canonical URL for this Network Event for search engine"
},
"ticket_ids": {
"type": "integer",
"format": "int32",
"description": "Tickets of this Network Event"
},
"attendee_ids": {
"type": "integer",
"format": "int32",
"description": "Attendees of this Network Event"
},
"booking_ids": {
"type": "integer",
"format": "int32",
"description": "Bookings of this Network Event"
},
"network_category_ids": {
"type": "integer",
"format": "int32",
"description": "Network Categories linked to this Network Event"
},
"topic_ids": {
"type": "integer",
"format": "int32",
"description": "Topics linked to this Network Event"
},
"communication_ids": {
"type": "integer",
"format": "int32",
"description": "Communications linked to this Network Event"
},
"customizable_attribute_ids": {
"type": "integer",
"format": "int32",
"description": "Customizable Attributes set for this Network Event"
},
"parent": {
"description": "Parent Information",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Parent ID"
},
"type": {
"type": "string",
"description": "Parent type"
}
}
},
"payment_account": {
"description": "Payment account linked to this Network Event",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of the Payment Account"
},
"name": {
"type": "string",
"description": "Name of the Payment Account"
},
"account_type": {
"type": "string",
"description": "Kind of payment account"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Category creation date time - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Category last update date time - iso8601"
},
"available_for_all_groups": {
"type": "boolean",
"description": "True/False is the payment account available for all groups"
},
"groups": {
"description": "Groups that the payment account can be used in",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of the Group"
},
"name": {
"type": "string",
"description": "Name of the Group"
}
}
}
}
},
"payment_flow": {
"type": "string",
"enum": [
"only_pay_now",
"pay_now_or_later",
"only_pay_later"
],
"description": "Payment flow for this Network Event"
}
},
"description": "EventEntity model"
}Network Event IndexGET/api/admin/v2/network_events{?parent,registration_type,parent_id,updated_since,start_date_before,start_date_after,end_date_before,end_date_after}
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"
}URI Parameters
- parent
string(required)- registration_type
string(required)- parent_id
string(required)- updated_since
string(required)- start_date_before
string(required)- start_date_after
string(required)- end_date_before
string(required)- end_date_after
string(required)
POST /api/admin/v2/network_events
Requests
Body
{
"locale": "Hello, world!",
"network_event[title]": "Hello, world!",
"network_event[description]": "Hello, world!",
"network_event[start_date]": "Hello, world!",
"network_event[end_date]": "Hello, world!",
"network_event[timezone]": "Hello, world!",
"network_event[logo]": "Hello, world!",
"network_event[cover_picture]": "Hello, world!",
"network_event[registration_type]": "Hello, world!",
"network_event[payment_flow]": "Hello, world!",
"network_event[location][country]": "Hello, world!",
"network_event[location][country_code]": "Hello, world!",
"network_event[location][city]": "Hello, world!",
"network_event[location][address]": "Hello, world!",
"network_event[parent_id]": 1,
"network_event[venue]": "Hello, world!",
"network_event[webinar_url]": "Hello, world!",
"network_event[contact_email]": "Hello, world!",
"network_event[contact_phone_number]": "Hello, world!",
"network_event[published_at]": "Hello, world!",
"network_event[feedable_at]": "Hello, world!",
"network_event[cancelled]": "Hello, world!",
"network_event[cancelled_at]": "Hello, world!",
"network_event[public]": true,
"network_event[total_tickets]": 1,
"network_event[tickets_due_date]": "Hello, world!",
"network_event[max_tickets_per_user]": 1,
"network_event[organizer]": "Hello, world!",
"network_event[hide_from_general_list]": true,
"network_event[visible_on_index_page]": true,
"network_event[visible_on_livefeed]": true,
"network_event[send_confirmation_email]": true,
"network_event[show_participants]": true,
"network_event[public_show_participants]": true,
"network_event[attendees_can_pay_later]": true,
"network_event[public_attendees_can_pay_later]": true,
"network_event[users_can_cancel_participation]": true,
"network_event[display_price_tag]": true,
"network_event[cancellation_deadline_for_users]": 1,
"network_event[send_cancellation_email]": true,
"network_event[display_refund_policy]": true,
"network_event[refund_policy_content]": "Hello, world!",
"network_event[receipts_enabled]": true,
"network_event[seo_title]": "Hello, world!",
"network_event[seo_description]": "Hello, world!",
"network_event[canonical_url]": "Hello, world!",
"network_event[network_category_ids][]": [
1
],
"network_event[topic_ids][]": [
1
],
"network_event[communication_ids][]": [
1
]
}Schema
{
"type": "object",
"properties": {
"locale": {
"type": "string",
"description": "select a specific locale to edit, if no locale is selected the default network locale will be used."
},
"network_event[title]": {
"type": "string"
},
"network_event[description]": {
"type": "string"
},
"network_event[start_date]": {
"type": "string"
},
"network_event[end_date]": {
"type": "string"
},
"network_event[timezone]": {
"type": "string"
},
"network_event[logo]": {
"type": "string"
},
"network_event[cover_picture]": {
"type": "string"
},
"network_event[registration_type]": {
"type": "string",
"description": "Event registration type"
},
"network_event[payment_flow]": {
"type": "string",
"description": "Payment flow for this Network Event"
},
"network_event[location][country]": {
"type": "string"
},
"network_event[location][country_code]": {
"type": "string"
},
"network_event[location][city]": {
"type": "string"
},
"network_event[location][address]": {
"type": "string"
},
"network_event[parent_id]": {
"type": "number",
"description": "Group ID. By default, the network is the parent."
},
"network_event[venue]": {
"type": "string",
"description": "Name of the venue of this Network Event"
},
"network_event[webinar_url]": {
"type": "string",
"description": "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]": {
"type": "string",
"description": "Network Event contact email"
},
"network_event[contact_phone_number]": {
"type": "string",
"description": "Network Event contact phone number"
},
"network_event[published_at]": {
"type": "string",
"description": "Network Event publish date - iso8601"
},
"network_event[feedable_at]": {
"type": "string",
"description": "Network Event feed date - iso8601 / is used to sort items in a reverse chronological order in the live feed"
},
"network_event[cancelled]": {
"type": "string",
"description": "Network event is cancelled ?"
},
"network_event[cancelled_at]": {
"type": "string",
"description": "Date and time the network event was cancelled at - iso8601"
},
"network_event[public]": {
"type": "boolean",
"description": "Network Event is displayed to visitors on public pages ?"
},
"network_event[total_tickets]": {
"type": "number",
"description": "Total number of tickets that can be sold. (0 or nil: unlimited), must be nil or greater than 0"
},
"network_event[tickets_due_date]": {
"type": "string",
"description": "Network Event tickets due date time - iso8601 / Date after which tickets won't be purchasable"
},
"network_event[max_tickets_per_user]": {
"type": "number",
"description": "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]": {
"type": "string",
"description": "Network Event organizer name"
},
"network_event[hide_from_general_list]": {
"type": "boolean",
"description": "Hide Group Event from global event list and global live feed"
},
"network_event[visible_on_index_page]": {
"type": "boolean",
"description": "Network Event is visible in global events list"
},
"network_event[visible_on_livefeed]": {
"type": "boolean",
"description": "Network Event is visible in the live feed"
},
"network_event[send_confirmation_email]": {
"type": "boolean",
"description": "Attendees receive a confirmation email after registering?"
},
"network_event[show_participants]": {
"type": "boolean",
"description": "Attendees are displayed on the connected pages?"
},
"network_event[public_show_participants]": {
"type": "boolean",
"description": "Attendees are displayed on the public pages?"
},
"network_event[attendees_can_pay_later]": {
"type": "boolean",
"description": "Attendees can pay later?"
},
"network_event[public_attendees_can_pay_later]": {
"type": "boolean",
"description": "External attendees can pay later?"
},
"network_event[users_can_cancel_participation]": {
"type": "boolean",
"description": "Internal attendes can cancel their participation?"
},
"network_event[display_price_tag]": {
"type": "boolean",
"description": "Display price tag on Event Card and Event Details page?"
},
"network_event[cancellation_deadline_for_users]": {
"type": "number",
"description": "Users can cancel their participation up to this number of days before the beginning of the Network Event"
},
"network_event[send_cancellation_email]": {
"type": "boolean",
"description": "Attendees receive a confirmation email after cancellation?"
},
"network_event[display_refund_policy]": {
"type": "boolean",
"description": "Display a refund policy when registering to the Network Event?"
},
"network_event[refund_policy_content]": {
"type": "string",
"description": "Refund policy of the Network Event"
},
"network_event[receipts_enabled]": {
"type": "boolean",
"description": "Send a Receipt to attendees after they bought their tickets for the Network Event"
},
"network_event[seo_title]": {
"type": "string",
"description": "Customizable SEO title for search engine"
},
"network_event[seo_description]": {
"type": "string",
"description": "Customizable SEO description for search engine"
},
"network_event[canonical_url]": {
"type": "string",
"description": "Canonical URL for this Network Event for search engine"
},
"network_event[network_category_ids][]": {
"type": "array",
"items": {
"type": "number"
},
"description": "Network Categories linked to this Network Event"
},
"network_event[topic_ids][]": {
"type": "array",
"items": {
"type": "number"
},
"description": "Topics linked to this Network Event"
},
"network_event[communication_ids][]": {
"type": "array",
"items": {
"type": "number"
},
"description": "Communications linked to this Network Event"
}
},
"required": [
"network_event[title]",
"network_event[description]",
"network_event[start_date]",
"network_event[end_date]",
"network_event[timezone]"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Network Event Creation
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of this Network Event"
},
"title": {
"type": "string",
"description": "Title of this Network Event"
},
"venue": {
"type": "string",
"description": "Name of the venue of this Network Event"
},
"start_date": {
"type": "string",
"format": "date-time",
"description": "Network Event start date time - iso8601"
},
"end_date": {
"type": "string",
"format": "date-time",
"description": "Network Event end date time - iso8601"
},
"description": {
"type": "string",
"description": "Network Event Description"
},
"registration_type": {
"type": "string",
"description": "Event registration type"
},
"location": {
"description": "Event location",
"type": "object",
"properties": {
"city": {
"type": "string",
"description": "City"
},
"country": {
"type": "string",
"description": "Country"
},
"country_code": {
"type": "string",
"description": "ISO3166-2 Country code"
},
"address": {
"type": "string",
"description": "Address"
},
"lat": {
"type": "number",
"format": "float",
"description": "Latitude"
},
"lng": {
"type": "number",
"format": "float",
"description": "Longitude"
}
}
},
"webinar_url": {
"type": "string",
"description": "This will display a virtual link for registered users at the start time of your event. Please enter http(s):// before the link."
},
"logo": {
"type": "string",
"description": "URL to the logo of the network Event"
},
"contact_email": {
"type": "string",
"description": "Network Event contact email"
},
"contact_phone_number": {
"type": "string",
"description": "Network Event contact phone number"
},
"published_at": {
"type": "string",
"format": "date-time",
"description": "Network Event publish date - iso8601"
},
"feedable_at": {
"type": "string",
"format": "date-time",
"description": "Network Event feed date - iso8601 / is used to sort items in a reverse chronological order in the live feed "
},
"cancelled": {
"type": "string",
"description": "Network event is cancelled ?"
},
"cancelled_at": {
"type": "string",
"format": "date-time",
"description": "Date and time the network event was cancelled at - iso8601"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Network Event creation date - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Network Event update date - iso8601"
},
"public": {
"type": "boolean",
"description": "Network Event is displayed to visitors on public pages ?"
},
"total_tickets": {
"type": "integer",
"format": "int32",
"description": "Total number of tickets that can be sold. (0 or nil: unlimited), must be nil or greater than 0"
},
"tickets_due_date": {
"type": "string",
"format": "date-time",
"description": "Network Event tickets due date time - iso8601 / Date after which tickets won't be purchasable"
},
"max_tickets_per_user": {
"type": "integer",
"format": "int32",
"description": "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"
},
"cover_picture": {
"type": "string",
"description": "URL to the logo of the network Event"
},
"organizer": {
"type": "string",
"description": "Network Event organizer name"
},
"timezone": {
"type": "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"
],
"description": "Network Event in which the timezone applies"
},
"hide_from_general_list": {
"type": "boolean",
"description": "Hide Group Event from global event list and global live feed"
},
"visible_on_index_page": {
"type": "boolean",
"description": "Network Event is visible in global events list"
},
"visible_on_livefeed": {
"type": "boolean",
"description": "Network Event is visible in the live feed"
},
"send_confirmation_email": {
"type": "boolean",
"description": "Attendees receive a confirmation email after registering?"
},
"show_participants": {
"type": "boolean",
"description": "Attendees are displayed on the connected pages?"
},
"public_show_participants": {
"type": "boolean",
"description": "Attendees are displayed on the public pages?"
},
"attendees_can_pay_later": {
"type": "boolean",
"description": "Attendees can pay later?"
},
"public_attendees_can_pay_later": {
"type": "boolean",
"description": "External attendees can pay later?"
},
"users_can_cancel_participation": {
"type": "boolean",
"description": "Internal attendes can cancel their participation?"
},
"display_price_tag": {
"type": "boolean",
"description": "Display price tag on Event Card and Event Details page?"
},
"cancellation_deadline_for_users": {
"type": "integer",
"format": "int32",
"description": "Users can cancel their participation up to this number of days before the beginning of the Network Event"
},
"send_cancellation_email": {
"type": "boolean",
"description": "Attendees receive a confirmation email after cancellation?"
},
"display_refund_policy": {
"type": "boolean",
"description": "Display a refund policy when registering to the Network Event?"
},
"refund_policy_content": {
"type": "string",
"description": "Refund policy of the Network Event"
},
"receipts_enabled": {
"type": "boolean",
"description": "Send a Receipt to attendees after they bought their tickets for the Network Event"
},
"seo_title": {
"type": "string",
"description": "Customizable SEO title for search engine"
},
"seo_description": {
"type": "string",
"description": "Customizable SEO description for search engine"
},
"canonical_url": {
"type": "string",
"description": "Canonical URL for this Network Event for search engine"
},
"ticket_ids": {
"type": "integer",
"format": "int32",
"description": "Tickets of this Network Event"
},
"attendee_ids": {
"type": "integer",
"format": "int32",
"description": "Attendees of this Network Event"
},
"booking_ids": {
"type": "integer",
"format": "int32",
"description": "Bookings of this Network Event"
},
"network_category_ids": {
"type": "integer",
"format": "int32",
"description": "Network Categories linked to this Network Event"
},
"topic_ids": {
"type": "integer",
"format": "int32",
"description": "Topics linked to this Network Event"
},
"communication_ids": {
"type": "integer",
"format": "int32",
"description": "Communications linked to this Network Event"
},
"customizable_attribute_ids": {
"type": "integer",
"format": "int32",
"description": "Customizable Attributes set for this Network Event"
},
"parent": {
"description": "Parent Information",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Parent ID"
},
"type": {
"type": "string",
"description": "Parent type"
}
}
},
"payment_account": {
"description": "Payment account linked to this Network Event",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of the Payment Account"
},
"name": {
"type": "string",
"description": "Name of the Payment Account"
},
"account_type": {
"type": "string",
"description": "Kind of payment account"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Category creation date time - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Category last update date time - iso8601"
},
"available_for_all_groups": {
"type": "boolean",
"description": "True/False is the payment account available for all groups"
},
"groups": {
"description": "Groups that the payment account can be used in",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of the Group"
},
"name": {
"type": "string",
"description": "Name of the Group"
}
}
}
}
},
"payment_flow": {
"type": "string",
"enum": [
"only_pay_now",
"pay_now_or_later",
"only_pay_later"
],
"description": "Payment flow for this Network Event"
}
},
"description": "EventEntity model"
}Network Event CreationPOST/api/admin/v2/network_events
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.
GET /api/admin/v2/network_events/id
Responses
Network Event Details
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of this Network Event"
},
"title": {
"type": "string",
"description": "Title of this Network Event"
},
"venue": {
"type": "string",
"description": "Name of the venue of this Network Event"
},
"start_date": {
"type": "string",
"format": "date-time",
"description": "Network Event start date time - iso8601"
},
"end_date": {
"type": "string",
"format": "date-time",
"description": "Network Event end date time - iso8601"
},
"description": {
"type": "string",
"description": "Network Event Description"
},
"registration_type": {
"type": "string",
"description": "Event registration type"
},
"location": {
"description": "Event location",
"type": "object",
"properties": {
"city": {
"type": "string",
"description": "City"
},
"country": {
"type": "string",
"description": "Country"
},
"country_code": {
"type": "string",
"description": "ISO3166-2 Country code"
},
"address": {
"type": "string",
"description": "Address"
},
"lat": {
"type": "number",
"format": "float",
"description": "Latitude"
},
"lng": {
"type": "number",
"format": "float",
"description": "Longitude"
}
}
},
"webinar_url": {
"type": "string",
"description": "This will display a virtual link for registered users at the start time of your event. Please enter http(s):// before the link."
},
"logo": {
"type": "string",
"description": "URL to the logo of the network Event"
},
"contact_email": {
"type": "string",
"description": "Network Event contact email"
},
"contact_phone_number": {
"type": "string",
"description": "Network Event contact phone number"
},
"published_at": {
"type": "string",
"format": "date-time",
"description": "Network Event publish date - iso8601"
},
"feedable_at": {
"type": "string",
"format": "date-time",
"description": "Network Event feed date - iso8601 / is used to sort items in a reverse chronological order in the live feed "
},
"cancelled": {
"type": "string",
"description": "Network event is cancelled ?"
},
"cancelled_at": {
"type": "string",
"format": "date-time",
"description": "Date and time the network event was cancelled at - iso8601"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Network Event creation date - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Network Event update date - iso8601"
},
"public": {
"type": "boolean",
"description": "Network Event is displayed to visitors on public pages ?"
},
"total_tickets": {
"type": "integer",
"format": "int32",
"description": "Total number of tickets that can be sold. (0 or nil: unlimited), must be nil or greater than 0"
},
"tickets_due_date": {
"type": "string",
"format": "date-time",
"description": "Network Event tickets due date time - iso8601 / Date after which tickets won't be purchasable"
},
"max_tickets_per_user": {
"type": "integer",
"format": "int32",
"description": "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"
},
"cover_picture": {
"type": "string",
"description": "URL to the logo of the network Event"
},
"organizer": {
"type": "string",
"description": "Network Event organizer name"
},
"timezone": {
"type": "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"
],
"description": "Network Event in which the timezone applies"
},
"hide_from_general_list": {
"type": "boolean",
"description": "Hide Group Event from global event list and global live feed"
},
"visible_on_index_page": {
"type": "boolean",
"description": "Network Event is visible in global events list"
},
"visible_on_livefeed": {
"type": "boolean",
"description": "Network Event is visible in the live feed"
},
"send_confirmation_email": {
"type": "boolean",
"description": "Attendees receive a confirmation email after registering?"
},
"show_participants": {
"type": "boolean",
"description": "Attendees are displayed on the connected pages?"
},
"public_show_participants": {
"type": "boolean",
"description": "Attendees are displayed on the public pages?"
},
"attendees_can_pay_later": {
"type": "boolean",
"description": "Attendees can pay later?"
},
"public_attendees_can_pay_later": {
"type": "boolean",
"description": "External attendees can pay later?"
},
"users_can_cancel_participation": {
"type": "boolean",
"description": "Internal attendes can cancel their participation?"
},
"display_price_tag": {
"type": "boolean",
"description": "Display price tag on Event Card and Event Details page?"
},
"cancellation_deadline_for_users": {
"type": "integer",
"format": "int32",
"description": "Users can cancel their participation up to this number of days before the beginning of the Network Event"
},
"send_cancellation_email": {
"type": "boolean",
"description": "Attendees receive a confirmation email after cancellation?"
},
"display_refund_policy": {
"type": "boolean",
"description": "Display a refund policy when registering to the Network Event?"
},
"refund_policy_content": {
"type": "string",
"description": "Refund policy of the Network Event"
},
"receipts_enabled": {
"type": "boolean",
"description": "Send a Receipt to attendees after they bought their tickets for the Network Event"
},
"seo_title": {
"type": "string",
"description": "Customizable SEO title for search engine"
},
"seo_description": {
"type": "string",
"description": "Customizable SEO description for search engine"
},
"canonical_url": {
"type": "string",
"description": "Canonical URL for this Network Event for search engine"
},
"ticket_ids": {
"type": "integer",
"format": "int32",
"description": "Tickets of this Network Event"
},
"attendee_ids": {
"type": "integer",
"format": "int32",
"description": "Attendees of this Network Event"
},
"booking_ids": {
"type": "integer",
"format": "int32",
"description": "Bookings of this Network Event"
},
"network_category_ids": {
"type": "integer",
"format": "int32",
"description": "Network Categories linked to this Network Event"
},
"topic_ids": {
"type": "integer",
"format": "int32",
"description": "Topics linked to this Network Event"
},
"communication_ids": {
"type": "integer",
"format": "int32",
"description": "Communications linked to this Network Event"
},
"customizable_attribute_ids": {
"type": "integer",
"format": "int32",
"description": "Customizable Attributes set for this Network Event"
},
"parent": {
"description": "Parent Information",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Parent ID"
},
"type": {
"type": "string",
"description": "Parent type"
}
}
},
"payment_account": {
"description": "Payment account linked to this Network Event",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of the Payment Account"
},
"name": {
"type": "string",
"description": "Name of the Payment Account"
},
"account_type": {
"type": "string",
"description": "Kind of payment account"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Category creation date time - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Category last update date time - iso8601"
},
"available_for_all_groups": {
"type": "boolean",
"description": "True/False is the payment account available for all groups"
},
"groups": {
"description": "Groups that the payment account can be used in",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of the Group"
},
"name": {
"type": "string",
"description": "Name of the Group"
}
}
}
}
},
"payment_flow": {
"type": "string",
"enum": [
"only_pay_now",
"pay_now_or_later",
"only_pay_later"
],
"description": "Payment flow for this Network Event"
}
},
"description": "EventEntity model"
}Network Event DetailsGET/api/admin/v2/network_events/{id}
Get a Network Event
The customizable attributes can be retrieved on the /api/admin/v1/settings/customizable_attributes endpoint.
URI Parameters
- id
number(required)
DELETE /api/admin/v2/network_events/id
Responses
Network Event Deletion
Network Event DeletionDELETE/api/admin/v2/network_events/{id}
Delete a Network Event
Event, its tickets, bookings and attendees will be deleted.
URI Parameters
- id
number(required)
PUT /api/admin/v2/network_events/id
Requests
Body
{
"locale": "Hello, world!",
"network_event[logo]": "Hello, world!",
"network_event[cover_picture]": "Hello, world!",
"network_event[location][country]": "Hello, world!",
"network_event[location][country_code]": "Hello, world!",
"network_event[location][city]": "Hello, world!",
"network_event[location][address]": "Hello, world!",
"network_event[registration_type]": "Hello, world!",
"network_event[payment_flow]": "Hello, world!",
"network_event[title]": "Hello, world!",
"network_event[venue]": "Hello, world!",
"network_event[start_date]": "Hello, world!",
"network_event[end_date]": "Hello, world!",
"network_event[description]": "Hello, world!",
"network_event[webinar_url]": "Hello, world!",
"network_event[contact_email]": "Hello, world!",
"network_event[contact_phone_number]": "Hello, world!",
"network_event[published_at]": "Hello, world!",
"network_event[feedable_at]": "Hello, world!",
"network_event[cancelled]": "Hello, world!",
"network_event[cancelled_at]": "Hello, world!",
"network_event[public]": true,
"network_event[total_tickets]": 1,
"network_event[tickets_due_date]": "Hello, world!",
"network_event[max_tickets_per_user]": 1,
"network_event[organizer]": "Hello, world!",
"network_event[timezone]": "Hello, world!",
"network_event[hide_from_general_list]": true,
"network_event[visible_on_index_page]": true,
"network_event[visible_on_livefeed]": true,
"network_event[send_confirmation_email]": true,
"network_event[show_participants]": true,
"network_event[public_show_participants]": true,
"network_event[attendees_can_pay_later]": true,
"network_event[public_attendees_can_pay_later]": true,
"network_event[users_can_cancel_participation]": true,
"network_event[display_price_tag]": true,
"network_event[cancellation_deadline_for_users]": 1,
"network_event[send_cancellation_email]": true,
"network_event[display_refund_policy]": true,
"network_event[refund_policy_content]": "Hello, world!",
"network_event[receipts_enabled]": true,
"network_event[seo_title]": "Hello, world!",
"network_event[seo_description]": "Hello, world!",
"network_event[canonical_url]": "Hello, world!",
"network_event[network_category_ids][]": [
1
],
"network_event[topic_ids][]": [
1
],
"network_event[communication_ids][]": [
1
]
}Schema
{
"type": "object",
"properties": {
"locale": {
"type": "string",
"description": "select a specific locale to edit, if no locale is selected the default network locale will be used."
},
"network_event[logo]": {
"type": "string"
},
"network_event[cover_picture]": {
"type": "string"
},
"network_event[location][country]": {
"type": "string"
},
"network_event[location][country_code]": {
"type": "string"
},
"network_event[location][city]": {
"type": "string"
},
"network_event[location][address]": {
"type": "string"
},
"network_event[registration_type]": {
"type": "string"
},
"network_event[payment_flow]": {
"type": "string",
"description": "Payment flow for this Network Event"
},
"network_event[title]": {
"type": "string",
"description": "Title of this Network Event"
},
"network_event[venue]": {
"type": "string",
"description": "Name of the venue of this Network Event"
},
"network_event[start_date]": {
"type": "string",
"description": "Network Event start date time - iso8601"
},
"network_event[end_date]": {
"type": "string",
"description": "Network Event end date time - iso8601"
},
"network_event[description]": {
"type": "string",
"description": "Network Event Description"
},
"network_event[webinar_url]": {
"type": "string",
"description": "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]": {
"type": "string",
"description": "Network Event contact email"
},
"network_event[contact_phone_number]": {
"type": "string",
"description": "Network Event contact phone number"
},
"network_event[published_at]": {
"type": "string",
"description": "Network Event publish date - iso8601"
},
"network_event[feedable_at]": {
"type": "string",
"description": "Network Event feed date - iso8601 / is used to sort items in a reverse chronological order in the live feed"
},
"network_event[cancelled]": {
"type": "string",
"description": "Network event is cancelled ?"
},
"network_event[cancelled_at]": {
"type": "string",
"description": "Date and time the network event was cancelled at - iso8601"
},
"network_event[public]": {
"type": "boolean",
"description": "Network Event is displayed to visitors on public pages ?"
},
"network_event[total_tickets]": {
"type": "number",
"description": "Total number of tickets that can be sold. (0 or nil: unlimited), must be nil or greater than 0"
},
"network_event[tickets_due_date]": {
"type": "string",
"description": "Network Event tickets due date time - iso8601 / Date after which tickets won't be purchasable"
},
"network_event[max_tickets_per_user]": {
"type": "number",
"description": "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]": {
"type": "string",
"description": "Network Event organizer name"
},
"network_event[timezone]": {
"type": "string",
"description": "Network Event in which the timezone applies"
},
"network_event[hide_from_general_list]": {
"type": "boolean",
"description": "Hide Group Event from global event list and global live feed"
},
"network_event[visible_on_index_page]": {
"type": "boolean",
"description": "Network Event is visible in global events list"
},
"network_event[visible_on_livefeed]": {
"type": "boolean",
"description": "Network Event is visible in the live feed"
},
"network_event[send_confirmation_email]": {
"type": "boolean",
"description": "Attendees receive a confirmation email after registering?"
},
"network_event[show_participants]": {
"type": "boolean",
"description": "Attendees are displayed on the connected pages?"
},
"network_event[public_show_participants]": {
"type": "boolean",
"description": "Attendees are displayed on the public pages?"
},
"network_event[attendees_can_pay_later]": {
"type": "boolean",
"description": "Attendees can pay later?"
},
"network_event[public_attendees_can_pay_later]": {
"type": "boolean",
"description": "External attendees can pay later?"
},
"network_event[users_can_cancel_participation]": {
"type": "boolean",
"description": "Internal attendes can cancel their participation?"
},
"network_event[display_price_tag]": {
"type": "boolean",
"description": "Display price tag on Event Card and Event Details page?"
},
"network_event[cancellation_deadline_for_users]": {
"type": "number",
"description": "Users can cancel their participation up to this number of days before the beginning of the Network Event"
},
"network_event[send_cancellation_email]": {
"type": "boolean",
"description": "Attendees receive a confirmation email after cancellation?"
},
"network_event[display_refund_policy]": {
"type": "boolean",
"description": "Display a refund policy when registering to the Network Event?"
},
"network_event[refund_policy_content]": {
"type": "string",
"description": "Refund policy of the Network Event"
},
"network_event[receipts_enabled]": {
"type": "boolean",
"description": "Send a Receipt to attendees after they bought their tickets for the Network Event"
},
"network_event[seo_title]": {
"type": "string",
"description": "Customizable SEO title for search engine"
},
"network_event[seo_description]": {
"type": "string",
"description": "Customizable SEO description for search engine"
},
"network_event[canonical_url]": {
"type": "string",
"description": "Canonical URL for this Network Event for search engine"
},
"network_event[network_category_ids][]": {
"type": "array",
"items": {
"type": "number"
},
"description": "Network Categories linked to this Network Event"
},
"network_event[topic_ids][]": {
"type": "array",
"items": {
"type": "number"
},
"description": "Topics linked to this Network Event"
},
"network_event[communication_ids][]": {
"type": "array",
"items": {
"type": "number"
},
"description": "Communications linked to this Network Event"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Network Event Update
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of this Network Event"
},
"title": {
"type": "string",
"description": "Title of this Network Event"
},
"venue": {
"type": "string",
"description": "Name of the venue of this Network Event"
},
"start_date": {
"type": "string",
"format": "date-time",
"description": "Network Event start date time - iso8601"
},
"end_date": {
"type": "string",
"format": "date-time",
"description": "Network Event end date time - iso8601"
},
"description": {
"type": "string",
"description": "Network Event Description"
},
"registration_type": {
"type": "string",
"description": "Event registration type"
},
"location": {
"description": "Event location",
"type": "object",
"properties": {
"city": {
"type": "string",
"description": "City"
},
"country": {
"type": "string",
"description": "Country"
},
"country_code": {
"type": "string",
"description": "ISO3166-2 Country code"
},
"address": {
"type": "string",
"description": "Address"
},
"lat": {
"type": "number",
"format": "float",
"description": "Latitude"
},
"lng": {
"type": "number",
"format": "float",
"description": "Longitude"
}
}
},
"webinar_url": {
"type": "string",
"description": "This will display a virtual link for registered users at the start time of your event. Please enter http(s):// before the link."
},
"logo": {
"type": "string",
"description": "URL to the logo of the network Event"
},
"contact_email": {
"type": "string",
"description": "Network Event contact email"
},
"contact_phone_number": {
"type": "string",
"description": "Network Event contact phone number"
},
"published_at": {
"type": "string",
"format": "date-time",
"description": "Network Event publish date - iso8601"
},
"feedable_at": {
"type": "string",
"format": "date-time",
"description": "Network Event feed date - iso8601 / is used to sort items in a reverse chronological order in the live feed "
},
"cancelled": {
"type": "string",
"description": "Network event is cancelled ?"
},
"cancelled_at": {
"type": "string",
"format": "date-time",
"description": "Date and time the network event was cancelled at - iso8601"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Network Event creation date - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Network Event update date - iso8601"
},
"public": {
"type": "boolean",
"description": "Network Event is displayed to visitors on public pages ?"
},
"total_tickets": {
"type": "integer",
"format": "int32",
"description": "Total number of tickets that can be sold. (0 or nil: unlimited), must be nil or greater than 0"
},
"tickets_due_date": {
"type": "string",
"format": "date-time",
"description": "Network Event tickets due date time - iso8601 / Date after which tickets won't be purchasable"
},
"max_tickets_per_user": {
"type": "integer",
"format": "int32",
"description": "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"
},
"cover_picture": {
"type": "string",
"description": "URL to the logo of the network Event"
},
"organizer": {
"type": "string",
"description": "Network Event organizer name"
},
"timezone": {
"type": "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"
],
"description": "Network Event in which the timezone applies"
},
"hide_from_general_list": {
"type": "boolean",
"description": "Hide Group Event from global event list and global live feed"
},
"visible_on_index_page": {
"type": "boolean",
"description": "Network Event is visible in global events list"
},
"visible_on_livefeed": {
"type": "boolean",
"description": "Network Event is visible in the live feed"
},
"send_confirmation_email": {
"type": "boolean",
"description": "Attendees receive a confirmation email after registering?"
},
"show_participants": {
"type": "boolean",
"description": "Attendees are displayed on the connected pages?"
},
"public_show_participants": {
"type": "boolean",
"description": "Attendees are displayed on the public pages?"
},
"attendees_can_pay_later": {
"type": "boolean",
"description": "Attendees can pay later?"
},
"public_attendees_can_pay_later": {
"type": "boolean",
"description": "External attendees can pay later?"
},
"users_can_cancel_participation": {
"type": "boolean",
"description": "Internal attendes can cancel their participation?"
},
"display_price_tag": {
"type": "boolean",
"description": "Display price tag on Event Card and Event Details page?"
},
"cancellation_deadline_for_users": {
"type": "integer",
"format": "int32",
"description": "Users can cancel their participation up to this number of days before the beginning of the Network Event"
},
"send_cancellation_email": {
"type": "boolean",
"description": "Attendees receive a confirmation email after cancellation?"
},
"display_refund_policy": {
"type": "boolean",
"description": "Display a refund policy when registering to the Network Event?"
},
"refund_policy_content": {
"type": "string",
"description": "Refund policy of the Network Event"
},
"receipts_enabled": {
"type": "boolean",
"description": "Send a Receipt to attendees after they bought their tickets for the Network Event"
},
"seo_title": {
"type": "string",
"description": "Customizable SEO title for search engine"
},
"seo_description": {
"type": "string",
"description": "Customizable SEO description for search engine"
},
"canonical_url": {
"type": "string",
"description": "Canonical URL for this Network Event for search engine"
},
"ticket_ids": {
"type": "integer",
"format": "int32",
"description": "Tickets of this Network Event"
},
"attendee_ids": {
"type": "integer",
"format": "int32",
"description": "Attendees of this Network Event"
},
"booking_ids": {
"type": "integer",
"format": "int32",
"description": "Bookings of this Network Event"
},
"network_category_ids": {
"type": "integer",
"format": "int32",
"description": "Network Categories linked to this Network Event"
},
"topic_ids": {
"type": "integer",
"format": "int32",
"description": "Topics linked to this Network Event"
},
"communication_ids": {
"type": "integer",
"format": "int32",
"description": "Communications linked to this Network Event"
},
"customizable_attribute_ids": {
"type": "integer",
"format": "int32",
"description": "Customizable Attributes set for this Network Event"
},
"parent": {
"description": "Parent Information",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Parent ID"
},
"type": {
"type": "string",
"description": "Parent type"
}
}
},
"payment_account": {
"description": "Payment account linked to this Network Event",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of the Payment Account"
},
"name": {
"type": "string",
"description": "Name of the Payment Account"
},
"account_type": {
"type": "string",
"description": "Kind of payment account"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Category creation date time - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Category last update date time - iso8601"
},
"available_for_all_groups": {
"type": "boolean",
"description": "True/False is the payment account available for all groups"
},
"groups": {
"description": "Groups that the payment account can be used in",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of the Group"
},
"name": {
"type": "string",
"description": "Name of the Group"
}
}
}
}
},
"payment_flow": {
"type": "string",
"enum": [
"only_pay_now",
"pay_now_or_later",
"only_pay_later"
],
"description": "Payment flow for this Network Event"
}
},
"description": "EventEntity model"
}Network Event UpdatePUT/api/admin/v2/network_events/{id}
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.
URI Parameters
- id
number(required)
POST /api/admin/v2/network_events/id/cancel
Responses
Network Event Cancellation
Network Event CancellationPOST/api/admin/v2/network_events/{id}/cancel
Cancel a Network Event
Event, its tickets, bookings and attendees will be cancelled.
URI Parameters
- id
number(required)
POST /api/admin/v2/network_events/customizable_attributes
Requests
Body
{
"customizable_attribute[type]": "Hello, world!",
"customizable_attribute[display_name]": "Hello, world!",
"customizable_attribute[customizable_id]": 1,
"customizable_attribute[options][]": [],
"customizable_attribute[multi]": true,
"customizable_attribute[text_size]": 1,
"customizable_attribute[tooltip]": "Hello, world!",
"customizable_attribute[placeholder]": "Hello, world!",
"customizable_attribute[visibility]": "Hello, world!",
"customizable_attribute[required]": true,
"customizable_attribute[selected_value]": "Hello, world!"
}Schema
{
"type": "object",
"properties": {
"customizable_attribute[type]": {
"type": "string"
},
"customizable_attribute[display_name]": {
"type": "string"
},
"customizable_attribute[customizable_id]": {
"type": "number"
},
"customizable_attribute[options][]": {
"type": "array",
"description": "+"
},
"customizable_attribute[multi]": {
"type": "boolean"
},
"customizable_attribute[text_size]": {
"type": "number"
},
"customizable_attribute[tooltip]": {
"type": "string",
"description": "Customizable Attribute tooltip"
},
"customizable_attribute[placeholder]": {
"type": "string",
"description": "Customizable Attribute placeholder"
},
"customizable_attribute[visibility]": {
"type": "string",
"description": "Customizable Attribute visibility"
},
"customizable_attribute[required]": {
"type": "boolean",
"description": "Customizable Attribute required ?"
},
"customizable_attribute[selected_value]": {
"type": "string",
"description": "Customizable Attribute selected value"
}
},
"required": [
"customizable_attribute[type]",
"customizable_attribute[display_name]",
"customizable_attribute[customizable_id]",
"customizable_attribute[options][]"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Customizable Attribute Creation
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"customizable_id": {
"type": "integer",
"format": "int32",
"description": "Customizable ID"
},
"type": {
"type": "string",
"enum": [
"CustomizableAttribute::Boolean",
"CustomizableAttribute::Date",
"CustomizableAttribute::DoubleSelect",
"CustomizableAttribute::Number",
"CustomizableAttribute::Select",
"CustomizableAttribute::Text"
],
"description": "Customizable Attribute type"
},
"customizable_type": {
"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",
"mentorships",
"mentorships_mentee",
"mentorships_mentor",
"ne_event",
"ne_ticket",
"topic_approval",
"topic_mentorships",
"topic_mentorships_mentee",
"topic_mentorships_mentor",
"user",
"ventures_venture"
],
"description": "Customizable Attribute associated model (User, Experience)"
},
"name": {
"type": "string",
"description": "Customizable Attribute name"
},
"display_name": {
"type": "string",
"description": "Customizable Attribute displayed name"
},
"tooltip": {
"type": "string",
"description": "Customizable Attribute tooltip"
},
"placeholder": {
"type": "string",
"description": "Customizable Attribute placeholder"
},
"multi": {
"type": "boolean",
"description": "Customizable Attribute multi activated ?"
},
"text_size": {
"type": "integer",
"format": "int32",
"description": "Customizable Attribute text_size"
},
"visibility": {
"type": "string",
"enum": [
"admin_only",
"tagged_user",
"everybody",
"not_visible"
],
"description": "Customizable Attribute visibility"
},
"user_editable": {
"type": "boolean",
"description": "Customizable Attribute editable by the user ?"
},
"required": {
"type": "boolean",
"description": "Customizable Attribute required ?"
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "Customizable Attribute array of options"
},
"json_options": {
"type": "object",
"description": "Customizable Attribute json options (for double select)"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Customizable Attribute creation date"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Customizable Attribute last update date"
},
"selected_value": {
"type": "string",
"description": "Customizable Attribute selected value"
}
},
"description": "CustomizableAttribute model"
}Customizable Attribute CreationPOST/api/admin/v2/network_events/customizable_attributes
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”}
PUT /api/admin/v2/network_events/customizable_attributes/id
Requests
Body
{
"customizable_attribute[display_name]": "Hello, world!",
"customizable_attribute[tooltip]": "Hello, world!",
"customizable_attribute[placeholder]": "Hello, world!",
"customizable_attribute[multi]": true,
"customizable_attribute[text_size]": 1,
"customizable_attribute[visibility]": "Hello, world!",
"customizable_attribute[required]": true,
"customizable_attribute[selected_value]": "Hello, world!"
}Schema
{
"type": "object",
"properties": {
"customizable_attribute[display_name]": {
"type": "string",
"description": "Customizable Attribute displayed name"
},
"customizable_attribute[tooltip]": {
"type": "string",
"description": "Customizable Attribute tooltip"
},
"customizable_attribute[placeholder]": {
"type": "string",
"description": "Customizable Attribute placeholder"
},
"customizable_attribute[multi]": {
"type": "boolean",
"description": "Customizable Attribute multi activated ?"
},
"customizable_attribute[text_size]": {
"type": "number",
"description": "Customizable Attribute text_size"
},
"customizable_attribute[visibility]": {
"type": "string",
"description": "Customizable Attribute visibility"
},
"customizable_attribute[required]": {
"type": "boolean",
"description": "Customizable Attribute required ?"
},
"customizable_attribute[selected_value]": {
"type": "string",
"description": "Customizable Attribute selected value"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Customizable Attribute Update
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"customizable_id": {
"type": "integer",
"format": "int32",
"description": "Customizable ID"
},
"type": {
"type": "string",
"enum": [
"CustomizableAttribute::Boolean",
"CustomizableAttribute::Date",
"CustomizableAttribute::DoubleSelect",
"CustomizableAttribute::Number",
"CustomizableAttribute::Select",
"CustomizableAttribute::Text"
],
"description": "Customizable Attribute type"
},
"customizable_type": {
"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",
"mentorships",
"mentorships_mentee",
"mentorships_mentor",
"ne_event",
"ne_ticket",
"topic_approval",
"topic_mentorships",
"topic_mentorships_mentee",
"topic_mentorships_mentor",
"user",
"ventures_venture"
],
"description": "Customizable Attribute associated model (User, Experience)"
},
"name": {
"type": "string",
"description": "Customizable Attribute name"
},
"display_name": {
"type": "string",
"description": "Customizable Attribute displayed name"
},
"tooltip": {
"type": "string",
"description": "Customizable Attribute tooltip"
},
"placeholder": {
"type": "string",
"description": "Customizable Attribute placeholder"
},
"multi": {
"type": "boolean",
"description": "Customizable Attribute multi activated ?"
},
"text_size": {
"type": "integer",
"format": "int32",
"description": "Customizable Attribute text_size"
},
"visibility": {
"type": "string",
"enum": [
"admin_only",
"tagged_user",
"everybody",
"not_visible"
],
"description": "Customizable Attribute visibility"
},
"user_editable": {
"type": "boolean",
"description": "Customizable Attribute editable by the user ?"
},
"required": {
"type": "boolean",
"description": "Customizable Attribute required ?"
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "Customizable Attribute array of options"
},
"json_options": {
"type": "object",
"description": "Customizable Attribute json options (for double select)"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Customizable Attribute creation date"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Customizable Attribute last update date"
},
"selected_value": {
"type": "string",
"description": "Customizable Attribute selected value"
}
},
"description": "CustomizableAttribute model"
}Customizable Attribute UpdatePUT/api/admin/v2/network_events/customizable_attributes/{id}
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
URI Parameters
- id
string(required)
DELETE /api/admin/v2/network_events/customizable_attributes/id
Responses
Customizable Attribute Deletion
Customizable Attribute DeletionDELETE/api/admin/v2/network_events/customizable_attributes/{id}
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.
URI Parameters
- id
string(required)
ventures ¶
Operations about ventures
GET /api/admin/v2/ventures/team_members
Responses
Get Team members
GET /api/admin/v2/ventures/team_members/id
Responses
Show a Team member
DELETE /api/admin/v2/ventures/team_members/id
Responses
Delete a Team member
PUT /api/admin/v2/ventures/team_members/id
Requests
Body
{
"team_member[role]": "Hello, world!",
"team_member[status]": "Hello, world!"
}Schema
{
"type": "object",
"properties": {
"team_member[role]": {
"type": "string",
"description": "Role of the Team Member"
},
"team_member[status]": {
"type": "string",
"description": "Approvals::Network status of the Team member in the Venture"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Update a team member
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of the Venture"
},
"company_name": {
"type": "string",
"description": "Name of the Venture"
},
"high_level_pitch": {
"type": "string",
"description": "Pitch of the Venture"
},
"product": {
"type": "string",
"description": "Product sold by the Venture"
},
"logo": {
"type": "string",
"description": "URL to the logo of the Venture"
},
"company_website": {
"type": "string",
"description": "URL to the website of the Venture"
},
"twitter": {
"type": "string",
"description": "Link to the twitter acount of the venture"
},
"facebook": {
"type": "string",
"description": "Link to the facebook acount of the venture"
},
"angel_list": {
"type": "string",
"description": "Link to the angel list acount of the venture"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Venture creation date on the Service - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Venture update date - iso8601"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "ID of the User who created / has been linked to the Venture"
},
"currently_fundraising": {
"type": "boolean",
"description": "Is the Venture currently raising fund ?"
},
"feedable_at": {
"type": "string",
"format": "date-time",
"description": "Venture feed date - iso8601 / is used to sort items in a reverse chronological order in the live feed "
},
"fundraising_at": {
"type": "string",
"format": "date-time",
"description": "Venture is raising funds for the next date - iso8601"
},
"fundraising_amount": {
"type": "integer",
"format": "int32",
"description": "Amount of find the Venture is raising"
},
"help": {
"type": "string",
"description": "What help can be brought to the Venture"
},
"business_stage": {
"type": "string",
"enum": [
"seed_startup",
"growing",
"established",
"unknown"
],
"description": "Current development stage of the venture"
},
"non_profit": {
"type": "boolean",
"description": "Is the Venture non-for profit ?"
},
"video_html": {
"type": "string",
"description": "Link to a video presenting the Venture"
},
"created_date": {
"type": "string",
"format": "date-time",
"description": "Venture creation date - iso8601"
},
"cover_picture": {
"type": "string",
"description": "URL to the logo of the Venture"
},
"company_size": {
"type": "string",
"enum": [
"only_me",
"2_10",
"11_50",
"51_200",
"201_500",
"501_1000",
"1001_5000",
"5001_10000",
"10001_more"
],
"description": "Number of employees in the Venture"
},
"fundraising_currency": {
"type": "string",
"enum": [
"USD",
"EUR",
"GBP",
"AUD",
"CAD",
"JPY",
"BYR",
"PAB",
"SOS",
"SRD",
"SSP",
"STD",
"STN",
"SVC",
"SYP",
"SZL",
"THB",
"TJS",
"TMT",
"TND",
"TOP",
"TRY",
"NPR",
"TTD",
"TWD",
"NOK",
"TZS",
"UAH",
"UGX",
"NIO",
"PEN",
"OMR",
"PGK",
"PHP",
"PKR",
"PLN",
"PYG",
"QAR",
"RON",
"RSD",
"RUB",
"RWF",
"SAR",
"SBD",
"SCR",
"SDG",
"SEK",
"SGD",
"SHP",
"NZD",
"SKK",
"SLE",
"SLL",
"UYU",
"BCH",
"BTC",
"JEP",
"GGP",
"IMP",
"XFU",
"GBX",
"CNH",
"USDC",
"EEK",
"GHS",
"HRK",
"LTL",
"LVL",
"MRO",
"MTL",
"TMM",
"JPY",
"ZWD",
"ZWL",
"ZWN",
"ZWR",
"VEF",
"UZS",
"VES",
"VND",
"VUV",
"WST",
"XAF",
"XAG",
"XAU",
"XBA",
"XBB",
"XBC",
"XBD",
"XCD",
"XDR",
"XOF",
"XPD",
"XPF",
"XPT",
"XTS",
"YER",
"ZAR",
"ZMK",
"ZMW",
"AED",
"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",
"KZT",
"LAK",
"LBP",
"LKR",
"LRD",
"LSL",
"LYD",
"MAD",
"MDL",
"MGA",
"MKD",
"MMK",
"MNT",
"MOP",
"MRU",
"MUR",
"MVR",
"MWK",
"MXN",
"MYR",
"MZN",
"NAD",
"NGN",
"GNF",
"GTQ",
"GYD",
"HKD",
"HNL",
"HTG",
"HUF",
"IDR",
"ILS",
"INR",
"IQD",
"IRR",
"ISK",
"JMD",
"JOD",
"KES",
"KGS",
"KHR",
"KMF",
"KPW",
"KRW",
"KWD",
"KYD"
],
"description": "Currency linked to the fundraising"
},
"linkedin": {
"type": "string",
"description": "Link to the linkedin account of the company"
},
"tagline": {
"type": "string",
"description": "Tagline of the Venture"
},
"funding_rounds": {
"description": "Funding rounds of the Venture",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of the Funding Round"
},
"funding_type": {
"type": "string",
"enum": [
"Angel/pre-seed",
"Seed",
"Series A",
"Series B",
"Series C",
"Series D",
"Corporate Round",
"Acquired",
"Grant",
"Debt",
"Secondary"
],
"description": "Type of the Funding Round"
},
"amount": {
"type": "integer",
"format": "int32",
"description": "Amound raised in the Funding round"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Funding Round creation date - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Funding Round update date - iso8601"
},
"closed_date": {
"type": "string",
"format": "date-time",
"description": "Funding Round closing date - iso8601"
},
"press_url": {
"type": "string",
"description": "URL of the press release regarding this Funding Round"
},
"currency": {
"type": "string",
"enum": [
"usd",
"eur",
"gbp",
"aud",
"cad",
"jpy",
"byr",
"pab",
"sos",
"srd",
"ssp",
"std",
"stn",
"svc",
"syp",
"szl",
"thb",
"tjs",
"tmt",
"tnd",
"top",
"try",
"npr",
"ttd",
"twd",
"nok",
"tzs",
"uah",
"ugx",
"nio",
"pen",
"omr",
"pgk",
"php",
"pkr",
"pln",
"pyg",
"qar",
"ron",
"rsd",
"rub",
"rwf",
"sar",
"sbd",
"scr",
"sdg",
"sek",
"sgd",
"shp",
"nzd",
"skk",
"sle",
"sll",
"uyu",
"bch",
"btc",
"jep",
"ggp",
"imp",
"xfu",
"gbx",
"cnh",
"usdc",
"eek",
"ghs",
"hrk",
"ltl",
"lvl",
"mro",
"mtl",
"tmm",
"jpy",
"zwd",
"zwl",
"zwn",
"zwr",
"vef",
"uzs",
"ves",
"vnd",
"vuv",
"wst",
"xaf",
"xag",
"xau",
"xba",
"xbb",
"xbc",
"xbd",
"xcd",
"xdr",
"xof",
"xpd",
"xpf",
"xpt",
"xts",
"yer",
"zar",
"zmk",
"zmw",
"aed",
"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",
"kzt",
"lak",
"lbp",
"lkr",
"lrd",
"lsl",
"lyd",
"mad",
"mdl",
"mga",
"mkd",
"mmk",
"mnt",
"mop",
"mru",
"mur",
"mvr",
"mwk",
"mxn",
"myr",
"mzn",
"nad",
"ngn",
"gnf",
"gtq",
"gyd",
"hkd",
"hnl",
"htg",
"huf",
"idr",
"ils",
"inr",
"iqd",
"irr",
"isk",
"jmd",
"jod",
"kes",
"kgs",
"khr",
"kmf",
"kpw",
"krw",
"kwd",
"kyd"
],
"description": "Currency linked to the Funding Round"
},
"investors": {
"description": "Investors of the Funding Round",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of the Investor"
},
"name": {
"type": "string",
"description": "Name of the Investor"
},
"url": {
"type": "string",
"description": "URL to the website of the Investor"
}
}
}
}
},
"locations": {
"description": "Offices locations of the Venture",
"type": "object",
"properties": {
"city": {
"type": "string",
"description": "City"
},
"country": {
"type": "string",
"description": "Country"
},
"country_code": {
"type": "string",
"description": "ISO3166-2 Country code"
},
"address": {
"type": "string",
"description": "Address"
},
"lat": {
"type": "number",
"format": "float",
"description": "Latitude"
},
"lng": {
"type": "number",
"format": "float",
"description": "Longitude"
}
}
},
"team_members": {
"description": "Team members of the Venture",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of the Team Member"
},
"role": {
"type": "string",
"description": "Role of the Team Member"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "ID of the User linked to the Team Member"
},
"status": {
"type": "string",
"enum": [
"pending",
"accepted",
"declined"
],
"description": "Approvals::Network status of the Team member in the Venture"
},
"venture_id": {
"type": "integer",
"format": "int32",
"description": "ID of the Venture linked to the Team Member"
}
}
},
"industry_ids": {
"type": "integer",
"format": "int32",
"description": "Industries related to the Venture"
},
"parent": {
"description": "Parent Information",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Parent ID"
},
"type": {
"type": "string",
"description": "Parent type"
}
}
},
"customizable_attributes": {
"type": "array",
"items": {
"type": "object"
},
"description": "Array of customizables attribute mapping name to the value"
}
},
"description": "VentureEntity model"
}POST /api/admin/v2/ventures/id/team_members
Requests
Body
{
"team_member[user_id]": 1,
"team_member[role]": "Hello, world!",
"team_member[status]": "Hello, world!"
}Schema
{
"type": "object",
"properties": {
"team_member[user_id]": {
"type": "number"
},
"team_member[role]": {
"type": "string",
"description": "Role of the Team Member"
},
"team_member[status]": {
"type": "string",
"description": "Approvals::Network status of the Team member in the Venture"
}
},
"required": [
"team_member[user_id]"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Add a team member to a Venture
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of the Venture"
},
"company_name": {
"type": "string",
"description": "Name of the Venture"
},
"high_level_pitch": {
"type": "string",
"description": "Pitch of the Venture"
},
"product": {
"type": "string",
"description": "Product sold by the Venture"
},
"logo": {
"type": "string",
"description": "URL to the logo of the Venture"
},
"company_website": {
"type": "string",
"description": "URL to the website of the Venture"
},
"twitter": {
"type": "string",
"description": "Link to the twitter acount of the venture"
},
"facebook": {
"type": "string",
"description": "Link to the facebook acount of the venture"
},
"angel_list": {
"type": "string",
"description": "Link to the angel list acount of the venture"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Venture creation date on the Service - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Venture update date - iso8601"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "ID of the User who created / has been linked to the Venture"
},
"currently_fundraising": {
"type": "boolean",
"description": "Is the Venture currently raising fund ?"
},
"feedable_at": {
"type": "string",
"format": "date-time",
"description": "Venture feed date - iso8601 / is used to sort items in a reverse chronological order in the live feed "
},
"fundraising_at": {
"type": "string",
"format": "date-time",
"description": "Venture is raising funds for the next date - iso8601"
},
"fundraising_amount": {
"type": "integer",
"format": "int32",
"description": "Amount of find the Venture is raising"
},
"help": {
"type": "string",
"description": "What help can be brought to the Venture"
},
"business_stage": {
"type": "string",
"enum": [
"seed_startup",
"growing",
"established",
"unknown"
],
"description": "Current development stage of the venture"
},
"non_profit": {
"type": "boolean",
"description": "Is the Venture non-for profit ?"
},
"video_html": {
"type": "string",
"description": "Link to a video presenting the Venture"
},
"created_date": {
"type": "string",
"format": "date-time",
"description": "Venture creation date - iso8601"
},
"cover_picture": {
"type": "string",
"description": "URL to the logo of the Venture"
},
"company_size": {
"type": "string",
"enum": [
"only_me",
"2_10",
"11_50",
"51_200",
"201_500",
"501_1000",
"1001_5000",
"5001_10000",
"10001_more"
],
"description": "Number of employees in the Venture"
},
"fundraising_currency": {
"type": "string",
"enum": [
"USD",
"EUR",
"GBP",
"AUD",
"CAD",
"JPY",
"BYR",
"PAB",
"SOS",
"SRD",
"SSP",
"STD",
"STN",
"SVC",
"SYP",
"SZL",
"THB",
"TJS",
"TMT",
"TND",
"TOP",
"TRY",
"NPR",
"TTD",
"TWD",
"NOK",
"TZS",
"UAH",
"UGX",
"NIO",
"PEN",
"OMR",
"PGK",
"PHP",
"PKR",
"PLN",
"PYG",
"QAR",
"RON",
"RSD",
"RUB",
"RWF",
"SAR",
"SBD",
"SCR",
"SDG",
"SEK",
"SGD",
"SHP",
"NZD",
"SKK",
"SLE",
"SLL",
"UYU",
"BCH",
"BTC",
"JEP",
"GGP",
"IMP",
"XFU",
"GBX",
"CNH",
"USDC",
"EEK",
"GHS",
"HRK",
"LTL",
"LVL",
"MRO",
"MTL",
"TMM",
"JPY",
"ZWD",
"ZWL",
"ZWN",
"ZWR",
"VEF",
"UZS",
"VES",
"VND",
"VUV",
"WST",
"XAF",
"XAG",
"XAU",
"XBA",
"XBB",
"XBC",
"XBD",
"XCD",
"XDR",
"XOF",
"XPD",
"XPF",
"XPT",
"XTS",
"YER",
"ZAR",
"ZMK",
"ZMW",
"AED",
"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",
"KZT",
"LAK",
"LBP",
"LKR",
"LRD",
"LSL",
"LYD",
"MAD",
"MDL",
"MGA",
"MKD",
"MMK",
"MNT",
"MOP",
"MRU",
"MUR",
"MVR",
"MWK",
"MXN",
"MYR",
"MZN",
"NAD",
"NGN",
"GNF",
"GTQ",
"GYD",
"HKD",
"HNL",
"HTG",
"HUF",
"IDR",
"ILS",
"INR",
"IQD",
"IRR",
"ISK",
"JMD",
"JOD",
"KES",
"KGS",
"KHR",
"KMF",
"KPW",
"KRW",
"KWD",
"KYD"
],
"description": "Currency linked to the fundraising"
},
"linkedin": {
"type": "string",
"description": "Link to the linkedin account of the company"
},
"tagline": {
"type": "string",
"description": "Tagline of the Venture"
},
"funding_rounds": {
"description": "Funding rounds of the Venture",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of the Funding Round"
},
"funding_type": {
"type": "string",
"enum": [
"Angel/pre-seed",
"Seed",
"Series A",
"Series B",
"Series C",
"Series D",
"Corporate Round",
"Acquired",
"Grant",
"Debt",
"Secondary"
],
"description": "Type of the Funding Round"
},
"amount": {
"type": "integer",
"format": "int32",
"description": "Amound raised in the Funding round"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Funding Round creation date - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Funding Round update date - iso8601"
},
"closed_date": {
"type": "string",
"format": "date-time",
"description": "Funding Round closing date - iso8601"
},
"press_url": {
"type": "string",
"description": "URL of the press release regarding this Funding Round"
},
"currency": {
"type": "string",
"enum": [
"usd",
"eur",
"gbp",
"aud",
"cad",
"jpy",
"byr",
"pab",
"sos",
"srd",
"ssp",
"std",
"stn",
"svc",
"syp",
"szl",
"thb",
"tjs",
"tmt",
"tnd",
"top",
"try",
"npr",
"ttd",
"twd",
"nok",
"tzs",
"uah",
"ugx",
"nio",
"pen",
"omr",
"pgk",
"php",
"pkr",
"pln",
"pyg",
"qar",
"ron",
"rsd",
"rub",
"rwf",
"sar",
"sbd",
"scr",
"sdg",
"sek",
"sgd",
"shp",
"nzd",
"skk",
"sle",
"sll",
"uyu",
"bch",
"btc",
"jep",
"ggp",
"imp",
"xfu",
"gbx",
"cnh",
"usdc",
"eek",
"ghs",
"hrk",
"ltl",
"lvl",
"mro",
"mtl",
"tmm",
"jpy",
"zwd",
"zwl",
"zwn",
"zwr",
"vef",
"uzs",
"ves",
"vnd",
"vuv",
"wst",
"xaf",
"xag",
"xau",
"xba",
"xbb",
"xbc",
"xbd",
"xcd",
"xdr",
"xof",
"xpd",
"xpf",
"xpt",
"xts",
"yer",
"zar",
"zmk",
"zmw",
"aed",
"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",
"kzt",
"lak",
"lbp",
"lkr",
"lrd",
"lsl",
"lyd",
"mad",
"mdl",
"mga",
"mkd",
"mmk",
"mnt",
"mop",
"mru",
"mur",
"mvr",
"mwk",
"mxn",
"myr",
"mzn",
"nad",
"ngn",
"gnf",
"gtq",
"gyd",
"hkd",
"hnl",
"htg",
"huf",
"idr",
"ils",
"inr",
"iqd",
"irr",
"isk",
"jmd",
"jod",
"kes",
"kgs",
"khr",
"kmf",
"kpw",
"krw",
"kwd",
"kyd"
],
"description": "Currency linked to the Funding Round"
},
"investors": {
"description": "Investors of the Funding Round",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of the Investor"
},
"name": {
"type": "string",
"description": "Name of the Investor"
},
"url": {
"type": "string",
"description": "URL to the website of the Investor"
}
}
}
}
},
"locations": {
"description": "Offices locations of the Venture",
"type": "object",
"properties": {
"city": {
"type": "string",
"description": "City"
},
"country": {
"type": "string",
"description": "Country"
},
"country_code": {
"type": "string",
"description": "ISO3166-2 Country code"
},
"address": {
"type": "string",
"description": "Address"
},
"lat": {
"type": "number",
"format": "float",
"description": "Latitude"
},
"lng": {
"type": "number",
"format": "float",
"description": "Longitude"
}
}
},
"team_members": {
"description": "Team members of the Venture",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of the Team Member"
},
"role": {
"type": "string",
"description": "Role of the Team Member"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "ID of the User linked to the Team Member"
},
"status": {
"type": "string",
"enum": [
"pending",
"accepted",
"declined"
],
"description": "Approvals::Network status of the Team member in the Venture"
},
"venture_id": {
"type": "integer",
"format": "int32",
"description": "ID of the Venture linked to the Team Member"
}
}
},
"industry_ids": {
"type": "integer",
"format": "int32",
"description": "Industries related to the Venture"
},
"parent": {
"description": "Parent Information",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Parent ID"
},
"type": {
"type": "string",
"description": "Parent type"
}
}
},
"customizable_attributes": {
"type": "array",
"items": {
"type": "object"
},
"description": "Array of customizables attribute mapping name to the value"
}
},
"description": "VentureEntity model"
}POST/api/admin/v2/ventures/{id}/team_members
Add a team member to a Venture
URI Parameters
- id
number(required)
GET /api/admin/v2/ventures?parent=&parent_id=&linked_topic_id=&user_id=
Responses
List of Ventures
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of the Venture"
},
"company_name": {
"type": "string",
"description": "Name of the Venture"
},
"high_level_pitch": {
"type": "string",
"description": "Pitch of the Venture"
},
"product": {
"type": "string",
"description": "Product sold by the Venture"
},
"logo": {
"type": "string",
"description": "URL to the logo of the Venture"
},
"company_website": {
"type": "string",
"description": "URL to the website of the Venture"
},
"twitter": {
"type": "string",
"description": "Link to the twitter acount of the venture"
},
"facebook": {
"type": "string",
"description": "Link to the facebook acount of the venture"
},
"angel_list": {
"type": "string",
"description": "Link to the angel list acount of the venture"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Venture creation date on the Service - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Venture update date - iso8601"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "ID of the User who created / has been linked to the Venture"
},
"currently_fundraising": {
"type": "boolean",
"description": "Is the Venture currently raising fund ?"
},
"feedable_at": {
"type": "string",
"format": "date-time",
"description": "Venture feed date - iso8601 / is used to sort items in a reverse chronological order in the live feed "
},
"fundraising_at": {
"type": "string",
"format": "date-time",
"description": "Venture is raising funds for the next date - iso8601"
},
"fundraising_amount": {
"type": "integer",
"format": "int32",
"description": "Amount of find the Venture is raising"
},
"help": {
"type": "string",
"description": "What help can be brought to the Venture"
},
"business_stage": {
"type": "string",
"enum": [
"seed_startup",
"growing",
"established",
"unknown"
],
"description": "Current development stage of the venture"
},
"non_profit": {
"type": "boolean",
"description": "Is the Venture non-for profit ?"
},
"video_html": {
"type": "string",
"description": "Link to a video presenting the Venture"
},
"created_date": {
"type": "string",
"format": "date-time",
"description": "Venture creation date - iso8601"
},
"cover_picture": {
"type": "string",
"description": "URL to the logo of the Venture"
},
"company_size": {
"type": "string",
"enum": [
"only_me",
"2_10",
"11_50",
"51_200",
"201_500",
"501_1000",
"1001_5000",
"5001_10000",
"10001_more"
],
"description": "Number of employees in the Venture"
},
"fundraising_currency": {
"type": "string",
"enum": [
"USD",
"EUR",
"GBP",
"AUD",
"CAD",
"JPY",
"BYR",
"PAB",
"SOS",
"SRD",
"SSP",
"STD",
"STN",
"SVC",
"SYP",
"SZL",
"THB",
"TJS",
"TMT",
"TND",
"TOP",
"TRY",
"NPR",
"TTD",
"TWD",
"NOK",
"TZS",
"UAH",
"UGX",
"NIO",
"PEN",
"OMR",
"PGK",
"PHP",
"PKR",
"PLN",
"PYG",
"QAR",
"RON",
"RSD",
"RUB",
"RWF",
"SAR",
"SBD",
"SCR",
"SDG",
"SEK",
"SGD",
"SHP",
"NZD",
"SKK",
"SLE",
"SLL",
"UYU",
"BCH",
"BTC",
"JEP",
"GGP",
"IMP",
"XFU",
"GBX",
"CNH",
"USDC",
"EEK",
"GHS",
"HRK",
"LTL",
"LVL",
"MRO",
"MTL",
"TMM",
"JPY",
"ZWD",
"ZWL",
"ZWN",
"ZWR",
"VEF",
"UZS",
"VES",
"VND",
"VUV",
"WST",
"XAF",
"XAG",
"XAU",
"XBA",
"XBB",
"XBC",
"XBD",
"XCD",
"XDR",
"XOF",
"XPD",
"XPF",
"XPT",
"XTS",
"YER",
"ZAR",
"ZMK",
"ZMW",
"AED",
"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",
"KZT",
"LAK",
"LBP",
"LKR",
"LRD",
"LSL",
"LYD",
"MAD",
"MDL",
"MGA",
"MKD",
"MMK",
"MNT",
"MOP",
"MRU",
"MUR",
"MVR",
"MWK",
"MXN",
"MYR",
"MZN",
"NAD",
"NGN",
"GNF",
"GTQ",
"GYD",
"HKD",
"HNL",
"HTG",
"HUF",
"IDR",
"ILS",
"INR",
"IQD",
"IRR",
"ISK",
"JMD",
"JOD",
"KES",
"KGS",
"KHR",
"KMF",
"KPW",
"KRW",
"KWD",
"KYD"
],
"description": "Currency linked to the fundraising"
},
"linkedin": {
"type": "string",
"description": "Link to the linkedin account of the company"
},
"tagline": {
"type": "string",
"description": "Tagline of the Venture"
},
"funding_rounds": {
"description": "Funding rounds of the Venture",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of the Funding Round"
},
"funding_type": {
"type": "string",
"enum": [
"Angel/pre-seed",
"Seed",
"Series A",
"Series B",
"Series C",
"Series D",
"Corporate Round",
"Acquired",
"Grant",
"Debt",
"Secondary"
],
"description": "Type of the Funding Round"
},
"amount": {
"type": "integer",
"format": "int32",
"description": "Amound raised in the Funding round"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Funding Round creation date - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Funding Round update date - iso8601"
},
"closed_date": {
"type": "string",
"format": "date-time",
"description": "Funding Round closing date - iso8601"
},
"press_url": {
"type": "string",
"description": "URL of the press release regarding this Funding Round"
},
"currency": {
"type": "string",
"enum": [
"usd",
"eur",
"gbp",
"aud",
"cad",
"jpy",
"byr",
"pab",
"sos",
"srd",
"ssp",
"std",
"stn",
"svc",
"syp",
"szl",
"thb",
"tjs",
"tmt",
"tnd",
"top",
"try",
"npr",
"ttd",
"twd",
"nok",
"tzs",
"uah",
"ugx",
"nio",
"pen",
"omr",
"pgk",
"php",
"pkr",
"pln",
"pyg",
"qar",
"ron",
"rsd",
"rub",
"rwf",
"sar",
"sbd",
"scr",
"sdg",
"sek",
"sgd",
"shp",
"nzd",
"skk",
"sle",
"sll",
"uyu",
"bch",
"btc",
"jep",
"ggp",
"imp",
"xfu",
"gbx",
"cnh",
"usdc",
"eek",
"ghs",
"hrk",
"ltl",
"lvl",
"mro",
"mtl",
"tmm",
"jpy",
"zwd",
"zwl",
"zwn",
"zwr",
"vef",
"uzs",
"ves",
"vnd",
"vuv",
"wst",
"xaf",
"xag",
"xau",
"xba",
"xbb",
"xbc",
"xbd",
"xcd",
"xdr",
"xof",
"xpd",
"xpf",
"xpt",
"xts",
"yer",
"zar",
"zmk",
"zmw",
"aed",
"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",
"kzt",
"lak",
"lbp",
"lkr",
"lrd",
"lsl",
"lyd",
"mad",
"mdl",
"mga",
"mkd",
"mmk",
"mnt",
"mop",
"mru",
"mur",
"mvr",
"mwk",
"mxn",
"myr",
"mzn",
"nad",
"ngn",
"gnf",
"gtq",
"gyd",
"hkd",
"hnl",
"htg",
"huf",
"idr",
"ils",
"inr",
"iqd",
"irr",
"isk",
"jmd",
"jod",
"kes",
"kgs",
"khr",
"kmf",
"kpw",
"krw",
"kwd",
"kyd"
],
"description": "Currency linked to the Funding Round"
},
"investors": {
"description": "Investors of the Funding Round",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of the Investor"
},
"name": {
"type": "string",
"description": "Name of the Investor"
},
"url": {
"type": "string",
"description": "URL to the website of the Investor"
}
}
}
}
},
"locations": {
"description": "Offices locations of the Venture",
"type": "object",
"properties": {
"city": {
"type": "string",
"description": "City"
},
"country": {
"type": "string",
"description": "Country"
},
"country_code": {
"type": "string",
"description": "ISO3166-2 Country code"
},
"address": {
"type": "string",
"description": "Address"
},
"lat": {
"type": "number",
"format": "float",
"description": "Latitude"
},
"lng": {
"type": "number",
"format": "float",
"description": "Longitude"
}
}
},
"team_members": {
"description": "Team members of the Venture",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of the Team Member"
},
"role": {
"type": "string",
"description": "Role of the Team Member"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "ID of the User linked to the Team Member"
},
"status": {
"type": "string",
"enum": [
"pending",
"accepted",
"declined"
],
"description": "Approvals::Network status of the Team member in the Venture"
},
"venture_id": {
"type": "integer",
"format": "int32",
"description": "ID of the Venture linked to the Team Member"
}
}
},
"industry_ids": {
"type": "integer",
"format": "int32",
"description": "Industries related to the Venture"
},
"parent": {
"description": "Parent Information",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Parent ID"
},
"type": {
"type": "string",
"description": "Parent type"
}
}
},
"customizable_attributes": {
"type": "array",
"items": {
"type": "object"
},
"description": "Array of customizables attribute mapping name to the value"
}
},
"description": "VentureEntity model"
}List of VenturesGET/api/admin/v2/ventures{?parent,parent_id,linked_topic_id,user_id}
Get a paginated list of Ventures
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 ventures (from both group and community)
Use the parent option filtering to retrieve only topic/community/all ventures. Use the parent_id option filtering along the topic filtering option to get ventures from a certain topic.
URI Parameters
- parent
string(required)- parent_id
number(required)- linked_topic_id
string(required)This parameter is deprecated use the parent filtering
- user_id
string(required)
POST /api/admin/v2/ventures
Requests
Body
{
"venture[company_name]": "Hello, world!",
"venture[business_stage]": "Hello, world!",
"venture[high_level_pitch]": "Hello, world!",
"venture[product]": "Hello, world!",
"venture[user_id]": 1,
"venture[customizable_attributes][]": [],
"venture[company_size]": "Hello, world!",
"venture[industry_ids][]": [
1
],
"venture[logo]": "Hello, world!",
"venture[cover_picture]": "Hello, world!",
"venture[company_website]": "Hello, world!",
"venture[twitter]": "Hello, world!",
"venture[facebook]": "Hello, world!",
"venture[angel_list]": "Hello, world!",
"venture[currently_fundraising]": true,
"venture[feedable_at]": "Hello, world!",
"venture[fundraising_at]": "Hello, world!",
"venture[fundraising_amount]": 1,
"venture[help]": "Hello, world!",
"venture[non_profit]": true,
"venture[video_html]": "Hello, world!",
"venture[created_date]": "Hello, world!",
"venture[fundraising_currency]": "Hello, world!",
"venture[linkedin]": "Hello, world!",
"venture[tagline]": "Hello, world!",
"venture[locations][][address]": [],
"venture[locations][][city]": [],
"venture[locations][][country_code]": [],
"venture[funding_rounds][][amount]": [
1
],
"venture[funding_rounds][][currency]": [],
"venture[funding_rounds][][funding_type]": [],
"venture[funding_rounds][][closed_date]": [],
"venture[funding_rounds][][press_url]": [],
"venture[funding_rounds][][investors][][name]": [],
"venture[funding_rounds][][investors][][url]": [],
"venture[team_members][][user_id]": [
1
],
"venture[team_members][][role]": [],
"venture[team_members][][status]": []
}Schema
{
"type": "object",
"properties": {
"venture[company_name]": {
"type": "string"
},
"venture[business_stage]": {
"type": "string"
},
"venture[high_level_pitch]": {
"type": "string"
},
"venture[product]": {
"type": "string"
},
"venture[user_id]": {
"type": "number"
},
"venture[customizable_attributes][]": {
"type": "array",
"description": "+"
},
"venture[company_size]": {
"type": "string"
},
"venture[industry_ids][]": {
"type": "array",
"items": {
"type": "number"
}
},
"venture[logo]": {
"type": "string"
},
"venture[cover_picture]": {
"type": "string"
},
"venture[company_website]": {
"type": "string",
"description": "URL to the website of the Venture"
},
"venture[twitter]": {
"type": "string",
"description": "Link to the twitter acount of the venture"
},
"venture[facebook]": {
"type": "string",
"description": "Link to the facebook acount of the venture"
},
"venture[angel_list]": {
"type": "string",
"description": "Link to the angel list acount of the venture"
},
"venture[currently_fundraising]": {
"type": "boolean",
"description": "Is the Venture currently raising fund ?"
},
"venture[feedable_at]": {
"type": "string",
"description": "Venture feed date - iso8601 / is used to sort items in a reverse chronological order in the live feed"
},
"venture[fundraising_at]": {
"type": "string",
"description": "Venture is raising funds for the next date - iso8601"
},
"venture[fundraising_amount]": {
"type": "number",
"description": "Amount of find the Venture is raising"
},
"venture[help]": {
"type": "string",
"description": "What help can be brought to the Venture"
},
"venture[non_profit]": {
"type": "boolean",
"description": "Is the Venture non-for profit ?"
},
"venture[video_html]": {
"type": "string",
"description": "Link to a video presenting the Venture"
},
"venture[created_date]": {
"type": "string",
"description": "Venture creation date - iso8601"
},
"venture[fundraising_currency]": {
"type": "string",
"description": "Currency linked to the fundraising"
},
"venture[linkedin]": {
"type": "string",
"description": "Link to the linkedin account of the company"
},
"venture[tagline]": {
"type": "string",
"description": "Tagline of the Venture"
},
"venture[locations][][address]": {
"type": "array",
"description": "+"
},
"venture[locations][][city]": {
"type": "array",
"description": "+"
},
"venture[locations][][country_code]": {
"type": "array",
"description": "+"
},
"venture[funding_rounds][][amount]": {
"type": "array",
"items": {
"type": "number"
},
"description": "Amound raised in the Funding round"
},
"venture[funding_rounds][][currency]": {
"type": "array",
"description": "+"
},
"venture[funding_rounds][][funding_type]": {
"type": "array",
"description": "Type of the Funding Round\n\n+"
},
"venture[funding_rounds][][closed_date]": {
"type": "array",
"description": "Funding Round closing date - iso8601\n\n+"
},
"venture[funding_rounds][][press_url]": {
"type": "array",
"description": "URL of the press release regarding this Funding Round\n\n+"
},
"venture[funding_rounds][][investors][][name]": {
"type": "array",
"description": "+"
},
"venture[funding_rounds][][investors][][url]": {
"type": "array",
"description": "URL to the website of the Investor\n\n+"
},
"venture[team_members][][user_id]": {
"type": "array",
"items": {
"type": "number"
}
},
"venture[team_members][][role]": {
"type": "array",
"description": "Role of the Team Member\n\n+"
},
"venture[team_members][][status]": {
"type": "array",
"description": "Approvals::Network status of the Team member in the Venture\n\n+"
}
},
"required": [
"venture[company_name]",
"venture[business_stage]",
"venture[high_level_pitch]",
"venture[product]",
"venture[user_id]",
"venture[funding_rounds][][currency]",
"venture[funding_rounds][][investors][][name]",
"venture[team_members][][user_id]"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Create a Network Venture
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of the Venture"
},
"company_name": {
"type": "string",
"description": "Name of the Venture"
},
"high_level_pitch": {
"type": "string",
"description": "Pitch of the Venture"
},
"product": {
"type": "string",
"description": "Product sold by the Venture"
},
"logo": {
"type": "string",
"description": "URL to the logo of the Venture"
},
"company_website": {
"type": "string",
"description": "URL to the website of the Venture"
},
"twitter": {
"type": "string",
"description": "Link to the twitter acount of the venture"
},
"facebook": {
"type": "string",
"description": "Link to the facebook acount of the venture"
},
"angel_list": {
"type": "string",
"description": "Link to the angel list acount of the venture"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Venture creation date on the Service - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Venture update date - iso8601"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "ID of the User who created / has been linked to the Venture"
},
"currently_fundraising": {
"type": "boolean",
"description": "Is the Venture currently raising fund ?"
},
"feedable_at": {
"type": "string",
"format": "date-time",
"description": "Venture feed date - iso8601 / is used to sort items in a reverse chronological order in the live feed "
},
"fundraising_at": {
"type": "string",
"format": "date-time",
"description": "Venture is raising funds for the next date - iso8601"
},
"fundraising_amount": {
"type": "integer",
"format": "int32",
"description": "Amount of find the Venture is raising"
},
"help": {
"type": "string",
"description": "What help can be brought to the Venture"
},
"business_stage": {
"type": "string",
"enum": [
"seed_startup",
"growing",
"established",
"unknown"
],
"description": "Current development stage of the venture"
},
"non_profit": {
"type": "boolean",
"description": "Is the Venture non-for profit ?"
},
"video_html": {
"type": "string",
"description": "Link to a video presenting the Venture"
},
"created_date": {
"type": "string",
"format": "date-time",
"description": "Venture creation date - iso8601"
},
"cover_picture": {
"type": "string",
"description": "URL to the logo of the Venture"
},
"company_size": {
"type": "string",
"enum": [
"only_me",
"2_10",
"11_50",
"51_200",
"201_500",
"501_1000",
"1001_5000",
"5001_10000",
"10001_more"
],
"description": "Number of employees in the Venture"
},
"fundraising_currency": {
"type": "string",
"enum": [
"USD",
"EUR",
"GBP",
"AUD",
"CAD",
"JPY",
"BYR",
"PAB",
"SOS",
"SRD",
"SSP",
"STD",
"STN",
"SVC",
"SYP",
"SZL",
"THB",
"TJS",
"TMT",
"TND",
"TOP",
"TRY",
"NPR",
"TTD",
"TWD",
"NOK",
"TZS",
"UAH",
"UGX",
"NIO",
"PEN",
"OMR",
"PGK",
"PHP",
"PKR",
"PLN",
"PYG",
"QAR",
"RON",
"RSD",
"RUB",
"RWF",
"SAR",
"SBD",
"SCR",
"SDG",
"SEK",
"SGD",
"SHP",
"NZD",
"SKK",
"SLE",
"SLL",
"UYU",
"BCH",
"BTC",
"JEP",
"GGP",
"IMP",
"XFU",
"GBX",
"CNH",
"USDC",
"EEK",
"GHS",
"HRK",
"LTL",
"LVL",
"MRO",
"MTL",
"TMM",
"JPY",
"ZWD",
"ZWL",
"ZWN",
"ZWR",
"VEF",
"UZS",
"VES",
"VND",
"VUV",
"WST",
"XAF",
"XAG",
"XAU",
"XBA",
"XBB",
"XBC",
"XBD",
"XCD",
"XDR",
"XOF",
"XPD",
"XPF",
"XPT",
"XTS",
"YER",
"ZAR",
"ZMK",
"ZMW",
"AED",
"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",
"KZT",
"LAK",
"LBP",
"LKR",
"LRD",
"LSL",
"LYD",
"MAD",
"MDL",
"MGA",
"MKD",
"MMK",
"MNT",
"MOP",
"MRU",
"MUR",
"MVR",
"MWK",
"MXN",
"MYR",
"MZN",
"NAD",
"NGN",
"GNF",
"GTQ",
"GYD",
"HKD",
"HNL",
"HTG",
"HUF",
"IDR",
"ILS",
"INR",
"IQD",
"IRR",
"ISK",
"JMD",
"JOD",
"KES",
"KGS",
"KHR",
"KMF",
"KPW",
"KRW",
"KWD",
"KYD"
],
"description": "Currency linked to the fundraising"
},
"linkedin": {
"type": "string",
"description": "Link to the linkedin account of the company"
},
"tagline": {
"type": "string",
"description": "Tagline of the Venture"
},
"funding_rounds": {
"description": "Funding rounds of the Venture",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of the Funding Round"
},
"funding_type": {
"type": "string",
"enum": [
"Angel/pre-seed",
"Seed",
"Series A",
"Series B",
"Series C",
"Series D",
"Corporate Round",
"Acquired",
"Grant",
"Debt",
"Secondary"
],
"description": "Type of the Funding Round"
},
"amount": {
"type": "integer",
"format": "int32",
"description": "Amound raised in the Funding round"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Funding Round creation date - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Funding Round update date - iso8601"
},
"closed_date": {
"type": "string",
"format": "date-time",
"description": "Funding Round closing date - iso8601"
},
"press_url": {
"type": "string",
"description": "URL of the press release regarding this Funding Round"
},
"currency": {
"type": "string",
"enum": [
"usd",
"eur",
"gbp",
"aud",
"cad",
"jpy",
"byr",
"pab",
"sos",
"srd",
"ssp",
"std",
"stn",
"svc",
"syp",
"szl",
"thb",
"tjs",
"tmt",
"tnd",
"top",
"try",
"npr",
"ttd",
"twd",
"nok",
"tzs",
"uah",
"ugx",
"nio",
"pen",
"omr",
"pgk",
"php",
"pkr",
"pln",
"pyg",
"qar",
"ron",
"rsd",
"rub",
"rwf",
"sar",
"sbd",
"scr",
"sdg",
"sek",
"sgd",
"shp",
"nzd",
"skk",
"sle",
"sll",
"uyu",
"bch",
"btc",
"jep",
"ggp",
"imp",
"xfu",
"gbx",
"cnh",
"usdc",
"eek",
"ghs",
"hrk",
"ltl",
"lvl",
"mro",
"mtl",
"tmm",
"jpy",
"zwd",
"zwl",
"zwn",
"zwr",
"vef",
"uzs",
"ves",
"vnd",
"vuv",
"wst",
"xaf",
"xag",
"xau",
"xba",
"xbb",
"xbc",
"xbd",
"xcd",
"xdr",
"xof",
"xpd",
"xpf",
"xpt",
"xts",
"yer",
"zar",
"zmk",
"zmw",
"aed",
"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",
"kzt",
"lak",
"lbp",
"lkr",
"lrd",
"lsl",
"lyd",
"mad",
"mdl",
"mga",
"mkd",
"mmk",
"mnt",
"mop",
"mru",
"mur",
"mvr",
"mwk",
"mxn",
"myr",
"mzn",
"nad",
"ngn",
"gnf",
"gtq",
"gyd",
"hkd",
"hnl",
"htg",
"huf",
"idr",
"ils",
"inr",
"iqd",
"irr",
"isk",
"jmd",
"jod",
"kes",
"kgs",
"khr",
"kmf",
"kpw",
"krw",
"kwd",
"kyd"
],
"description": "Currency linked to the Funding Round"
},
"investors": {
"description": "Investors of the Funding Round",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of the Investor"
},
"name": {
"type": "string",
"description": "Name of the Investor"
},
"url": {
"type": "string",
"description": "URL to the website of the Investor"
}
}
}
}
},
"locations": {
"description": "Offices locations of the Venture",
"type": "object",
"properties": {
"city": {
"type": "string",
"description": "City"
},
"country": {
"type": "string",
"description": "Country"
},
"country_code": {
"type": "string",
"description": "ISO3166-2 Country code"
},
"address": {
"type": "string",
"description": "Address"
},
"lat": {
"type": "number",
"format": "float",
"description": "Latitude"
},
"lng": {
"type": "number",
"format": "float",
"description": "Longitude"
}
}
},
"team_members": {
"description": "Team members of the Venture",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of the Team Member"
},
"role": {
"type": "string",
"description": "Role of the Team Member"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "ID of the User linked to the Team Member"
},
"status": {
"type": "string",
"enum": [
"pending",
"accepted",
"declined"
],
"description": "Approvals::Network status of the Team member in the Venture"
},
"venture_id": {
"type": "integer",
"format": "int32",
"description": "ID of the Venture linked to the Team Member"
}
}
},
"industry_ids": {
"type": "integer",
"format": "int32",
"description": "Industries related to the Venture"
},
"parent": {
"description": "Parent Information",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Parent ID"
},
"type": {
"type": "string",
"description": "Parent type"
}
}
},
"customizable_attributes": {
"type": "array",
"items": {
"type": "object"
},
"description": "Array of customizables attribute mapping name to the value"
}
},
"description": "VentureEntity model"
}Create a Network VenturePOST/api/admin/v2/ventures
Create a Network Venture
Logo and cover_picture must be sent as files (URL to files won’t work).
GET /api/admin/v2/ventures/id
Responses
Detail of a Venture
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of the Venture"
},
"company_name": {
"type": "string",
"description": "Name of the Venture"
},
"high_level_pitch": {
"type": "string",
"description": "Pitch of the Venture"
},
"product": {
"type": "string",
"description": "Product sold by the Venture"
},
"logo": {
"type": "string",
"description": "URL to the logo of the Venture"
},
"company_website": {
"type": "string",
"description": "URL to the website of the Venture"
},
"twitter": {
"type": "string",
"description": "Link to the twitter acount of the venture"
},
"facebook": {
"type": "string",
"description": "Link to the facebook acount of the venture"
},
"angel_list": {
"type": "string",
"description": "Link to the angel list acount of the venture"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Venture creation date on the Service - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Venture update date - iso8601"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "ID of the User who created / has been linked to the Venture"
},
"currently_fundraising": {
"type": "boolean",
"description": "Is the Venture currently raising fund ?"
},
"feedable_at": {
"type": "string",
"format": "date-time",
"description": "Venture feed date - iso8601 / is used to sort items in a reverse chronological order in the live feed "
},
"fundraising_at": {
"type": "string",
"format": "date-time",
"description": "Venture is raising funds for the next date - iso8601"
},
"fundraising_amount": {
"type": "integer",
"format": "int32",
"description": "Amount of find the Venture is raising"
},
"help": {
"type": "string",
"description": "What help can be brought to the Venture"
},
"business_stage": {
"type": "string",
"enum": [
"seed_startup",
"growing",
"established",
"unknown"
],
"description": "Current development stage of the venture"
},
"non_profit": {
"type": "boolean",
"description": "Is the Venture non-for profit ?"
},
"video_html": {
"type": "string",
"description": "Link to a video presenting the Venture"
},
"created_date": {
"type": "string",
"format": "date-time",
"description": "Venture creation date - iso8601"
},
"cover_picture": {
"type": "string",
"description": "URL to the logo of the Venture"
},
"company_size": {
"type": "string",
"enum": [
"only_me",
"2_10",
"11_50",
"51_200",
"201_500",
"501_1000",
"1001_5000",
"5001_10000",
"10001_more"
],
"description": "Number of employees in the Venture"
},
"fundraising_currency": {
"type": "string",
"enum": [
"USD",
"EUR",
"GBP",
"AUD",
"CAD",
"JPY",
"BYR",
"PAB",
"SOS",
"SRD",
"SSP",
"STD",
"STN",
"SVC",
"SYP",
"SZL",
"THB",
"TJS",
"TMT",
"TND",
"TOP",
"TRY",
"NPR",
"TTD",
"TWD",
"NOK",
"TZS",
"UAH",
"UGX",
"NIO",
"PEN",
"OMR",
"PGK",
"PHP",
"PKR",
"PLN",
"PYG",
"QAR",
"RON",
"RSD",
"RUB",
"RWF",
"SAR",
"SBD",
"SCR",
"SDG",
"SEK",
"SGD",
"SHP",
"NZD",
"SKK",
"SLE",
"SLL",
"UYU",
"BCH",
"BTC",
"JEP",
"GGP",
"IMP",
"XFU",
"GBX",
"CNH",
"USDC",
"EEK",
"GHS",
"HRK",
"LTL",
"LVL",
"MRO",
"MTL",
"TMM",
"JPY",
"ZWD",
"ZWL",
"ZWN",
"ZWR",
"VEF",
"UZS",
"VES",
"VND",
"VUV",
"WST",
"XAF",
"XAG",
"XAU",
"XBA",
"XBB",
"XBC",
"XBD",
"XCD",
"XDR",
"XOF",
"XPD",
"XPF",
"XPT",
"XTS",
"YER",
"ZAR",
"ZMK",
"ZMW",
"AED",
"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",
"KZT",
"LAK",
"LBP",
"LKR",
"LRD",
"LSL",
"LYD",
"MAD",
"MDL",
"MGA",
"MKD",
"MMK",
"MNT",
"MOP",
"MRU",
"MUR",
"MVR",
"MWK",
"MXN",
"MYR",
"MZN",
"NAD",
"NGN",
"GNF",
"GTQ",
"GYD",
"HKD",
"HNL",
"HTG",
"HUF",
"IDR",
"ILS",
"INR",
"IQD",
"IRR",
"ISK",
"JMD",
"JOD",
"KES",
"KGS",
"KHR",
"KMF",
"KPW",
"KRW",
"KWD",
"KYD"
],
"description": "Currency linked to the fundraising"
},
"linkedin": {
"type": "string",
"description": "Link to the linkedin account of the company"
},
"tagline": {
"type": "string",
"description": "Tagline of the Venture"
},
"funding_rounds": {
"description": "Funding rounds of the Venture",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of the Funding Round"
},
"funding_type": {
"type": "string",
"enum": [
"Angel/pre-seed",
"Seed",
"Series A",
"Series B",
"Series C",
"Series D",
"Corporate Round",
"Acquired",
"Grant",
"Debt",
"Secondary"
],
"description": "Type of the Funding Round"
},
"amount": {
"type": "integer",
"format": "int32",
"description": "Amound raised in the Funding round"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Funding Round creation date - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Funding Round update date - iso8601"
},
"closed_date": {
"type": "string",
"format": "date-time",
"description": "Funding Round closing date - iso8601"
},
"press_url": {
"type": "string",
"description": "URL of the press release regarding this Funding Round"
},
"currency": {
"type": "string",
"enum": [
"usd",
"eur",
"gbp",
"aud",
"cad",
"jpy",
"byr",
"pab",
"sos",
"srd",
"ssp",
"std",
"stn",
"svc",
"syp",
"szl",
"thb",
"tjs",
"tmt",
"tnd",
"top",
"try",
"npr",
"ttd",
"twd",
"nok",
"tzs",
"uah",
"ugx",
"nio",
"pen",
"omr",
"pgk",
"php",
"pkr",
"pln",
"pyg",
"qar",
"ron",
"rsd",
"rub",
"rwf",
"sar",
"sbd",
"scr",
"sdg",
"sek",
"sgd",
"shp",
"nzd",
"skk",
"sle",
"sll",
"uyu",
"bch",
"btc",
"jep",
"ggp",
"imp",
"xfu",
"gbx",
"cnh",
"usdc",
"eek",
"ghs",
"hrk",
"ltl",
"lvl",
"mro",
"mtl",
"tmm",
"jpy",
"zwd",
"zwl",
"zwn",
"zwr",
"vef",
"uzs",
"ves",
"vnd",
"vuv",
"wst",
"xaf",
"xag",
"xau",
"xba",
"xbb",
"xbc",
"xbd",
"xcd",
"xdr",
"xof",
"xpd",
"xpf",
"xpt",
"xts",
"yer",
"zar",
"zmk",
"zmw",
"aed",
"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",
"kzt",
"lak",
"lbp",
"lkr",
"lrd",
"lsl",
"lyd",
"mad",
"mdl",
"mga",
"mkd",
"mmk",
"mnt",
"mop",
"mru",
"mur",
"mvr",
"mwk",
"mxn",
"myr",
"mzn",
"nad",
"ngn",
"gnf",
"gtq",
"gyd",
"hkd",
"hnl",
"htg",
"huf",
"idr",
"ils",
"inr",
"iqd",
"irr",
"isk",
"jmd",
"jod",
"kes",
"kgs",
"khr",
"kmf",
"kpw",
"krw",
"kwd",
"kyd"
],
"description": "Currency linked to the Funding Round"
},
"investors": {
"description": "Investors of the Funding Round",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of the Investor"
},
"name": {
"type": "string",
"description": "Name of the Investor"
},
"url": {
"type": "string",
"description": "URL to the website of the Investor"
}
}
}
}
},
"locations": {
"description": "Offices locations of the Venture",
"type": "object",
"properties": {
"city": {
"type": "string",
"description": "City"
},
"country": {
"type": "string",
"description": "Country"
},
"country_code": {
"type": "string",
"description": "ISO3166-2 Country code"
},
"address": {
"type": "string",
"description": "Address"
},
"lat": {
"type": "number",
"format": "float",
"description": "Latitude"
},
"lng": {
"type": "number",
"format": "float",
"description": "Longitude"
}
}
},
"team_members": {
"description": "Team members of the Venture",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of the Team Member"
},
"role": {
"type": "string",
"description": "Role of the Team Member"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "ID of the User linked to the Team Member"
},
"status": {
"type": "string",
"enum": [
"pending",
"accepted",
"declined"
],
"description": "Approvals::Network status of the Team member in the Venture"
},
"venture_id": {
"type": "integer",
"format": "int32",
"description": "ID of the Venture linked to the Team Member"
}
}
},
"industry_ids": {
"type": "integer",
"format": "int32",
"description": "Industries related to the Venture"
},
"parent": {
"description": "Parent Information",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Parent ID"
},
"type": {
"type": "string",
"description": "Parent type"
}
}
},
"customizable_attributes": {
"type": "array",
"items": {
"type": "object"
},
"description": "Array of customizables attribute mapping name to the value"
}
},
"description": "VentureEntity model"
}DELETE /api/admin/v2/ventures/id
Responses
Delete a Venture
PUT /api/admin/v2/ventures/id
Requests
Body
{
"parent": "Hello, world!",
"parent_id": 1,
"venture[business_stage]": "Hello, world!",
"venture[industry_ids][]": [
1
],
"venture[customizable_attributes][]": [],
"venture[user_id]": 1,
"venture[company_size]": "Hello, world!",
"venture[logo]": "Hello, world!",
"venture[cover_picture]": "Hello, world!",
"venture[company_name]": "Hello, world!",
"venture[high_level_pitch]": "Hello, world!",
"venture[product]": "Hello, world!",
"venture[company_website]": "Hello, world!",
"venture[twitter]": "Hello, world!",
"venture[facebook]": "Hello, world!",
"venture[angel_list]": "Hello, world!",
"venture[currently_fundraising]": true,
"venture[feedable_at]": "Hello, world!",
"venture[fundraising_at]": "Hello, world!",
"venture[fundraising_amount]": 1,
"venture[help]": "Hello, world!",
"venture[non_profit]": true,
"venture[video_html]": "Hello, world!",
"venture[created_date]": "Hello, world!",
"venture[fundraising_currency]": "Hello, world!",
"venture[linkedin]": "Hello, world!",
"venture[tagline]": "Hello, world!",
"venture[locations][][id]": [
1
],
"venture[locations][][address]": [],
"venture[locations][][city]": [],
"venture[locations][][country_code]": [],
"venture[funding_rounds][][id]": [
1
],
"venture[funding_rounds][][amount]": [
1
],
"venture[funding_rounds][][currency]": [],
"venture[funding_rounds][][funding_type]": [],
"venture[funding_rounds][][closed_date]": [],
"venture[funding_rounds][][press_url]": [],
"venture[funding_rounds][][investors][][id]": [
1
],
"venture[funding_rounds][][investors][][name]": [],
"venture[funding_rounds][][investors][][url]": [],
"venture[team_members][][id]": [
1
],
"venture[team_members][][role]": [],
"venture[team_members][][status]": []
}Schema
{
"type": "object",
"properties": {
"parent": {
"type": "string",
"default": "all"
},
"parent_id": {
"type": "number"
},
"venture[business_stage]": {
"type": "string"
},
"venture[industry_ids][]": {
"type": "array",
"items": {
"type": "number"
},
"description": "Get ids from industries endpoint /settings/industries"
},
"venture[customizable_attributes][]": {
"type": "array",
"description": "+"
},
"venture[user_id]": {
"type": "number",
"description": "User ID corresponding to the owner of the venture"
},
"venture[company_size]": {
"type": "string"
},
"venture[logo]": {
"type": "string"
},
"venture[cover_picture]": {
"type": "string"
},
"venture[company_name]": {
"type": "string",
"description": "Name of the Venture"
},
"venture[high_level_pitch]": {
"type": "string",
"description": "Pitch of the Venture"
},
"venture[product]": {
"type": "string",
"description": "Product sold by the Venture"
},
"venture[company_website]": {
"type": "string",
"description": "URL to the website of the Venture"
},
"venture[twitter]": {
"type": "string",
"description": "Link to the twitter acount of the venture"
},
"venture[facebook]": {
"type": "string",
"description": "Link to the facebook acount of the venture"
},
"venture[angel_list]": {
"type": "string",
"description": "Link to the angel list acount of the venture"
},
"venture[currently_fundraising]": {
"type": "boolean",
"description": "Is the Venture currently raising fund ?"
},
"venture[feedable_at]": {
"type": "string",
"description": "Venture feed date - iso8601 / is used to sort items in a reverse chronological order in the live feed"
},
"venture[fundraising_at]": {
"type": "string",
"description": "Venture is raising funds for the next date - iso8601"
},
"venture[fundraising_amount]": {
"type": "number",
"description": "Amount of find the Venture is raising"
},
"venture[help]": {
"type": "string",
"description": "What help can be brought to the Venture"
},
"venture[non_profit]": {
"type": "boolean",
"description": "Is the Venture non-for profit ?"
},
"venture[video_html]": {
"type": "string",
"description": "Link to a video presenting the Venture"
},
"venture[created_date]": {
"type": "string",
"description": "Venture creation date - iso8601"
},
"venture[fundraising_currency]": {
"type": "string",
"description": "Currency linked to the fundraising"
},
"venture[linkedin]": {
"type": "string",
"description": "Link to the linkedin account of the company"
},
"venture[tagline]": {
"type": "string",
"description": "Tagline of the Venture"
},
"venture[locations][][id]": {
"type": "array",
"items": {
"type": "number"
}
},
"venture[locations][][address]": {
"type": "array",
"description": "+"
},
"venture[locations][][city]": {
"type": "array",
"description": "+"
},
"venture[locations][][country_code]": {
"type": "array",
"description": "+"
},
"venture[funding_rounds][][id]": {
"type": "array",
"items": {
"type": "number"
},
"description": "Unique ID of the Venture (include to update an existing funding round)"
},
"venture[funding_rounds][][amount]": {
"type": "array",
"items": {
"type": "number"
},
"description": "Amound raised in the Funding round"
},
"venture[funding_rounds][][currency]": {
"type": "array",
"description": "+"
},
"venture[funding_rounds][][funding_type]": {
"type": "array",
"description": "Type of the Funding Round\n\n+"
},
"venture[funding_rounds][][closed_date]": {
"type": "array",
"description": "Funding Round closing date - iso8601\n\n+"
},
"venture[funding_rounds][][press_url]": {
"type": "array",
"description": "URL of the press release regarding this Funding Round\n\n+"
},
"venture[funding_rounds][][investors][][id]": {
"type": "array",
"items": {
"type": "number"
},
"description": "Unique ID of the Investor (include to update an existing investor)"
},
"venture[funding_rounds][][investors][][name]": {
"type": "array",
"description": "Name of the Investor\n\n+"
},
"venture[funding_rounds][][investors][][url]": {
"type": "array",
"description": "URL to the website of the Investor\n\n+"
},
"venture[team_members][][id]": {
"type": "array",
"items": {
"type": "number"
}
},
"venture[team_members][][role]": {
"type": "array",
"description": "Role of the Team Member\n\n+"
},
"venture[team_members][][status]": {
"type": "array",
"description": "Approvals::Network status of the Team member in the Venture\n\n+"
}
},
"required": [
"venture[locations][][id]",
"venture[funding_rounds][][currency]",
"venture[team_members][][id]"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Update a Venture
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of the Venture"
},
"company_name": {
"type": "string",
"description": "Name of the Venture"
},
"high_level_pitch": {
"type": "string",
"description": "Pitch of the Venture"
},
"product": {
"type": "string",
"description": "Product sold by the Venture"
},
"logo": {
"type": "string",
"description": "URL to the logo of the Venture"
},
"company_website": {
"type": "string",
"description": "URL to the website of the Venture"
},
"twitter": {
"type": "string",
"description": "Link to the twitter acount of the venture"
},
"facebook": {
"type": "string",
"description": "Link to the facebook acount of the venture"
},
"angel_list": {
"type": "string",
"description": "Link to the angel list acount of the venture"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Venture creation date on the Service - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Venture update date - iso8601"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "ID of the User who created / has been linked to the Venture"
},
"currently_fundraising": {
"type": "boolean",
"description": "Is the Venture currently raising fund ?"
},
"feedable_at": {
"type": "string",
"format": "date-time",
"description": "Venture feed date - iso8601 / is used to sort items in a reverse chronological order in the live feed "
},
"fundraising_at": {
"type": "string",
"format": "date-time",
"description": "Venture is raising funds for the next date - iso8601"
},
"fundraising_amount": {
"type": "integer",
"format": "int32",
"description": "Amount of find the Venture is raising"
},
"help": {
"type": "string",
"description": "What help can be brought to the Venture"
},
"business_stage": {
"type": "string",
"enum": [
"seed_startup",
"growing",
"established",
"unknown"
],
"description": "Current development stage of the venture"
},
"non_profit": {
"type": "boolean",
"description": "Is the Venture non-for profit ?"
},
"video_html": {
"type": "string",
"description": "Link to a video presenting the Venture"
},
"created_date": {
"type": "string",
"format": "date-time",
"description": "Venture creation date - iso8601"
},
"cover_picture": {
"type": "string",
"description": "URL to the logo of the Venture"
},
"company_size": {
"type": "string",
"enum": [
"only_me",
"2_10",
"11_50",
"51_200",
"201_500",
"501_1000",
"1001_5000",
"5001_10000",
"10001_more"
],
"description": "Number of employees in the Venture"
},
"fundraising_currency": {
"type": "string",
"enum": [
"USD",
"EUR",
"GBP",
"AUD",
"CAD",
"JPY",
"BYR",
"PAB",
"SOS",
"SRD",
"SSP",
"STD",
"STN",
"SVC",
"SYP",
"SZL",
"THB",
"TJS",
"TMT",
"TND",
"TOP",
"TRY",
"NPR",
"TTD",
"TWD",
"NOK",
"TZS",
"UAH",
"UGX",
"NIO",
"PEN",
"OMR",
"PGK",
"PHP",
"PKR",
"PLN",
"PYG",
"QAR",
"RON",
"RSD",
"RUB",
"RWF",
"SAR",
"SBD",
"SCR",
"SDG",
"SEK",
"SGD",
"SHP",
"NZD",
"SKK",
"SLE",
"SLL",
"UYU",
"BCH",
"BTC",
"JEP",
"GGP",
"IMP",
"XFU",
"GBX",
"CNH",
"USDC",
"EEK",
"GHS",
"HRK",
"LTL",
"LVL",
"MRO",
"MTL",
"TMM",
"JPY",
"ZWD",
"ZWL",
"ZWN",
"ZWR",
"VEF",
"UZS",
"VES",
"VND",
"VUV",
"WST",
"XAF",
"XAG",
"XAU",
"XBA",
"XBB",
"XBC",
"XBD",
"XCD",
"XDR",
"XOF",
"XPD",
"XPF",
"XPT",
"XTS",
"YER",
"ZAR",
"ZMK",
"ZMW",
"AED",
"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",
"KZT",
"LAK",
"LBP",
"LKR",
"LRD",
"LSL",
"LYD",
"MAD",
"MDL",
"MGA",
"MKD",
"MMK",
"MNT",
"MOP",
"MRU",
"MUR",
"MVR",
"MWK",
"MXN",
"MYR",
"MZN",
"NAD",
"NGN",
"GNF",
"GTQ",
"GYD",
"HKD",
"HNL",
"HTG",
"HUF",
"IDR",
"ILS",
"INR",
"IQD",
"IRR",
"ISK",
"JMD",
"JOD",
"KES",
"KGS",
"KHR",
"KMF",
"KPW",
"KRW",
"KWD",
"KYD"
],
"description": "Currency linked to the fundraising"
},
"linkedin": {
"type": "string",
"description": "Link to the linkedin account of the company"
},
"tagline": {
"type": "string",
"description": "Tagline of the Venture"
},
"funding_rounds": {
"description": "Funding rounds of the Venture",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of the Funding Round"
},
"funding_type": {
"type": "string",
"enum": [
"Angel/pre-seed",
"Seed",
"Series A",
"Series B",
"Series C",
"Series D",
"Corporate Round",
"Acquired",
"Grant",
"Debt",
"Secondary"
],
"description": "Type of the Funding Round"
},
"amount": {
"type": "integer",
"format": "int32",
"description": "Amound raised in the Funding round"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Funding Round creation date - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Funding Round update date - iso8601"
},
"closed_date": {
"type": "string",
"format": "date-time",
"description": "Funding Round closing date - iso8601"
},
"press_url": {
"type": "string",
"description": "URL of the press release regarding this Funding Round"
},
"currency": {
"type": "string",
"enum": [
"usd",
"eur",
"gbp",
"aud",
"cad",
"jpy",
"byr",
"pab",
"sos",
"srd",
"ssp",
"std",
"stn",
"svc",
"syp",
"szl",
"thb",
"tjs",
"tmt",
"tnd",
"top",
"try",
"npr",
"ttd",
"twd",
"nok",
"tzs",
"uah",
"ugx",
"nio",
"pen",
"omr",
"pgk",
"php",
"pkr",
"pln",
"pyg",
"qar",
"ron",
"rsd",
"rub",
"rwf",
"sar",
"sbd",
"scr",
"sdg",
"sek",
"sgd",
"shp",
"nzd",
"skk",
"sle",
"sll",
"uyu",
"bch",
"btc",
"jep",
"ggp",
"imp",
"xfu",
"gbx",
"cnh",
"usdc",
"eek",
"ghs",
"hrk",
"ltl",
"lvl",
"mro",
"mtl",
"tmm",
"jpy",
"zwd",
"zwl",
"zwn",
"zwr",
"vef",
"uzs",
"ves",
"vnd",
"vuv",
"wst",
"xaf",
"xag",
"xau",
"xba",
"xbb",
"xbc",
"xbd",
"xcd",
"xdr",
"xof",
"xpd",
"xpf",
"xpt",
"xts",
"yer",
"zar",
"zmk",
"zmw",
"aed",
"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",
"kzt",
"lak",
"lbp",
"lkr",
"lrd",
"lsl",
"lyd",
"mad",
"mdl",
"mga",
"mkd",
"mmk",
"mnt",
"mop",
"mru",
"mur",
"mvr",
"mwk",
"mxn",
"myr",
"mzn",
"nad",
"ngn",
"gnf",
"gtq",
"gyd",
"hkd",
"hnl",
"htg",
"huf",
"idr",
"ils",
"inr",
"iqd",
"irr",
"isk",
"jmd",
"jod",
"kes",
"kgs",
"khr",
"kmf",
"kpw",
"krw",
"kwd",
"kyd"
],
"description": "Currency linked to the Funding Round"
},
"investors": {
"description": "Investors of the Funding Round",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of the Investor"
},
"name": {
"type": "string",
"description": "Name of the Investor"
},
"url": {
"type": "string",
"description": "URL to the website of the Investor"
}
}
}
}
},
"locations": {
"description": "Offices locations of the Venture",
"type": "object",
"properties": {
"city": {
"type": "string",
"description": "City"
},
"country": {
"type": "string",
"description": "Country"
},
"country_code": {
"type": "string",
"description": "ISO3166-2 Country code"
},
"address": {
"type": "string",
"description": "Address"
},
"lat": {
"type": "number",
"format": "float",
"description": "Latitude"
},
"lng": {
"type": "number",
"format": "float",
"description": "Longitude"
}
}
},
"team_members": {
"description": "Team members of the Venture",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of the Team Member"
},
"role": {
"type": "string",
"description": "Role of the Team Member"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "ID of the User linked to the Team Member"
},
"status": {
"type": "string",
"enum": [
"pending",
"accepted",
"declined"
],
"description": "Approvals::Network status of the Team member in the Venture"
},
"venture_id": {
"type": "integer",
"format": "int32",
"description": "ID of the Venture linked to the Team Member"
}
}
},
"industry_ids": {
"type": "integer",
"format": "int32",
"description": "Industries related to the Venture"
},
"parent": {
"description": "Parent Information",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Parent ID"
},
"type": {
"type": "string",
"description": "Parent type"
}
}
},
"customizable_attributes": {
"type": "array",
"items": {
"type": "object"
},
"description": "Array of customizables attribute mapping name to the value"
}
},
"description": "VentureEntity model"
}Update a VenturePUT/api/admin/v2/ventures/{id}
Update a Venture
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 venture from a certain topic.
URI Parameters
- id
number(required)
memberships ¶
Operations about memberships
PUT /api/admin/v2/memberships/types/membership_type_id/payment_options/id
Requests
Body
{
"payment_option[periodicity]": "Hello, world!",
"payment_option[recurring_mode]": "Hello, world!",
"payment_option[name]": "Hello, world!",
"payment_option[description]": "Hello, world!",
"payment_option[renewal_period]": 1,
"payment_option[grace_period]": 1,
"payment_option[price]": 1,
"payment_option[has_free_trial]": true,
"payment_option[free_trial_period_periodicity]": 1,
"payment_option[enable_expire_month]": true,
"payment_option[expire_month]": 1,
"payment_option[vat_name]": "Hello, world!",
"payment_option[vat_rate]": 1,
"payment_option[is_active]": true,
"payment_option[is_default]": true
}Schema
{
"type": "object",
"properties": {
"payment_option[periodicity]": {
"type": "string",
"description": "Duration of membership purchase"
},
"payment_option[recurring_mode]": {
"type": "string",
"description": "Description of the payment option"
},
"payment_option[name]": {
"type": "string",
"description": "Name of the payment option"
},
"payment_option[description]": {
"type": "string",
"description": "Description of the payment option"
},
"payment_option[renewal_period]": {
"type": "number",
"description": "Duration (in days) of renewal period"
},
"payment_option[grace_period]": {
"type": "number",
"description": "Duration (in days) of renewal grace period"
},
"payment_option[price]": {
"type": "number",
"description": "Payment option price"
},
"payment_option[has_free_trial]": {
"type": "boolean",
"description": "Does the Payment option offer a free trial?"
},
"payment_option[free_trial_period_periodicity]": {
"type": "number",
"description": "Duration (in days) of membership free trial period"
},
"payment_option[enable_expire_month]": {
"type": "boolean",
"description": "Does the Payment option expire in a set month?"
},
"payment_option[expire_month]": {
"type": "number",
"description": "Calendar number of expiration Month"
},
"payment_option[vat_name]": {
"type": "string",
"description": "VAT name"
},
"payment_option[vat_rate]": {
"type": "number",
"description": "VAT rate"
},
"payment_option[is_active]": {
"type": "boolean",
"description": "Is the Payment option active?"
},
"payment_option[is_default]": {
"type": "boolean",
"description": "Is the default Payment option?"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Payment Options update
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of the Payment Option"
},
"name": {
"type": "string",
"description": "Name of the payment option"
},
"description": {
"type": "string",
"description": "Description of the payment option"
},
"membership_type_id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of the parent Memberships Type"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Network Event creation date - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Network Event update date - iso8601"
},
"periodicity": {
"type": "string",
"enum": [
"none",
"week",
"two_weeks",
"fifteen_days",
"month",
"two_months",
"three_months",
"six_months",
"year",
"two_years",
"three_years",
"four_years",
"five_years"
],
"description": "Duration of membership purchase"
},
"recurring_mode": {
"type": "string",
"enum": [
"no_recurring",
"recurring_allowed",
"recurring_only"
],
"description": "Description of the payment option"
},
"renewal_period": {
"type": "integer",
"format": "int32",
"description": "Duration (in days) of renewal period"
},
"grace_period": {
"type": "integer",
"format": "int32",
"description": "Duration (in days) of renewal grace period"
},
"price": {
"type": "number",
"format": "float",
"description": "Payment option price"
},
"currency": {
"type": "string",
"description": "ISO code of the Currency for the Payment option"
},
"has_free_trial": {
"type": "boolean",
"description": "Does the Payment option offer a free trial?"
},
"free_trial_period_periodicity": {
"type": "integer",
"format": "int32",
"description": "Duration (in days) of membership free trial period"
},
"enable_expire_month": {
"type": "boolean",
"description": "Does the Payment option expire in a set month?"
},
"expire_month": {
"type": "integer",
"format": "int32",
"enum": [
"none",
"week",
"two_weeks",
"fifteen_days",
"month",
"two_months",
"three_months",
"six_months",
"year",
"two_years",
"three_years",
"four_years",
"five_years"
],
"description": "Calendar number of expiration Month"
},
"vat_name": {
"type": "string",
"description": "VAT name"
},
"vat_rate": {
"type": "number",
"format": "float",
"description": "VAT rate"
},
"is_active": {
"type": "boolean",
"description": "Is the Payment option active?"
},
"is_default": {
"type": "boolean",
"description": "Is the default Payment option?"
}
},
"description": "Admin_V2_Memberships_PaymentOptionsEntity model"
}Payment Options updatePUT/api/admin/v2/memberships/types/{membership_type_id}/payment_options/{id}
Update a payment option for the given Membership type
URI Parameters
- membership_type_id
number(required)Membership type ID
- id
number(required)Payment Option ID
POST /api/admin/v2/memberships/types/membership_type_id/payment_options
Requests
Body
{
"payment_option[name]": "Hello, world!",
"payment_option[periodicity]": "Hello, world!",
"payment_option[recurring_mode]": "Hello, world!",
"payment_option[description]": "Hello, world!",
"payment_option[renewal_period]": 1,
"payment_option[grace_period]": 1,
"payment_option[price]": 1,
"payment_option[has_free_trial]": true,
"payment_option[free_trial_period_periodicity]": 1,
"payment_option[enable_expire_month]": true,
"payment_option[expire_month]": 1,
"payment_option[vat_name]": "Hello, world!",
"payment_option[vat_rate]": 1,
"payment_option[is_active]": true,
"payment_option[is_default]": true
}Schema
{
"type": "object",
"properties": {
"payment_option[name]": {
"type": "string"
},
"payment_option[periodicity]": {
"type": "string",
"description": "Duration of membership purchase"
},
"payment_option[recurring_mode]": {
"type": "string",
"description": "Description of the payment option"
},
"payment_option[description]": {
"type": "string",
"description": "Description of the payment option"
},
"payment_option[renewal_period]": {
"type": "number",
"description": "Duration (in days) of renewal period"
},
"payment_option[grace_period]": {
"type": "number",
"description": "Duration (in days) of renewal grace period"
},
"payment_option[price]": {
"type": "number",
"description": "Payment option price"
},
"payment_option[has_free_trial]": {
"type": "boolean",
"description": "Does the Payment option offer a free trial?"
},
"payment_option[free_trial_period_periodicity]": {
"type": "number",
"description": "Duration (in days) of membership free trial period"
},
"payment_option[enable_expire_month]": {
"type": "boolean",
"description": "Does the Payment option expire in a set month?"
},
"payment_option[expire_month]": {
"type": "number",
"description": "Calendar number of expiration Month"
},
"payment_option[vat_name]": {
"type": "string",
"description": "VAT name"
},
"payment_option[vat_rate]": {
"type": "number",
"description": "VAT rate"
},
"payment_option[is_active]": {
"type": "boolean",
"description": "Is the Payment option active?"
},
"payment_option[is_default]": {
"type": "boolean",
"description": "Is the default Payment option?"
}
},
"required": [
"payment_option[name]",
"payment_option[periodicity]"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Payment Options create
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of the Payment Option"
},
"name": {
"type": "string",
"description": "Name of the payment option"
},
"description": {
"type": "string",
"description": "Description of the payment option"
},
"membership_type_id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of the parent Memberships Type"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Network Event creation date - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Network Event update date - iso8601"
},
"periodicity": {
"type": "string",
"enum": [
"none",
"week",
"two_weeks",
"fifteen_days",
"month",
"two_months",
"three_months",
"six_months",
"year",
"two_years",
"three_years",
"four_years",
"five_years"
],
"description": "Duration of membership purchase"
},
"recurring_mode": {
"type": "string",
"enum": [
"no_recurring",
"recurring_allowed",
"recurring_only"
],
"description": "Description of the payment option"
},
"renewal_period": {
"type": "integer",
"format": "int32",
"description": "Duration (in days) of renewal period"
},
"grace_period": {
"type": "integer",
"format": "int32",
"description": "Duration (in days) of renewal grace period"
},
"price": {
"type": "number",
"format": "float",
"description": "Payment option price"
},
"currency": {
"type": "string",
"description": "ISO code of the Currency for the Payment option"
},
"has_free_trial": {
"type": "boolean",
"description": "Does the Payment option offer a free trial?"
},
"free_trial_period_periodicity": {
"type": "integer",
"format": "int32",
"description": "Duration (in days) of membership free trial period"
},
"enable_expire_month": {
"type": "boolean",
"description": "Does the Payment option expire in a set month?"
},
"expire_month": {
"type": "integer",
"format": "int32",
"enum": [
"none",
"week",
"two_weeks",
"fifteen_days",
"month",
"two_months",
"three_months",
"six_months",
"year",
"two_years",
"three_years",
"four_years",
"five_years"
],
"description": "Calendar number of expiration Month"
},
"vat_name": {
"type": "string",
"description": "VAT name"
},
"vat_rate": {
"type": "number",
"format": "float",
"description": "VAT rate"
},
"is_active": {
"type": "boolean",
"description": "Is the Payment option active?"
},
"is_default": {
"type": "boolean",
"description": "Is the default Payment option?"
}
},
"description": "Admin_V2_Memberships_PaymentOptionsEntity model"
}Payment Options createPOST/api/admin/v2/memberships/types/{membership_type_id}/payment_options
Create a new payment option for the given Membership type
URI Parameters
- membership_type_id
number(required)Membership type ID
GET /api/admin/v2/memberships/types/id/payment_options
Responses
Payment Options Details
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of the Payment Option"
},
"name": {
"type": "string",
"description": "Name of the payment option"
},
"description": {
"type": "string",
"description": "Description of the payment option"
},
"membership_type_id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of the parent Memberships Type"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Network Event creation date - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Network Event update date - iso8601"
},
"periodicity": {
"type": "string",
"enum": [
"none",
"week",
"two_weeks",
"fifteen_days",
"month",
"two_months",
"three_months",
"six_months",
"year",
"two_years",
"three_years",
"four_years",
"five_years"
],
"description": "Duration of membership purchase"
},
"recurring_mode": {
"type": "string",
"enum": [
"no_recurring",
"recurring_allowed",
"recurring_only"
],
"description": "Description of the payment option"
},
"renewal_period": {
"type": "integer",
"format": "int32",
"description": "Duration (in days) of renewal period"
},
"grace_period": {
"type": "integer",
"format": "int32",
"description": "Duration (in days) of renewal grace period"
},
"price": {
"type": "number",
"format": "float",
"description": "Payment option price"
},
"currency": {
"type": "string",
"description": "ISO code of the Currency for the Payment option"
},
"has_free_trial": {
"type": "boolean",
"description": "Does the Payment option offer a free trial?"
},
"free_trial_period_periodicity": {
"type": "integer",
"format": "int32",
"description": "Duration (in days) of membership free trial period"
},
"enable_expire_month": {
"type": "boolean",
"description": "Does the Payment option expire in a set month?"
},
"expire_month": {
"type": "integer",
"format": "int32",
"enum": [
"none",
"week",
"two_weeks",
"fifteen_days",
"month",
"two_months",
"three_months",
"six_months",
"year",
"two_years",
"three_years",
"four_years",
"five_years"
],
"description": "Calendar number of expiration Month"
},
"vat_name": {
"type": "string",
"description": "VAT name"
},
"vat_rate": {
"type": "number",
"format": "float",
"description": "VAT rate"
},
"is_active": {
"type": "boolean",
"description": "Is the Payment option active?"
},
"is_default": {
"type": "boolean",
"description": "Is the default Payment option?"
}
},
"description": "Admin_V2_Memberships_PaymentOptionsEntity model"
}Payment Options DetailsGET/api/admin/v2/memberships/types/{id}/payment_options
Get a Membership Type’s payment options and their details
URI Parameters
- id
number(required)
GET /api/admin/v2/memberships/types?parent=&parent_id=&updated_since=
Responses
List of Memberships Types
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of the Memberships Type"
},
"external_id": {
"type": "string",
"description": "External ID of the Memberships Type (ID in your system)"
},
"name": {
"type": "string",
"description": "Memberships Type Name"
},
"description": {
"type": "string",
"description": "Memberships Type Description"
},
"active": {
"type": "boolean",
"description": "Memberships Type active ?"
},
"restriction_enabled": {
"type": "boolean",
"description": "Memberships Type restriction enabled ?"
},
"discharged": {
"type": "boolean",
"description": "Memberships Type discharged ?"
},
"recurring_payment_enabled": {
"type": "boolean",
"description": "Memberships Type recurring payment enabled ? (deprecated)"
},
"until_year_end": {
"type": "boolean",
"description": "Memberships Type valid until year end ?"
},
"enable_expire_month": {
"type": "boolean",
"description": "Memberships Type expire month ?"
},
"expire_month": {
"type": "integer",
"format": "int32",
"description": "Month when the Memberships Type expires"
},
"price": {
"type": "number",
"format": "float",
"description": "Memberships Type price"
},
"currency": {
"type": "string",
"description": "ISO code of the Currency of the Memberships Type"
},
"periodicity": {
"type": "string",
"enum": [
"none",
"week",
"fifteen_days",
"month",
"two_months",
"three_months",
"six_months",
"year",
"two_years",
"three_years",
"four_years",
"five_years"
],
"description": "Periodicity of the Memberships Type"
},
"recurring_mode": {
"type": "string",
"enum": [
"no_recurring",
"recurring_allowed",
"recurring_only"
],
"description": "Automatic renewal for memberships ?"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Membership type creation date - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Membership type update date - iso8601"
},
"payment_account_id": {
"type": "integer",
"format": "int32",
"description": "ID of associated payment account"
},
"parent": {
"description": "Parent Information",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Parent ID"
},
"type": {
"type": "string",
"description": "Parent type"
}
}
}
},
"description": "MembershipType model"
}List of Memberships TypesGET/api/admin/v2/memberships/types{?parent,parent_id,updated_since}
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.URI Parameters
- parent
string(required)- parent_id
string(required)- updated_since
string(required)
POST /api/admin/v2/memberships/types
Requests
Body
{
"type[currency]": "Hello, world!",
"type[periodicity]": "Hello, world!",
"type[price]": 1,
"type[external_id]": "Hello, world!",
"type[name]": "Hello, world!",
"type[description]": "Hello, world!",
"type[active]": true,
"type[restriction_enabled]": true,
"type[discharged]": true,
"type[recurring_payment_enabled]": true,
"type[until_year_end]": true,
"type[enable_expire_month]": true,
"type[expire_month]": 1,
"type[recurring_mode]": "Hello, world!",
"type[payment_account_id]": 1
}Schema
{
"type": "object",
"properties": {
"type[currency]": {
"type": "string"
},
"type[periodicity]": {
"type": "string"
},
"type[price]": {
"type": "number"
},
"type[external_id]": {
"type": "string",
"description": "External ID of the Memberships Type (ID in your system)"
},
"type[name]": {
"type": "string",
"description": "Memberships Type Name"
},
"type[description]": {
"type": "string",
"description": "Memberships Type Description"
},
"type[active]": {
"type": "boolean",
"description": "Memberships Type active ?"
},
"type[restriction_enabled]": {
"type": "boolean",
"description": "Memberships Type restriction enabled ?"
},
"type[discharged]": {
"type": "boolean",
"description": "Memberships Type discharged ?"
},
"type[recurring_payment_enabled]": {
"type": "boolean",
"description": "Memberships Type recurring payment enabled ? (deprecated)"
},
"type[until_year_end]": {
"type": "boolean",
"description": "Memberships Type valid until year end ?"
},
"type[enable_expire_month]": {
"type": "boolean",
"description": "Memberships Type expire month ?"
},
"type[expire_month]": {
"type": "number",
"description": "Month when the Memberships Type expires"
},
"type[recurring_mode]": {
"type": "string",
"description": "Automatic renewal for memberships ?"
},
"type[payment_account_id]": {
"type": "number",
"description": "ID of associated payment account"
}
},
"required": [
"type[currency]",
"type[periodicity]",
"type[price]"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Add a new Memberships Type
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of the Memberships Type"
},
"external_id": {
"type": "string",
"description": "External ID of the Memberships Type (ID in your system)"
},
"name": {
"type": "string",
"description": "Memberships Type Name"
},
"description": {
"type": "string",
"description": "Memberships Type Description"
},
"active": {
"type": "boolean",
"description": "Memberships Type active ?"
},
"restriction_enabled": {
"type": "boolean",
"description": "Memberships Type restriction enabled ?"
},
"discharged": {
"type": "boolean",
"description": "Memberships Type discharged ?"
},
"recurring_payment_enabled": {
"type": "boolean",
"description": "Memberships Type recurring payment enabled ? (deprecated)"
},
"until_year_end": {
"type": "boolean",
"description": "Memberships Type valid until year end ?"
},
"enable_expire_month": {
"type": "boolean",
"description": "Memberships Type expire month ?"
},
"expire_month": {
"type": "integer",
"format": "int32",
"description": "Month when the Memberships Type expires"
},
"price": {
"type": "number",
"format": "float",
"description": "Memberships Type price"
},
"currency": {
"type": "string",
"description": "ISO code of the Currency of the Memberships Type"
},
"periodicity": {
"type": "string",
"enum": [
"none",
"week",
"fifteen_days",
"month",
"two_months",
"three_months",
"six_months",
"year",
"two_years",
"three_years",
"four_years",
"five_years"
],
"description": "Periodicity of the Memberships Type"
},
"recurring_mode": {
"type": "string",
"enum": [
"no_recurring",
"recurring_allowed",
"recurring_only"
],
"description": "Automatic renewal for memberships ?"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Membership type creation date - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Membership type update date - iso8601"
},
"payment_account_id": {
"type": "integer",
"format": "int32",
"description": "ID of associated payment account"
},
"parent": {
"description": "Parent Information",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Parent ID"
},
"type": {
"type": "string",
"description": "Parent type"
}
}
}
},
"description": "MembershipType model"
}Add a new Memberships TypePOST/api/admin/v2/memberships/types
Required parameters
currencyperiodicityprice
Optional parameters
namedescriptionsso_identifierexternal_idactiverestriction_enableddischargedrecurring_payment_enableduntil_year_endenable_expire_monthexpire_monthrecurring_modepayment_account_id- Be careful when switching between payment accounts that have a different Currency type than the Membership
GET /api/admin/v2/memberships/types/id
Responses
Type Details
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of the Memberships Type"
},
"external_id": {
"type": "string",
"description": "External ID of the Memberships Type (ID in your system)"
},
"name": {
"type": "string",
"description": "Memberships Type Name"
},
"description": {
"type": "string",
"description": "Memberships Type Description"
},
"active": {
"type": "boolean",
"description": "Memberships Type active ?"
},
"restriction_enabled": {
"type": "boolean",
"description": "Memberships Type restriction enabled ?"
},
"discharged": {
"type": "boolean",
"description": "Memberships Type discharged ?"
},
"recurring_payment_enabled": {
"type": "boolean",
"description": "Memberships Type recurring payment enabled ? (deprecated)"
},
"until_year_end": {
"type": "boolean",
"description": "Memberships Type valid until year end ?"
},
"enable_expire_month": {
"type": "boolean",
"description": "Memberships Type expire month ?"
},
"expire_month": {
"type": "integer",
"format": "int32",
"description": "Month when the Memberships Type expires"
},
"price": {
"type": "number",
"format": "float",
"description": "Memberships Type price"
},
"currency": {
"type": "string",
"description": "ISO code of the Currency of the Memberships Type"
},
"periodicity": {
"type": "string",
"enum": [
"none",
"week",
"fifteen_days",
"month",
"two_months",
"three_months",
"six_months",
"year",
"two_years",
"three_years",
"four_years",
"five_years"
],
"description": "Periodicity of the Memberships Type"
},
"recurring_mode": {
"type": "string",
"enum": [
"no_recurring",
"recurring_allowed",
"recurring_only"
],
"description": "Automatic renewal for memberships ?"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Membership type creation date - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Membership type update date - iso8601"
},
"payment_account_id": {
"type": "integer",
"format": "int32",
"description": "ID of associated payment account"
},
"parent": {
"description": "Parent Information",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Parent ID"
},
"type": {
"type": "string",
"description": "Parent type"
}
}
}
},
"description": "MembershipType model"
}Type DetailsGET/api/admin/v2/memberships/types/{id}
Get a Membership Type details
URI Parameters
- id
number(required)
DELETE /api/admin/v2/memberships/types/id
Responses
Type Deletion
Type DeletionDELETE/api/admin/v2/memberships/types/{id}
Remove a Membership Type
URI Parameters
- id
number(required)
PUT /api/admin/v2/memberships/types/id
Requests
Body
{
"type[periodicity]": "Hello, world!",
"type[external_id]": "Hello, world!",
"type[name]": "Hello, world!",
"type[description]": "Hello, world!",
"type[active]": true,
"type[restriction_enabled]": true,
"type[discharged]": true,
"type[recurring_payment_enabled]": true,
"type[until_year_end]": true,
"type[enable_expire_month]": true,
"type[expire_month]": 1,
"type[price]": 1,
"type[currency]": "Hello, world!",
"type[recurring_mode]": "Hello, world!",
"type[payment_account_id]": 1
}Schema
{
"type": "object",
"properties": {
"type[periodicity]": {
"type": "string"
},
"type[external_id]": {
"type": "string",
"description": "External ID of the Memberships Type (ID in your system)"
},
"type[name]": {
"type": "string",
"description": "Memberships Type Name"
},
"type[description]": {
"type": "string",
"description": "Memberships Type Description"
},
"type[active]": {
"type": "boolean",
"description": "Memberships Type active ?"
},
"type[restriction_enabled]": {
"type": "boolean",
"description": "Memberships Type restriction enabled ?"
},
"type[discharged]": {
"type": "boolean",
"description": "Memberships Type discharged ?"
},
"type[recurring_payment_enabled]": {
"type": "boolean",
"description": "Memberships Type recurring payment enabled ? (deprecated)"
},
"type[until_year_end]": {
"type": "boolean",
"description": "Memberships Type valid until year end ?"
},
"type[enable_expire_month]": {
"type": "boolean",
"description": "Memberships Type expire month ?"
},
"type[expire_month]": {
"type": "number",
"description": "Month when the Memberships Type expires"
},
"type[price]": {
"type": "number",
"description": "Memberships Type price"
},
"type[currency]": {
"type": "string",
"description": "ISO code of the Currency of the Memberships Type"
},
"type[recurring_mode]": {
"type": "string",
"description": "Automatic renewal for memberships ?"
},
"type[payment_account_id]": {
"type": "number",
"description": "ID of associated payment account"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Update an existing Memberships Type
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of the Memberships Type"
},
"external_id": {
"type": "string",
"description": "External ID of the Memberships Type (ID in your system)"
},
"name": {
"type": "string",
"description": "Memberships Type Name"
},
"description": {
"type": "string",
"description": "Memberships Type Description"
},
"active": {
"type": "boolean",
"description": "Memberships Type active ?"
},
"restriction_enabled": {
"type": "boolean",
"description": "Memberships Type restriction enabled ?"
},
"discharged": {
"type": "boolean",
"description": "Memberships Type discharged ?"
},
"recurring_payment_enabled": {
"type": "boolean",
"description": "Memberships Type recurring payment enabled ? (deprecated)"
},
"until_year_end": {
"type": "boolean",
"description": "Memberships Type valid until year end ?"
},
"enable_expire_month": {
"type": "boolean",
"description": "Memberships Type expire month ?"
},
"expire_month": {
"type": "integer",
"format": "int32",
"description": "Month when the Memberships Type expires"
},
"price": {
"type": "number",
"format": "float",
"description": "Memberships Type price"
},
"currency": {
"type": "string",
"description": "ISO code of the Currency of the Memberships Type"
},
"periodicity": {
"type": "string",
"enum": [
"none",
"week",
"fifteen_days",
"month",
"two_months",
"three_months",
"six_months",
"year",
"two_years",
"three_years",
"four_years",
"five_years"
],
"description": "Periodicity of the Memberships Type"
},
"recurring_mode": {
"type": "string",
"enum": [
"no_recurring",
"recurring_allowed",
"recurring_only"
],
"description": "Automatic renewal for memberships ?"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Membership type creation date - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Membership type update date - iso8601"
},
"payment_account_id": {
"type": "integer",
"format": "int32",
"description": "ID of associated payment account"
},
"parent": {
"description": "Parent Information",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Parent ID"
},
"type": {
"type": "string",
"description": "Parent type"
}
}
}
},
"description": "MembershipType model"
}Update an existing Memberships TypePUT/api/admin/v2/memberships/types/{id}
Optional parameters
namedescriptionsso_identifiercurrencyperiodicitypriceexternal_idactiverestriction_enableddischargedrecurring_payment_enableduntil_year_endenable_expire_monthexpire_monthrecurring_modepayment_account_id- Be careful when switching between payment accounts that have a different Currency type than the Membership
URI Parameters
- id
number(required)
GET /api/admin/v3/memberships/subscriptions?parent=&parent_id=&updated_since=&user_id=
Responses
List of User Memberships Subscriptions
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"membership_type_id": {
"type": "integer",
"format": "int32",
"description": "Associated Membership Type ID"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "Associated User ID"
},
"payment_method_type": {
"type": "string",
"description": "Memberships Subscriptions payment method"
},
"payment_method": {
"type": "string",
"description": "Memberships Subscriptions payment method (Deprecated)"
},
"expires_at": {
"type": "string",
"format": "date-time",
"description": "Memberships Subscriptions expiration date"
},
"canceled_at": {
"type": "string",
"format": "date-time",
"description": "Memberships Subscriptions cancelation date"
},
"notes": {
"type": "string",
"description": "Memberships Subscriptions notes"
},
"created_by_admin": {
"type": "boolean",
"description": "Memberships Subscriptions created by an admin ?"
},
"is_recurring": {
"type": "boolean",
"description": "Memberships Subscriptions recurring payment ?"
},
"number_of_user_renewals": {
"type": "integer",
"format": "int32",
"description": "Memberships Subscriptions number of time renewed by user"
},
"number_of_admin_renewals": {
"type": "integer",
"format": "int32",
"description": "Memberships Subscriptions number of time renewed by admin"
},
"manual_transactions_ids": {
"type": "integer",
"format": "int32",
"description": "Ids of related manual transactions"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Memberships Subscriptions creation date"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Memberships Subscriptions last update date time - iso8601"
},
"payment_option_id": {
"type": "integer",
"format": "int32",
"description": "ID of payment option associated with the membership Subscription"
}
},
"required": [
"membership_type_id",
"user_id",
"payment_method_type"
],
"description": "Subscription model"
}List of User Memberships SubscriptionsGET/api/admin/v3/memberships/subscriptions{?parent,parent_id,updated_since,user_id}
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.
URI Parameters
- parent
string(required)- parent_id
string(required)- updated_since
string(required)- user_id
string(required)
POST /api/admin/v3/memberships/subscriptions
Requests
Body
{
"subscription[user_id]": 1,
"subscription[membership_type_id]": 1,
"subscription[payment_method_type]": "Hello, world!",
"subscription[notes]": "Hello, world!",
"subscription[send_confirmation_email]": true,
"subscription[expires_at]": "Hello, world!",
"subscription[payment_option_id]": 1
}Schema
{
"type": "object",
"properties": {
"subscription[user_id]": {
"type": "number"
},
"subscription[membership_type_id]": {
"type": "number"
},
"subscription[payment_method_type]": {
"type": "string"
},
"subscription[notes]": {
"type": "string"
},
"subscription[send_confirmation_email]": {
"type": "boolean"
},
"subscription[expires_at]": {
"type": "string"
},
"subscription[payment_option_id]": {
"type": "number"
}
},
"required": [
"subscription[user_id]",
"subscription[membership_type_id]",
"subscription[payment_method_type]"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Add a new Memberships Subscription
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"membership_type_id": {
"type": "integer",
"format": "int32",
"description": "Associated Membership Type ID"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "Associated User ID"
},
"payment_method_type": {
"type": "string",
"description": "Memberships Subscriptions payment method"
},
"payment_method": {
"type": "string",
"description": "Memberships Subscriptions payment method (Deprecated)"
},
"expires_at": {
"type": "string",
"format": "date-time",
"description": "Memberships Subscriptions expiration date"
},
"canceled_at": {
"type": "string",
"format": "date-time",
"description": "Memberships Subscriptions cancelation date"
},
"notes": {
"type": "string",
"description": "Memberships Subscriptions notes"
},
"created_by_admin": {
"type": "boolean",
"description": "Memberships Subscriptions created by an admin ?"
},
"is_recurring": {
"type": "boolean",
"description": "Memberships Subscriptions recurring payment ?"
},
"number_of_user_renewals": {
"type": "integer",
"format": "int32",
"description": "Memberships Subscriptions number of time renewed by user"
},
"number_of_admin_renewals": {
"type": "integer",
"format": "int32",
"description": "Memberships Subscriptions number of time renewed by admin"
},
"manual_transactions_ids": {
"type": "integer",
"format": "int32",
"description": "Ids of related manual transactions"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Memberships Subscriptions creation date"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Memberships Subscriptions last update date time - iso8601"
},
"payment_option_id": {
"type": "integer",
"format": "int32",
"description": "ID of payment option associated with the membership Subscription"
}
},
"required": [
"membership_type_id",
"user_id",
"payment_method_type"
],
"description": "Subscription model"
}Add a new Memberships SubscriptionPOST/api/admin/v3/memberships/subscriptions
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.
PUT /api/admin/v3/memberships/subscriptions/id/cancel
Requests
Body
{
"subscription[user_id]": 1,
"subscription[send_email]": true
}Schema
{
"type": "object",
"properties": {
"subscription[user_id]": {
"type": "number"
},
"subscription[send_email]": {
"type": "boolean"
}
},
"required": [
"subscription[user_id]"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Memberships Subscription Cancellation
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"membership_type_id": {
"type": "integer",
"format": "int32",
"description": "Associated Membership Type ID"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "Associated User ID"
},
"payment_method_type": {
"type": "string",
"description": "Memberships Subscriptions payment method"
},
"payment_method": {
"type": "string",
"description": "Memberships Subscriptions payment method (Deprecated)"
},
"expires_at": {
"type": "string",
"format": "date-time",
"description": "Memberships Subscriptions expiration date"
},
"canceled_at": {
"type": "string",
"format": "date-time",
"description": "Memberships Subscriptions cancelation date"
},
"notes": {
"type": "string",
"description": "Memberships Subscriptions notes"
},
"created_by_admin": {
"type": "boolean",
"description": "Memberships Subscriptions created by an admin ?"
},
"is_recurring": {
"type": "boolean",
"description": "Memberships Subscriptions recurring payment ?"
},
"number_of_user_renewals": {
"type": "integer",
"format": "int32",
"description": "Memberships Subscriptions number of time renewed by user"
},
"number_of_admin_renewals": {
"type": "integer",
"format": "int32",
"description": "Memberships Subscriptions number of time renewed by admin"
},
"manual_transactions_ids": {
"type": "integer",
"format": "int32",
"description": "Ids of related manual transactions"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Memberships Subscriptions creation date"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Memberships Subscriptions last update date time - iso8601"
},
"payment_option_id": {
"type": "integer",
"format": "int32",
"description": "ID of payment option associated with the membership Subscription"
}
},
"required": [
"membership_type_id",
"user_id",
"payment_method_type"
],
"description": "Subscription model"
}Memberships Subscription CancellationPUT/api/admin/v3/memberships/subscriptions/{id}/cancel
Cancel a Memberships Subscription
Required parameters are :
- User Id,
URI Parameters
- id
number(required)
GET /api/admin/v3/memberships/subscriptions/id
Responses
Memberships subscription Details
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"membership_type_id": {
"type": "integer",
"format": "int32",
"description": "Associated Membership Type ID"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "Associated User ID"
},
"payment_method_type": {
"type": "string",
"description": "Memberships Subscriptions payment method"
},
"payment_method": {
"type": "string",
"description": "Memberships Subscriptions payment method (Deprecated)"
},
"expires_at": {
"type": "string",
"format": "date-time",
"description": "Memberships Subscriptions expiration date"
},
"canceled_at": {
"type": "string",
"format": "date-time",
"description": "Memberships Subscriptions cancelation date"
},
"notes": {
"type": "string",
"description": "Memberships Subscriptions notes"
},
"created_by_admin": {
"type": "boolean",
"description": "Memberships Subscriptions created by an admin ?"
},
"is_recurring": {
"type": "boolean",
"description": "Memberships Subscriptions recurring payment ?"
},
"number_of_user_renewals": {
"type": "integer",
"format": "int32",
"description": "Memberships Subscriptions number of time renewed by user"
},
"number_of_admin_renewals": {
"type": "integer",
"format": "int32",
"description": "Memberships Subscriptions number of time renewed by admin"
},
"manual_transactions_ids": {
"type": "integer",
"format": "int32",
"description": "Ids of related manual transactions"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Memberships Subscriptions creation date"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Memberships Subscriptions last update date time - iso8601"
},
"payment_option_id": {
"type": "integer",
"format": "int32",
"description": "ID of payment option associated with the membership Subscription"
}
},
"required": [
"membership_type_id",
"user_id",
"payment_method_type"
],
"description": "Subscription model"
}Memberships subscription DetailsGET/api/admin/v3/memberships/subscriptions/{id}
Get a Memberships Subscription details
URI Parameters
- id
number(required)
PUT /api/admin/v3/memberships/subscriptions/id/renew
Requests
Body
{
"subscription[user_id]": 1,
"subscription[notes]": "Hello, world!"
}Schema
{
"type": "object",
"properties": {
"subscription[user_id]": {
"type": "number"
},
"subscription[notes]": {
"type": "string"
}
},
"required": [
"subscription[user_id]"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Memberships Subscription Renewal
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"membership_type_id": {
"type": "integer",
"format": "int32",
"description": "Associated Membership Type ID"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "Associated User ID"
},
"payment_method_type": {
"type": "string",
"description": "Memberships Subscriptions payment method"
},
"payment_method": {
"type": "string",
"description": "Memberships Subscriptions payment method (Deprecated)"
},
"expires_at": {
"type": "string",
"format": "date-time",
"description": "Memberships Subscriptions expiration date"
},
"canceled_at": {
"type": "string",
"format": "date-time",
"description": "Memberships Subscriptions cancelation date"
},
"notes": {
"type": "string",
"description": "Memberships Subscriptions notes"
},
"created_by_admin": {
"type": "boolean",
"description": "Memberships Subscriptions created by an admin ?"
},
"is_recurring": {
"type": "boolean",
"description": "Memberships Subscriptions recurring payment ?"
},
"number_of_user_renewals": {
"type": "integer",
"format": "int32",
"description": "Memberships Subscriptions number of time renewed by user"
},
"number_of_admin_renewals": {
"type": "integer",
"format": "int32",
"description": "Memberships Subscriptions number of time renewed by admin"
},
"manual_transactions_ids": {
"type": "integer",
"format": "int32",
"description": "Ids of related manual transactions"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Memberships Subscriptions creation date"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Memberships Subscriptions last update date time - iso8601"
},
"payment_option_id": {
"type": "integer",
"format": "int32",
"description": "ID of payment option associated with the membership Subscription"
}
},
"required": [
"membership_type_id",
"user_id",
"payment_method_type"
],
"description": "Subscription model"
}Memberships Subscription RenewalPUT/api/admin/v3/memberships/subscriptions/{id}/renew
Renew a Memberships Subscription
Required parameters are :
- User Id,
URI Parameters
- id
number(required)
DELETE /api/admin/v3/memberships/subscriptions/destroy
Responses
Memberships Subscription Destroy
Memberships Subscription DestroyDELETE/api/admin/v3/memberships/subscriptions/destroy
Destroy Memberships Subscription by ID
Only subscriptions added by admin are allowed
Required parameters are :
- Memberships Subscription ID,
URI Parameters
- memberships_subscription_id
number(required)
engagement_scoring ¶
Operations about engagement_scorings
GET /api/admin/v2/engagement_scoring/rankings
Responses
Get all rankings
Schema
{
"type": "object",
"properties": {
"user_id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of the User"
},
"topic_id": {
"type": "integer",
"format": "int32",
"description": "Group ID associated to a user"
},
"rank": {
"type": "integer",
"format": "int32",
"description": "Rank of the User"
},
"current_score": {
"type": "integer",
"format": "int32",
"description": "Current score of the User"
}
},
"description": "Admin_V2_EngagementScoring_RankingEntity model"
}Get all rankingsGET/api/admin/v2/engagement_scoring/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
URI Parameters
- scope
string(required)- start_date
string(required)- end_date
string(required)
GET /api/admin/v2/engagement_scoring/user_id
Responses
Get a user rank
Schema
{
"type": "object",
"properties": {
"user_id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of the User"
},
"topic_id": {
"type": "integer",
"format": "int32",
"description": "Group ID associated to a user"
},
"rank": {
"type": "integer",
"format": "int32",
"description": "Rank of the user within the specified time period"
},
"current_score": {
"type": "integer",
"format": "int32",
"description": "Cumulated score of the user"
},
"scores": {
"description": "Scores details",
"type": "object",
"properties": {
"rule_id": {
"type": "integer",
"format": "int32",
"description": "Related rule unique ID"
},
"rule_label": {
"type": "integer",
"format": "int32",
"description": "Related rule label"
},
"score": {
"type": "integer",
"format": "int32",
"description": "Cumulated score for this rule"
}
}
}
},
"description": "Admin_V2_EngagementScoring_RankEntity model"
}Get a user rankGET/api/admin/v2/engagement_scoring/{user_id}
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.
URI Parameters
- user_id
number(required)- topic_id
string(required)- start_date
string(required)- end_date
string(required)
payment_accounts ¶
Operations about payment_accounts
GET /api/admin/v2/payment_accounts
Responses
List of Payment Accounts
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of the Payment Account"
},
"name": {
"type": "string",
"description": "Name of the Payment Account"
},
"account_type": {
"type": "string",
"description": "Kind of payment account"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Category creation date time - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Category last update date time - iso8601"
},
"available_for_all_groups": {
"type": "boolean",
"description": "True/False is the payment account available for all groups"
},
"groups": {
"description": "Groups that the payment account can be used in",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of the Group"
},
"name": {
"type": "string",
"description": "Name of the Group"
}
}
}
},
"description": "PaymentAccountEntity model"
}List of Payment AccountsGET/api/admin/v2/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"
}GET /api/admin/v2/payment_accounts/id
Responses
Detail of a Payment Account
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of the Payment Account"
},
"name": {
"type": "string",
"description": "Name of the Payment Account"
},
"account_type": {
"type": "string",
"description": "Kind of payment account"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Category creation date time - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Category last update date time - iso8601"
},
"available_for_all_groups": {
"type": "boolean",
"description": "True/False is the payment account available for all groups"
},
"groups": {
"description": "Groups that the payment account can be used in",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of the Group"
},
"name": {
"type": "string",
"description": "Name of the Group"
}
}
}
},
"description": "PaymentAccountEntity model"
}categories ¶
Operations about categories
GET /api/admin/v2/categories?categorized_types=
Responses
List of Categories
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of the Category"
},
"name": {
"type": "string",
"description": "Name of the Category"
},
"categorized_type": {
"type": "string",
"enum": [
"emailing",
"news",
"events",
"donations_campaign",
"donations_fund",
"media_center_file",
"portfolio",
"discussion",
"journey"
],
"description": "Type of items Categorized"
},
"available_for_network": {
"type": "boolean",
"description": "Category available at the network level"
},
"available_for_all_topics": {
"type": "boolean",
"description": "Category available for all groups"
},
"topic_ids": {
"type": "integer",
"format": "int32",
"description": "Linked group ids to the category"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Category creation date time - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Category last update date time - iso8601"
}
},
"description": "CategoryEntity model"
}List of CategoriesGET/api/admin/v2/categories{?categorized_types}
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"
}URI Parameters
- categorized_types
string(required)
POST /api/admin/v2/categories
Requests
Body
{
"category[name]": "Hello, world!",
"category[categorized_type]": "Hello, world!",
"category[available_for_network]": true,
"category[available_for_all_topics]": true,
"category[topic_ids][]": [
1
]
}Schema
{
"type": "object",
"properties": {
"category[name]": {
"type": "string",
"description": "Name of the Category"
},
"category[categorized_type]": {
"type": "string",
"description": "Type of items Categorized"
},
"category[available_for_network]": {
"type": "boolean",
"description": "Category available at the network level"
},
"category[available_for_all_topics]": {
"type": "boolean",
"description": "Category available for all groups"
},
"category[topic_ids][]": {
"type": "array",
"items": {
"type": "number"
},
"description": "Linked group ids to the category"
}
},
"required": [
"category[name]",
"category[categorized_type]"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Create a Category
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of the Category"
},
"name": {
"type": "string",
"description": "Name of the Category"
},
"categorized_type": {
"type": "string",
"enum": [
"emailing",
"news",
"events",
"donations_campaign",
"donations_fund",
"media_center_file",
"portfolio",
"discussion",
"journey"
],
"description": "Type of items Categorized"
},
"available_for_network": {
"type": "boolean",
"description": "Category available at the network level"
},
"available_for_all_topics": {
"type": "boolean",
"description": "Category available for all groups"
},
"topic_ids": {
"type": "integer",
"format": "int32",
"description": "Linked group ids to the category"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Category creation date time - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Category last update date time - iso8601"
}
},
"description": "CategoryEntity model"
}Create a CategoryPOST/api/admin/v2/categories
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],
}
}GET /api/admin/v2/categories/id
Responses
Get a Category information
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of the Category"
},
"name": {
"type": "string",
"description": "Name of the Category"
},
"categorized_type": {
"type": "string",
"enum": [
"emailing",
"news",
"events",
"donations_campaign",
"donations_fund",
"media_center_file",
"portfolio",
"discussion",
"journey"
],
"description": "Type of items Categorized"
},
"available_for_network": {
"type": "boolean",
"description": "Category available at the network level"
},
"available_for_all_topics": {
"type": "boolean",
"description": "Category available for all groups"
},
"topic_ids": {
"type": "integer",
"format": "int32",
"description": "Linked group ids to the category"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Category creation date time - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Category last update date time - iso8601"
}
},
"description": "CategoryEntity model"
}DELETE /api/admin/v2/categories/id
Responses
Delete a Category
PUT /api/admin/v2/categories/id
Requests
Body
{
"category[name]": "Hello, world!",
"category[available_for_network]": true,
"category[available_for_all_topics]": true,
"category[topic_ids][]": [
1
]
}Schema
{
"type": "object",
"properties": {
"category[name]": {
"type": "string",
"description": "Name of the Category"
},
"category[available_for_network]": {
"type": "boolean",
"description": "Category available at the network level"
},
"category[available_for_all_topics]": {
"type": "boolean",
"description": "Category available for all groups"
},
"category[topic_ids][]": {
"type": "array",
"items": {
"type": "number"
},
"description": "Linked group ids to the category"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Update an existing Category
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of the Category"
},
"name": {
"type": "string",
"description": "Name of the Category"
},
"categorized_type": {
"type": "string",
"enum": [
"emailing",
"news",
"events",
"donations_campaign",
"donations_fund",
"media_center_file",
"portfolio",
"discussion",
"journey"
],
"description": "Type of items Categorized"
},
"available_for_network": {
"type": "boolean",
"description": "Category available at the network level"
},
"available_for_all_topics": {
"type": "boolean",
"description": "Category available for all groups"
},
"topic_ids": {
"type": "integer",
"format": "int32",
"description": "Linked group ids to the category"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Category creation date time - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Category last update date time - iso8601"
}
},
"description": "CategoryEntity model"
}Update an existing CategoryPUT/api/admin/v2/categories/{id}
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],
}
}URI Parameters
- id
number(required)ID of the Category
current_locations ¶
Operations about current_locations
GET /api/admin/v2/current_locations
Responses
Get all user check-in/current locations
Schema
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID"
},
"user_id": {
"type": "string",
"description": "User ID attached to the current location check-in"
},
"location_type": {
"type": "string",
"description": "Check-in location type"
},
"address": {
"type": "string",
"description": "Check-in address"
},
"city": {
"type": "string",
"description": "Check-in city"
},
"country": {
"type": "string",
"description": "Check-in country"
},
"country_code": {
"type": "string",
"description": "Check-in country code"
},
"administrative_area_level_1": {
"type": "string",
"description": "Check-in region"
},
"administrative_area_level_2": {
"type": "string",
"description": "Check-in department"
},
"timezone": {
"type": "string",
"description": "Check-in timezone"
},
"content": {
"type": "string",
"description": "Check-in content"
},
"feedable_at": {
"type": "string",
"format": "date-time",
"description": "Check-in published time on the LiveFeed"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Check-in creation date"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Check-in last update date time - iso8601"
}
},
"description": "Admin_V2_Users_CurrentLocationEntity model"
}Get all user check-in/current locationsGET/api/admin/v2/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 orcreated_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"
}URI Parameters
- page
string(required)Page of results to fetch.
- per_page
string(required)Number of results to return per page.
- created_since
string(required)- updated_since
string(required)- order
string(required)
GET /api/admin/v2/current_locations/id
Responses
Get user check-in/current location
Schema
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID"
},
"user_id": {
"type": "string",
"description": "User ID attached to the current location check-in"
},
"location_type": {
"type": "string",
"description": "Check-in location type"
},
"address": {
"type": "string",
"description": "Check-in address"
},
"city": {
"type": "string",
"description": "Check-in city"
},
"country": {
"type": "string",
"description": "Check-in country"
},
"country_code": {
"type": "string",
"description": "Check-in country code"
},
"administrative_area_level_1": {
"type": "string",
"description": "Check-in region"
},
"administrative_area_level_2": {
"type": "string",
"description": "Check-in department"
},
"timezone": {
"type": "string",
"description": "Check-in timezone"
},
"content": {
"type": "string",
"description": "Check-in content"
},
"feedable_at": {
"type": "string",
"format": "date-time",
"description": "Check-in published time on the LiveFeed"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Check-in creation date"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Check-in last update date time - iso8601"
}
},
"description": "Admin_V2_Users_CurrentLocationEntity model"
}Get user check-in/current locationGET/api/admin/v2/current_locations/{id}
Return the user check-in/current location
Find the user current location matching the current location ID
URI Parameters
- id
number(required)
media_center ¶
Operations about media_centers
PUT /api/admin/v2/media_center/files/id
Requests
Body
{
"file[name]": "Hello, world!",
"file[description]": "Hello, world!",
"file[network_category_ids][]": [
1
],
"file[external_url]": "Hello, world!",
"file[is_downloadable]": true,
"file[downloads_count]": 1,
"file[views_count]": 1
}Schema
{
"type": "object",
"properties": {
"file[name]": {
"type": "string",
"description": "Name of the file"
},
"file[description]": {
"type": "string",
"description": "File description"
},
"file[network_category_ids][]": {
"type": "array",
"items": {
"type": "number"
},
"description": "IDs list of the file categories"
},
"file[external_url]": {
"type": "string",
"description": "external link URL"
},
"file[is_downloadable]": {
"type": "boolean",
"description": "True/False is the file download button enabled?"
},
"file[downloads_count]": {
"type": "number",
"description": "File downloads count"
},
"file[views_count]": {
"type": "number",
"description": "File view count"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Update a file
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of this file"
},
"uuid": {
"type": "string",
"description": "Universal Unique ID"
},
"name": {
"type": "string",
"description": "Name of the file"
},
"description": {
"type": "string",
"description": "File description"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Creation date time - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Updated at date time - iso8601"
},
"deleted_at": {
"type": "string",
"format": "date-time",
"description": "Deletion request time - iso8601"
},
"folder_id": {
"type": "integer",
"format": "int32",
"description": "ID of the parent folder"
},
"network_category_ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": "IDs list of the file categories"
},
"content_type": {
"type": "string",
"description": "File Content Type"
},
"url": {
"type": "string",
"description": "Uploaded file URL"
},
"external_link": {
"type": "boolean",
"description": "True/False is the file an external link?"
},
"external_url": {
"type": "string",
"description": "external link URL"
},
"is_downloadable": {
"type": "boolean",
"description": "True/False is the file download button enabled?"
},
"pinned_on_index_page": {
"type": "boolean",
"description": "True/False is the file pinned?"
},
"popularity_score": {
"type": "integer",
"format": "int32",
"description": "Popularity Score"
},
"comments_count": {
"type": "integer",
"format": "int32",
"description": "File comment count"
},
"likes_count": {
"type": "integer",
"format": "int32",
"description": "File like count"
},
"downloads_count": {
"type": "integer",
"format": "int32",
"description": "File downloads count"
},
"views_count": {
"type": "integer",
"format": "int32",
"description": "File view count"
},
"owner": {
"description": "Owner Information",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "ID of item owner"
},
"name": {
"type": "string",
"description": "Owner name of this item"
},
"type": {
"type": "string",
"description": "Owner Type of this item"
}
}
}
},
"description": "Admin_V2_MediaCenter_FilesFullEntity model"
}Update a filePUT/api/admin/v2/media_center/files/{id}
Updates a file with the provided information
thumbnail_image must be sent as a file (URL to files won’t work)
URI Parameters
- id
number(required)
DELETE /api/admin/v2/media_center/files/id
Responses
Remove a File
Remove a FileDELETE/api/admin/v2/media_center/files/{id}
Delete a File
URI Parameters
- id
number(required)
GET /api/admin/v2/media_center/files/id
Responses
File Details
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of this file"
},
"uuid": {
"type": "string",
"description": "Universal Unique ID"
},
"name": {
"type": "string",
"description": "Name of the file"
},
"description": {
"type": "string",
"description": "File description"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Creation date time - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Updated at date time - iso8601"
},
"deleted_at": {
"type": "string",
"format": "date-time",
"description": "Deletion request time - iso8601"
},
"folder_id": {
"type": "integer",
"format": "int32",
"description": "ID of the parent folder"
},
"network_category_ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": "IDs list of the file categories"
},
"content_type": {
"type": "string",
"description": "File Content Type"
},
"url": {
"type": "string",
"description": "Uploaded file URL"
},
"external_link": {
"type": "boolean",
"description": "True/False is the file an external link?"
},
"external_url": {
"type": "string",
"description": "external link URL"
},
"is_downloadable": {
"type": "boolean",
"description": "True/False is the file download button enabled?"
},
"pinned_on_index_page": {
"type": "boolean",
"description": "True/False is the file pinned?"
},
"popularity_score": {
"type": "integer",
"format": "int32",
"description": "Popularity Score"
},
"comments_count": {
"type": "integer",
"format": "int32",
"description": "File comment count"
},
"likes_count": {
"type": "integer",
"format": "int32",
"description": "File like count"
},
"downloads_count": {
"type": "integer",
"format": "int32",
"description": "File downloads count"
},
"views_count": {
"type": "integer",
"format": "int32",
"description": "File view count"
},
"owner": {
"description": "Owner Information",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "ID of item owner"
},
"name": {
"type": "string",
"description": "Owner name of this item"
},
"type": {
"type": "string",
"description": "Owner Type of this item"
}
}
}
},
"description": "Admin_V2_MediaCenter_FilesFullEntity model"
}File DetailsGET/api/admin/v2/media_center/files/{id}
Get a file’s information
URI Parameters
- id
number(required)
POST /api/admin/v2/media_center/files/create
Requests
Body
{
"file[name]": "Hello, world!",
"file[folder_id]": 1,
"file[attachment]": "Hello, world!",
"file[description]": "Hello, world!",
"file[network_category_ids][]": [
1
],
"file[external_url]": "Hello, world!",
"file[is_downloadable]": true,
"file[thumbnail_image]": "Hello, world!"
}Schema
{
"type": "object",
"properties": {
"file[name]": {
"type": "string",
"description": "Name of the file"
},
"file[folder_id]": {
"type": "number",
"description": "ID of the parent folder"
},
"file[attachment]": {
"type": "string",
"description": "Primary attachment of the item"
},
"file[description]": {
"type": "string",
"description": "File description"
},
"file[network_category_ids][]": {
"type": "array",
"items": {
"type": "number"
},
"description": "IDs list of the file categories"
},
"file[external_url]": {
"type": "string",
"description": "external link URL"
},
"file[is_downloadable]": {
"type": "boolean",
"description": "True/False is the file download button enabled?"
},
"file[thumbnail_image]": {
"type": "string",
"description": "Image file for item thumbnail"
}
},
"required": [
"file[name]",
"file[folder_id]"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Create a File
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of this file"
},
"uuid": {
"type": "string",
"description": "Universal Unique ID"
},
"name": {
"type": "string",
"description": "Name of the file"
},
"description": {
"type": "string",
"description": "File description"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Creation date time - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Updated at date time - iso8601"
},
"deleted_at": {
"type": "string",
"format": "date-time",
"description": "Deletion request time - iso8601"
},
"folder_id": {
"type": "integer",
"format": "int32",
"description": "ID of the parent folder"
},
"network_category_ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": "IDs list of the file categories"
},
"content_type": {
"type": "string",
"description": "File Content Type"
},
"url": {
"type": "string",
"description": "Uploaded file URL"
},
"external_link": {
"type": "boolean",
"description": "True/False is the file an external link?"
},
"external_url": {
"type": "string",
"description": "external link URL"
},
"is_downloadable": {
"type": "boolean",
"description": "True/False is the file download button enabled?"
},
"pinned_on_index_page": {
"type": "boolean",
"description": "True/False is the file pinned?"
},
"popularity_score": {
"type": "integer",
"format": "int32",
"description": "Popularity Score"
},
"comments_count": {
"type": "integer",
"format": "int32",
"description": "File comment count"
},
"likes_count": {
"type": "integer",
"format": "int32",
"description": "File like count"
},
"downloads_count": {
"type": "integer",
"format": "int32",
"description": "File downloads count"
},
"views_count": {
"type": "integer",
"format": "int32",
"description": "File view count"
},
"owner": {
"description": "Owner Information",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "ID of item owner"
},
"name": {
"type": "string",
"description": "Owner name of this item"
},
"type": {
"type": "string",
"description": "Owner Type of this item"
}
}
}
},
"description": "Admin_V2_MediaCenter_FilesFullEntity model"
}Create a FilePOST/api/admin/v2/media_center/files/create
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
POST /api/admin/v2/media_center/files/id/move
Requests
Body
{
"folder_id": 1
}Schema
{
"type": "object",
"properties": {
"folder_id": {
"type": "number"
}
},
"required": [
"folder_id"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Move a File to a new location
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of this file"
},
"uuid": {
"type": "string",
"description": "Universal Unique ID"
},
"name": {
"type": "string",
"description": "Name of the file"
},
"description": {
"type": "string",
"description": "File description"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Creation date time - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Updated at date time - iso8601"
},
"deleted_at": {
"type": "string",
"format": "date-time",
"description": "Deletion request time - iso8601"
},
"folder_id": {
"type": "integer",
"format": "int32",
"description": "ID of the parent folder"
},
"network_category_ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": "IDs list of the file categories"
},
"content_type": {
"type": "string",
"description": "File Content Type"
},
"url": {
"type": "string",
"description": "Uploaded file URL"
},
"external_link": {
"type": "boolean",
"description": "True/False is the file an external link?"
},
"external_url": {
"type": "string",
"description": "external link URL"
},
"is_downloadable": {
"type": "boolean",
"description": "True/False is the file download button enabled?"
},
"pinned_on_index_page": {
"type": "boolean",
"description": "True/False is the file pinned?"
},
"popularity_score": {
"type": "integer",
"format": "int32",
"description": "Popularity Score"
},
"comments_count": {
"type": "integer",
"format": "int32",
"description": "File comment count"
},
"likes_count": {
"type": "integer",
"format": "int32",
"description": "File like count"
},
"downloads_count": {
"type": "integer",
"format": "int32",
"description": "File downloads count"
},
"views_count": {
"type": "integer",
"format": "int32",
"description": "File view count"
},
"owner": {
"description": "Owner Information",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "ID of item owner"
},
"name": {
"type": "string",
"description": "Owner name of this item"
},
"type": {
"type": "string",
"description": "Owner Type of this item"
}
}
}
},
"description": "Admin_V2_MediaCenter_FilesFullEntity model"
}Move a File to a new locationPOST/api/admin/v2/media_center/files/{id}/move
Moves a file inside the folder with the provided ID
URI Parameters
- id
number(required)
GET /api/admin/v2/media_center/files/id/download
Responses
File Download URL
Schema
{
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "Uploaded file URL"
}
},
"description": "Admin_V2_MediaCenter_FileDownloadEntity model"
}File Download URLGET/api/admin/v2/media_center/files/{id}/download
Get a file’s download URL
URI Parameters
- id
number(required)
GET /api/admin/v2/media_center/files
Responses
Get a list of files
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of this file"
},
"uuid": {
"type": "string",
"description": "Universal Unique ID"
},
"name": {
"type": "string",
"description": "Name of the file"
},
"description": {
"type": "string",
"description": "File description"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Creation date time - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Updated at date time - iso8601"
},
"deleted_at": {
"type": "string",
"format": "date-time",
"description": "Deletion request time - iso8601"
},
"folder_id": {
"type": "integer",
"format": "int32",
"description": "ID of the parent folder"
},
"network_category_ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": "IDs list of the file categories"
},
"content_type": {
"type": "string",
"description": "File Content Type"
},
"url": {
"type": "string",
"description": "Uploaded file URL"
},
"external_link": {
"type": "boolean",
"description": "True/False is the file an external link?"
},
"external_url": {
"type": "string",
"description": "external link URL"
},
"is_downloadable": {
"type": "boolean",
"description": "True/False is the file download button enabled?"
},
"pinned_on_index_page": {
"type": "boolean",
"description": "True/False is the file pinned?"
},
"popularity_score": {
"type": "integer",
"format": "int32",
"description": "Popularity Score"
},
"comments_count": {
"type": "integer",
"format": "int32",
"description": "File comment count"
},
"likes_count": {
"type": "integer",
"format": "int32",
"description": "File like count"
},
"downloads_count": {
"type": "integer",
"format": "int32",
"description": "File downloads count"
},
"views_count": {
"type": "integer",
"format": "int32",
"description": "File view count"
},
"owner": {
"description": "Owner Information",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "ID of item owner"
},
"name": {
"type": "string",
"description": "Owner name of this item"
},
"type": {
"type": "string",
"description": "Owner Type of this item"
}
}
}
},
"description": "Admin_V2_MediaCenter_FilesFullEntity model"
}Get a list of filesGET/api/admin/v2/media_center/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"
}URI Parameters
- page
string(required)Page of results to fetch.
- per_page
string(required)Number of results to return per page.
- linked_to
string(required)- linked_to_id
number(required)
PUT /api/admin/v2/media_center/folders/id
Requests
Body
{
"folder[name]": "Hello, world!",
"folder[description]": "Hello, world!",
"folder[cover_picture]": "Hello, world!"
}Schema
{
"type": "object",
"properties": {
"folder[name]": {
"type": "string"
},
"folder[description]": {
"type": "string"
},
"folder[cover_picture]": {
"type": "string"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Update a Folder
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of this Folder"
},
"uuid": {
"type": "string",
"description": "Universal Unique ID"
},
"parent_id": {
"type": "integer",
"format": "int32",
"description": "ID of the parent folder"
},
"name": {
"type": "string",
"description": "Folder name"
},
"description": {
"type": "string",
"description": "Folder description"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Creation date time - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Last update time - iso8601"
},
"deleted_at": {
"type": "string",
"format": "date-time",
"description": "Deletion request time - iso8601"
},
"child_files_count": {
"type": "integer",
"format": "int32",
"description": "Number of child files"
},
"files": {
"description": "Basic info on child files",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of this file"
},
"name": {
"type": "string",
"description": "Name of the file"
}
}
},
"child_folders_count": {
"type": "integer",
"format": "int32",
"description": "Number of child folders"
},
"folders": {
"description": "Basic info on child folders",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of this folder"
},
"name": {
"type": "string",
"description": "Name of the folder"
}
}
},
"cover_picture": {
"type": "string",
"description": "URL of cover picture"
},
"owner": {
"description": "Owner Information",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "ID of item owner"
},
"name": {
"type": "string",
"description": "Owner name of this item"
},
"type": {
"type": "string",
"description": "Owner Type of this item"
}
}
}
},
"description": "Admin_V2_MediaCenter_FolderEntity model"
}Update a FolderPUT/api/admin/v2/media_center/folders/{id}
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
URI Parameters
- id
number(required)
GET /api/admin/v2/media_center/folders/id
Responses
Folder Details
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of this Folder"
},
"uuid": {
"type": "string",
"description": "Universal Unique ID"
},
"parent_id": {
"type": "integer",
"format": "int32",
"description": "ID of the parent folder"
},
"name": {
"type": "string",
"description": "Folder name"
},
"description": {
"type": "string",
"description": "Folder description"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Creation date time - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Last update time - iso8601"
},
"deleted_at": {
"type": "string",
"format": "date-time",
"description": "Deletion request time - iso8601"
},
"child_files_count": {
"type": "integer",
"format": "int32",
"description": "Number of child files"
},
"files": {
"description": "Basic info on child files",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of this file"
},
"name": {
"type": "string",
"description": "Name of the file"
}
}
},
"child_folders_count": {
"type": "integer",
"format": "int32",
"description": "Number of child folders"
},
"folders": {
"description": "Basic info on child folders",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of this folder"
},
"name": {
"type": "string",
"description": "Name of the folder"
}
}
},
"cover_picture": {
"type": "string",
"description": "URL of cover picture"
},
"owner": {
"description": "Owner Information",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "ID of item owner"
},
"name": {
"type": "string",
"description": "Owner name of this item"
},
"type": {
"type": "string",
"description": "Owner Type of this item"
}
}
}
},
"description": "Admin_V2_MediaCenter_FolderEntity model"
}Folder DetailsGET/api/admin/v2/media_center/folders/{id}
Get a folder
Additional information on files in this folder can be retrieved on /api/admin/v2/media_center/{folder_id}/files
URI Parameters
- id
number(required)
DELETE /api/admin/v2/media_center/folders/id
Responses
Remove a Folder
Remove a FolderDELETE/api/admin/v2/media_center/folders/{id}
Delete a folder and it’s contents
URI Parameters
- id
number(required)
POST /api/admin/v2/media_center/folders/create
Requests
Body
{
"folder[name]": "Hello, world!",
"folder[parent_id]": 1,
"folder[description]": "Hello, world!",
"folder[cover_picture]": "Hello, world!"
}Schema
{
"type": "object",
"properties": {
"folder[name]": {
"type": "string"
},
"folder[parent_id]": {
"type": "number"
},
"folder[description]": {
"type": "string"
},
"folder[cover_picture]": {
"type": "string"
}
},
"required": [
"folder[name]",
"folder[parent_id]"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Create a Folder
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of this Folder"
},
"uuid": {
"type": "string",
"description": "Universal Unique ID"
},
"parent_id": {
"type": "integer",
"format": "int32",
"description": "ID of the parent folder"
},
"name": {
"type": "string",
"description": "Folder name"
},
"description": {
"type": "string",
"description": "Folder description"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Creation date time - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Last update time - iso8601"
},
"deleted_at": {
"type": "string",
"format": "date-time",
"description": "Deletion request time - iso8601"
},
"child_files_count": {
"type": "integer",
"format": "int32",
"description": "Number of child files"
},
"files": {
"description": "Basic info on child files",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of this file"
},
"name": {
"type": "string",
"description": "Name of the file"
}
}
},
"child_folders_count": {
"type": "integer",
"format": "int32",
"description": "Number of child folders"
},
"folders": {
"description": "Basic info on child folders",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of this folder"
},
"name": {
"type": "string",
"description": "Name of the folder"
}
}
},
"cover_picture": {
"type": "string",
"description": "URL of cover picture"
},
"owner": {
"description": "Owner Information",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "ID of item owner"
},
"name": {
"type": "string",
"description": "Owner name of this item"
},
"type": {
"type": "string",
"description": "Owner Type of this item"
}
}
}
},
"description": "Admin_V2_MediaCenter_FolderEntity model"
}Create a FolderPOST/api/admin/v2/media_center/folders/create
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
GET /api/admin/v2/media_center/folders/id/files
Responses
Get a list of files in a folder
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of this file"
},
"uuid": {
"type": "string",
"description": "Universal Unique ID"
},
"name": {
"type": "string",
"description": "Name of the file"
},
"description": {
"type": "string",
"description": "File description"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Creation date time - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Updated at date time - iso8601"
},
"deleted_at": {
"type": "string",
"format": "date-time",
"description": "Deletion request time - iso8601"
},
"folder_id": {
"type": "integer",
"format": "int32",
"description": "ID of the parent folder"
},
"network_category_ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": "IDs list of the file categories"
},
"content_type": {
"type": "string",
"description": "File Content Type"
},
"url": {
"type": "string",
"description": "Uploaded file URL"
},
"external_link": {
"type": "boolean",
"description": "True/False is the file an external link?"
},
"external_url": {
"type": "string",
"description": "external link URL"
},
"is_downloadable": {
"type": "boolean",
"description": "True/False is the file download button enabled?"
},
"pinned_on_index_page": {
"type": "boolean",
"description": "True/False is the file pinned?"
},
"popularity_score": {
"type": "integer",
"format": "int32",
"description": "Popularity Score"
},
"comments_count": {
"type": "integer",
"format": "int32",
"description": "File comment count"
},
"likes_count": {
"type": "integer",
"format": "int32",
"description": "File like count"
},
"downloads_count": {
"type": "integer",
"format": "int32",
"description": "File downloads count"
},
"views_count": {
"type": "integer",
"format": "int32",
"description": "File view count"
},
"owner": {
"description": "Owner Information",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "ID of item owner"
},
"name": {
"type": "string",
"description": "Owner name of this item"
},
"type": {
"type": "string",
"description": "Owner Type of this item"
}
}
}
},
"description": "Admin_V2_MediaCenter_FilesFullEntity model"
}Get a list of files in a folderGET/api/admin/v2/media_center/folders/{id}/files
Get a paginated list of files in the given folder
Example:
{
"x-per-page": "30",
"x-total": "10201",
"x-page": "4"
}URI Parameters
- id
number(required)- page
string(required)Page of results to fetch.
- per_page
string(required)Number of results to return per page.
POST /api/admin/v2/media_center/folders/id/move
Requests
Body
{
"parent_id": 1
}Schema
{
"type": "object",
"properties": {
"parent_id": {
"type": "number"
}
},
"required": [
"parent_id"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Move a Folder to a new location
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of this Folder"
},
"uuid": {
"type": "string",
"description": "Universal Unique ID"
},
"parent_id": {
"type": "integer",
"format": "int32",
"description": "ID of the parent folder"
},
"name": {
"type": "string",
"description": "Folder name"
},
"description": {
"type": "string",
"description": "Folder description"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Creation date time - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Last update time - iso8601"
},
"deleted_at": {
"type": "string",
"format": "date-time",
"description": "Deletion request time - iso8601"
},
"child_files_count": {
"type": "integer",
"format": "int32",
"description": "Number of child files"
},
"files": {
"description": "Basic info on child files",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of this file"
},
"name": {
"type": "string",
"description": "Name of the file"
}
}
},
"child_folders_count": {
"type": "integer",
"format": "int32",
"description": "Number of child folders"
},
"folders": {
"description": "Basic info on child folders",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of this folder"
},
"name": {
"type": "string",
"description": "Name of the folder"
}
}
},
"cover_picture": {
"type": "string",
"description": "URL of cover picture"
},
"owner": {
"description": "Owner Information",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "ID of item owner"
},
"name": {
"type": "string",
"description": "Owner name of this item"
},
"type": {
"type": "string",
"description": "Owner Type of this item"
}
}
}
},
"description": "Admin_V2_MediaCenter_FolderEntity model"
}Move a Folder to a new locationPOST/api/admin/v2/media_center/folders/{id}/move
Moves a child folder inside the folder with the provided parent_id
URI Parameters
- id
number(required)
GET /api/admin/v2/media_center/folders
Responses
Root Folder
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of this Folder"
},
"uuid": {
"type": "string",
"description": "Universal Unique ID"
},
"parent_id": {
"type": "integer",
"format": "int32",
"description": "ID of the parent folder"
},
"name": {
"type": "string",
"description": "Folder name"
},
"description": {
"type": "string",
"description": "Folder description"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Creation date time - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Last update time - iso8601"
},
"deleted_at": {
"type": "string",
"format": "date-time",
"description": "Deletion request time - iso8601"
},
"child_files_count": {
"type": "integer",
"format": "int32",
"description": "Number of child files"
},
"files": {
"description": "Basic info on child files",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of this file"
},
"name": {
"type": "string",
"description": "Name of the file"
}
}
},
"child_folders_count": {
"type": "integer",
"format": "int32",
"description": "Number of child folders"
},
"folders": {
"description": "Basic info on child folders",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID of this folder"
},
"name": {
"type": "string",
"description": "Name of the folder"
}
}
},
"cover_picture": {
"type": "string",
"description": "URL of cover picture"
},
"owner": {
"description": "Owner Information",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "ID of item owner"
},
"name": {
"type": "string",
"description": "Owner name of this item"
},
"type": {
"type": "string",
"description": "Owner Type of this item"
}
}
}
},
"description": "Admin_V2_MediaCenter_FolderEntity model"
}Root FolderGET/api/admin/v2/media_center/folders
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
URI Parameters
- linked_to
string(required)- linked_to_id
number(required)
audit_logs ¶
Operations about audit_logs
GET /api/admin/v3/audit_logs/logs
Responses
List of Audit logs
Schema
{
"type": "object",
"properties": {
"thread_id": {
"type": "string",
"description": "Thread ID for this event"
},
"group_id": {
"type": "string",
"description": "Group ID for this event"
},
"user_id": {
"type": "string",
"description": "User ID for this event"
},
"user_type": {
"type": "string",
"description": "User type for this event"
},
"user_email": {
"type": "string",
"description": "User email for this event"
},
"user_external_id": {
"type": "string",
"description": "User External ID for this event"
},
"impersonator_id": {
"type": "string",
"description": "Impersonator ID for this event"
},
"impersonator_type": {
"type": "string",
"description": "Impersonator type for this event"
},
"entity_id": {
"type": "string",
"description": "Entity ID for this event"
},
"entity_type": {
"type": "string",
"description": "Entity type for this event"
},
"event_type": {
"type": "string",
"description": "Event type for this event"
},
"audience": {
"type": "string",
"description": "Audience for this event"
},
"action": {
"type": "string",
"description": "Action for this event"
},
"event_origin": {
"type": "string",
"description": "Event origin for this event"
},
"created_at": {
"type": "string",
"description": "Created at for this event"
},
"content": {
"description": "Content for this audit log event. E.g. parameters used, entity_changes depending on the event type.",
"type": "object",
"properties": {
"text": {
"type": "string",
"description": "(deprecated) Text field for this event, can be JSON or TEXT depending on the event type"
},
"json": {
"type": "string",
"description": "(deprecated) JSON field for this event, can be JSON or TEXT depending on the event type (this is a json object)"
},
"parameters": {
"type": "string",
"description": "JSON object with the parameters used when this audit log was generated"
},
"entity_changes": {
"type": "string",
"description": "Entity changes for this event (this is a json object)"
},
"entity": {
"type": "string",
"description": "Entity for this event (this is a json object)"
}
}
}
},
"description": "Admin_V3_AuditLog_IndexEntity model"
}List of Audit logsGET/api/admin/v3/audit_logs/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": "",
"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": "",
"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/2023Show me all the audit logs where user 1 searched in the people directory.
api/admin/v3/audit_logs/logs?actions=search_people_directory&user=1Show 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/2023URI Parameters
- group_ids - search by group ids. Use comma separated values if more than one value is provided. Example: group_ids=1,2,3
string(required)- group_id_is_null - search where group_id is null. Accepts true or false. Example
string(required) Example: group_id_is_null=true- user_types - search by user types. Use comma separated values if more than one value is provided. Example: user_type=user
string(required)- user_ids - search by user ids. Use comma separated values if more than one value is provided. Example: user_ids=1,2,3
string(required)- user_emails - search by user emails. Use comma separators for multiple values. Example: [email protected],[email protected],[email protected]
string(required)- user_external_ids
string(required)search by user external ids. Use comma separators for multiple values. Example: user_external_ids=ext-1,ext-2,ext-3
- entity_types - search by entity types. Use comma separated values if more than one value is provided. Example: entity_types=posts/feed_post
string(required)- entity_ids - search by entity ids. Use comma separated values if more than one value is provided. Example: group_ids=1,2,3
string(required)- event_origins - search by event origins. Use comma separated values if more than one value is provided. Example: event_origins=frontoffice
string(required)- event_types - search by event types. Use comma separated values if more than one value is provided. Example: event_types=standard
string(required)- audiences
string(required)search by audiences. Use comma separated values if more than one value is provided. Example: audiences=full_network
- actions
string(required)search by actions. Use comma separated values if more than one value is provided. Example: actions=create,update,delete
- parent_ids
string(required)search by parent ids (use comma separated values)
- parent_types
string(required)search by parent types (use comma separated values)
- parent_type_is_null - search where parent_type is null. Accepts true or false. Example
string(required) Example: parent_type_is_null=true- parent_id_is_null - search where parent_id is null. Accepts true or false. Example
string(required) Example: parent_id_is_null=true- impersonator_ids
string(required)search by impersonator ids (use comma separated values)
- impersonator_types
string(required)search by impersonator types (use comma separated values)
- page
string(required)Page of results to fetch.
- per_page
string(required)Number of results to return per page.
admins ¶
Operations about admins
PUT /api/admin/v3/admins/id
Requests
Body
{
"admin[name]": "Hello, world!",
"admin[email]": "Hello, world!",
"admin[sso_identifier]": "Hello, world!",
"admin[user_id]": 1
}Schema
{
"type": "object",
"properties": {
"admin[name]": {
"type": "string",
"description": "Name of the admin"
},
"admin[email]": {
"type": "string",
"description": "Admin email"
},
"admin[sso_identifier]": {
"type": "string",
"description": "SSO ID of the Admin account"
},
"admin[user_id]": {
"type": "number",
"description": "ID of the user to link to the admin account"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Update an Admin account by ID
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"email": {
"type": "string",
"description": "Admin email"
},
"name": {
"type": "string",
"description": "Admin full name"
},
"admin_type": {
"type": "string",
"enum": [
"global",
"group"
],
"description": "Admin type"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Admin creation date"
}
},
"description": "Admin model"
}Update an Admin account by IDPUT/api/admin/v3/admins/{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
URI Parameters
- id
number(required)ID of the admin to update
GET /api/admin/v3/admins/id
Responses
Show an Admin account by ID
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"email": {
"type": "string",
"description": "Admin email"
},
"name": {
"type": "string",
"description": "Admin full name"
},
"admin_type": {
"type": "string",
"enum": [
"global",
"group"
],
"description": "Admin type"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Admin creation date"
}
},
"description": "Admin model"
}DELETE /api/admin/v3/admins/id/delete
Responses
Delete an Admin account by ID
Unprocessable entity
Schema
{
"type": "object",
"properties": {
"status": {
"type": "integer",
"format": "int32",
"description": "Status Code"
},
"errors": {
"type": "string",
"description": "Errors list"
}
},
"description": "Error model"
}Delete an Admin account by IDDELETE/api/admin/v3/admins/{id}/delete
URI Parameters
- id
number(required)ID of the admin to be deleted
GET /api/admin/v3/admins
Responses
List of Admin accounts
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"email": {
"type": "string",
"description": "Admin email"
},
"name": {
"type": "string",
"description": "Admin full name"
},
"admin_type": {
"type": "string",
"enum": [
"global",
"group"
],
"description": "Admin type"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Admin creation date"
}
},
"description": "Admin model"
}List of Admin accountsGET/api/admin/v3/admins
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.
URI Parameters
- type
string(required)Admin access level
- managed_topic_id
string(required)Group/Topic ID that the Admins have access
- page
string(required)Page of results to fetch.
- per_page
string(required)Number of results to return per page.
POST /api/admin/v3/admins/create
Requests
Body
{
"admin[name]": "Hello, world!",
"admin[email]": "Hello, world!",
"admin[sso_identifier]": "Hello, world!",
"admin[user_id]": 1
}Schema
{
"type": "object",
"properties": {
"admin[name]": {
"type": "string",
"description": "Name of the admin"
},
"admin[email]": {
"type": "string",
"description": "Admin email"
},
"admin[sso_identifier]": {
"type": "string",
"description": "SSO ID of the Admin account"
},
"admin[user_id]": {
"type": "number",
"description": "ID of the user to link to the admin account"
}
},
"required": [
"admin[name]",
"admin[email]"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Create a new admin account
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"email": {
"type": "string",
"description": "Admin email"
},
"name": {
"type": "string",
"description": "Admin full name"
},
"admin_type": {
"type": "string",
"enum": [
"global",
"group"
],
"description": "Admin type"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Admin creation date"
}
},
"description": "Admin model"
}Create a new admin accountPOST/api/admin/v3/admins/create
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_idis provided a new user will be created to link to the admin account
mentoring ¶
Operations about mentorings
POST /api/admin/v3/mentoring/mentee_profiles
Requests
Body
{
"program_id": 1,
"mentee_profile[user_id]": 1,
"mentee_profile[status]": "Hello, world!",
"mentee_profile[customizable_attributes]": "Hello, world!"
}Schema
{
"type": "object",
"properties": {
"program_id": {
"type": "number",
"description": "ID of the program"
},
"mentee_profile[user_id]": {
"type": "number",
"description": "ID of the user"
},
"mentee_profile[status]": {
"type": "string",
"description": "Status of the mentee"
},
"mentee_profile[customizable_attributes]": {
"type": "string",
"description": "Values for the program's customizable attributes"
}
},
"required": [
"program_id",
"mentee_profile[user_id]",
"mentee_profile[status]"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Create a new mentee profile
Schema
{
"type": "object",
"properties": {
"mentee_id": {
"type": "integer",
"format": "int32",
"description": "User's Mentee Profile ID of the program. (Not to be confused with the user's id on the User Profile)"
},
"mentoring_program_id": {
"type": "integer",
"format": "int32",
"description": "ID of the program"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "User's ID on their User Profile used across the network. (Not to be confused with the user's mentee profile id on the program)"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Date when the mentee profile was created"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Date when the mentee was last updated"
},
"status_transition_dates": {
"type": "object",
"description": "The changes of status and their related date"
},
"status": {
"type": "string",
"description": "The user's current mentee status in this program"
},
"location": {
"description": "The user's location",
"type": "object",
"properties": {
"city": {
"type": "string",
"description": "City"
},
"country": {
"type": "string",
"description": "Country"
},
"country_code": {
"type": "string",
"description": "ISO3166-2 Country code"
},
"address": {
"type": "string",
"description": "Address"
},
"lat": {
"type": "number",
"format": "float",
"description": "Latitude"
},
"lng": {
"type": "number",
"format": "float",
"description": "Longitude"
}
}
},
"skills": {
"type": "string",
"description": "List of user's skills"
},
"name": {
"type": "string",
"description": "User's name"
},
"customizable_attributes": {
"type": "object",
"description": "Values for the program's customizable attributes"
}
},
"description": "Admin_V3_Mentoring_MenteeProfileEntity model"
}Create a new mentee profilePOST/api/admin/v3/mentoring/mentee_profiles
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[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"
}GET /api/admin/v3/mentoring/mentee_profiles?page=&per_page=&program_id=
Responses
List of mentee profiles
Schema
{
"type": "object",
"properties": {
"mentee_id": {
"type": "integer",
"format": "int32",
"description": "User's Mentee Profile ID of the program. (Not to be confused with the user's id on the User Profile)"
},
"mentoring_program_id": {
"type": "integer",
"format": "int32",
"description": "ID of the program"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "User's ID on their User Profile used across the network. (Not to be confused with the user's mentee profile id on the program)"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Date when the mentee profile was created"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Date when the mentee was last updated"
},
"status_transition_dates": {
"type": "object",
"description": "The changes of status and their related date"
},
"status": {
"type": "string",
"description": "The user's current mentee status in this program"
},
"location": {
"description": "The user's location",
"type": "object",
"properties": {
"city": {
"type": "string",
"description": "City"
},
"country": {
"type": "string",
"description": "Country"
},
"country_code": {
"type": "string",
"description": "ISO3166-2 Country code"
},
"address": {
"type": "string",
"description": "Address"
},
"lat": {
"type": "number",
"format": "float",
"description": "Latitude"
},
"lng": {
"type": "number",
"format": "float",
"description": "Longitude"
}
}
},
"skills": {
"type": "string",
"description": "List of user's skills"
},
"name": {
"type": "string",
"description": "User's name"
},
"customizable_attributes": {
"type": "object",
"description": "Values for the program's customizable attributes"
}
},
"description": "Admin_V3_Mentoring_MenteeProfileEntity model"
}List of mentee profilesGET/api/admin/v3/mentoring/mentee_profiles{?page,per_page,program_id}
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)
URI Parameters
- page
string(required)Page of results to fetch.
- per_page
string(required)Number of results to return per page.
- program_id
number(required)ID of the program
DELETE /api/admin/v3/mentoring/mentee_profiles/id?program_id=
Responses
Delete a mentee profile
Delete a mentee profileDELETE/api/admin/v3/mentoring/mentee_profiles/{id}{?program_id}
Required parameters are:
program_id: ID of the program.id: ID of the mentee profile to be deleted.
URI Parameters
- id
number(required)ID of the mentee profile
- program_id
number(required)ID of the program
GET /api/admin/v3/mentoring/mentee_profiles/id?program_id=
Responses
Get information on a mentee profile
Schema
{
"type": "object",
"properties": {
"mentee_id": {
"type": "integer",
"format": "int32",
"description": "User's Mentee Profile ID of the program. (Not to be confused with the user's id on the User Profile)"
},
"mentoring_program_id": {
"type": "integer",
"format": "int32",
"description": "ID of the program"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "User's ID on their User Profile used across the network. (Not to be confused with the user's mentee profile id on the program)"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Date when the mentee profile was created"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Date when the mentee was last updated"
},
"status_transition_dates": {
"type": "object",
"description": "The changes of status and their related date"
},
"status": {
"type": "string",
"description": "The user's current mentee status in this program"
},
"location": {
"description": "The user's location",
"type": "object",
"properties": {
"city": {
"type": "string",
"description": "City"
},
"country": {
"type": "string",
"description": "Country"
},
"country_code": {
"type": "string",
"description": "ISO3166-2 Country code"
},
"address": {
"type": "string",
"description": "Address"
},
"lat": {
"type": "number",
"format": "float",
"description": "Latitude"
},
"lng": {
"type": "number",
"format": "float",
"description": "Longitude"
}
}
},
"skills": {
"type": "string",
"description": "List of user's skills"
},
"name": {
"type": "string",
"description": "User's name"
},
"customizable_attributes": {
"type": "object",
"description": "Values for the program's customizable attributes"
}
},
"description": "Admin_V3_Mentoring_MenteeProfileEntity model"
}Get information on a mentee profileGET/api/admin/v3/mentoring/mentee_profiles/{id}{?program_id}
Required parameters are:
program_id: ID of the program.id: Unique ID of the mentee profile.
URI Parameters
- id
number(required)ID of the mentee
- program_id
number(required)ID of the program
PUT /api/admin/v3/mentoring/mentee_profiles/id
Requests
Body
{
"program_id": 1,
"mentee_profile[status]": "Hello, world!",
"mentee_profile[customizable_attributes]": "Hello, world!"
}Schema
{
"type": "object",
"properties": {
"program_id": {
"type": "number",
"description": "ID of the program"
},
"mentee_profile[status]": {
"type": "string",
"description": "Status of the mentee"
},
"mentee_profile[customizable_attributes]": {
"type": "string",
"description": "Values for the program's customizable attributes"
}
},
"required": [
"program_id"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Update information of a specific mentee profile
Schema
{
"type": "object",
"properties": {
"mentee_id": {
"type": "integer",
"format": "int32",
"description": "User's Mentee Profile ID of the program. (Not to be confused with the user's id on the User Profile)"
},
"mentoring_program_id": {
"type": "integer",
"format": "int32",
"description": "ID of the program"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "User's ID on their User Profile used across the network. (Not to be confused with the user's mentee profile id on the program)"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Date when the mentee profile was created"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Date when the mentee was last updated"
},
"status_transition_dates": {
"type": "object",
"description": "The changes of status and their related date"
},
"status": {
"type": "string",
"description": "The user's current mentee status in this program"
},
"location": {
"description": "The user's location",
"type": "object",
"properties": {
"city": {
"type": "string",
"description": "City"
},
"country": {
"type": "string",
"description": "Country"
},
"country_code": {
"type": "string",
"description": "ISO3166-2 Country code"
},
"address": {
"type": "string",
"description": "Address"
},
"lat": {
"type": "number",
"format": "float",
"description": "Latitude"
},
"lng": {
"type": "number",
"format": "float",
"description": "Longitude"
}
}
},
"skills": {
"type": "string",
"description": "List of user's skills"
},
"name": {
"type": "string",
"description": "User's name"
},
"customizable_attributes": {
"type": "object",
"description": "Values for the program's customizable attributes"
}
},
"description": "Admin_V3_Mentoring_MenteeProfileEntity model"
}Update information of a specific mentee profilePUT/api/admin/v3/mentoring/mentee_profiles/{id}
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[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"
}URI Parameters
- id
number(required)ID of the mentee profile
POST /api/admin/v3/mentoring/mentor_profiles
Requests
Body
{
"program_id": 1,
"mentor_profile[user_id]": 1,
"mentor_profile[status]": "Hello, world!",
"mentor_profile[customizable_attributes]": "Hello, world!"
}Schema
{
"type": "object",
"properties": {
"program_id": {
"type": "number",
"description": "ID of the program"
},
"mentor_profile[user_id]": {
"type": "number",
"description": "ID of the user"
},
"mentor_profile[status]": {
"type": "string",
"description": "Status of the mentor"
},
"mentor_profile[customizable_attributes]": {
"type": "string",
"description": "Values for the program's customizable attributes"
}
},
"required": [
"program_id",
"mentor_profile[user_id]",
"mentor_profile[status]"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Create a new mentor profile
Schema
{
"type": "object",
"properties": {
"mentor_id": {
"type": "integer",
"format": "int32",
"description": "User's Mentor Profile ID of the program. (Not to be confused with the user's id on the User Profile)"
},
"mentoring_program_id": {
"type": "integer",
"format": "int32",
"description": "ID of the program"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "User's ID on their User Profile used across the network. (Not to be confused with the user's mentor profile id on the program)"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Date when the mentor profile was created"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Date when the mentor was last updated"
},
"accepted_mentees_count": {
"type": "integer",
"format": "int32",
"description": "Count of mentees user has accepted"
},
"status_transition_dates": {
"type": "object",
"description": "The changes of status and their related date"
},
"status": {
"type": "string",
"description": "The user's current mentor status in this program"
},
"location": {
"description": "The user's location",
"type": "object",
"properties": {
"city": {
"type": "string",
"description": "City"
},
"country": {
"type": "string",
"description": "Country"
},
"country_code": {
"type": "string",
"description": "ISO3166-2 Country code"
},
"address": {
"type": "string",
"description": "Address"
},
"lat": {
"type": "number",
"format": "float",
"description": "Latitude"
},
"lng": {
"type": "number",
"format": "float",
"description": "Longitude"
}
}
},
"skills": {
"type": "string",
"description": "List of user's skills"
},
"name": {
"type": "string",
"description": "User's name"
},
"customizable_attributes": {
"type": "object",
"description": "Values for the program's customizable attributes"
}
},
"description": "Admin_V3_Mentoring_MentorProfileEntity model"
}Create a new mentor profilePOST/api/admin/v3/mentoring/mentor_profiles
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[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"
}GET /api/admin/v3/mentoring/mentor_profiles?page=&per_page=&program_id=
Responses
List of mentor profiles
Schema
{
"type": "object",
"properties": {
"mentor_id": {
"type": "integer",
"format": "int32",
"description": "User's Mentor Profile ID of the program. (Not to be confused with the user's id on the User Profile)"
},
"mentoring_program_id": {
"type": "integer",
"format": "int32",
"description": "ID of the program"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "User's ID on their User Profile used across the network. (Not to be confused with the user's mentor profile id on the program)"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Date when the mentor profile was created"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Date when the mentor was last updated"
},
"accepted_mentees_count": {
"type": "integer",
"format": "int32",
"description": "Count of mentees user has accepted"
},
"status_transition_dates": {
"type": "object",
"description": "The changes of status and their related date"
},
"status": {
"type": "string",
"description": "The user's current mentor status in this program"
},
"location": {
"description": "The user's location",
"type": "object",
"properties": {
"city": {
"type": "string",
"description": "City"
},
"country": {
"type": "string",
"description": "Country"
},
"country_code": {
"type": "string",
"description": "ISO3166-2 Country code"
},
"address": {
"type": "string",
"description": "Address"
},
"lat": {
"type": "number",
"format": "float",
"description": "Latitude"
},
"lng": {
"type": "number",
"format": "float",
"description": "Longitude"
}
}
},
"skills": {
"type": "string",
"description": "List of user's skills"
},
"name": {
"type": "string",
"description": "User's name"
},
"customizable_attributes": {
"type": "object",
"description": "Values for the program's customizable attributes"
}
},
"description": "Admin_V3_Mentoring_MentorProfileEntity model"
}List of mentor profilesGET/api/admin/v3/mentoring/mentor_profiles{?page,per_page,program_id}
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)
URI Parameters
- page
string(required)Page of results to fetch.
- per_page
string(required)Number of results to return per page.
- program_id
number(required)ID of the program
DELETE /api/admin/v3/mentoring/mentor_profiles/id?program_id=
Responses
Delete a mentor profile
Delete a mentor profileDELETE/api/admin/v3/mentoring/mentor_profiles/{id}{?program_id}
Required parameters are:
program_id: ID of the program.id: ID of the mentor profile to be deleted.
URI Parameters
- id
number(required)ID of the mentor profile
- program_id
number(required)ID of the program
GET /api/admin/v3/mentoring/mentor_profiles/id?program_id=
Responses
Get information on a mentor profile
Schema
{
"type": "object",
"properties": {
"mentor_id": {
"type": "integer",
"format": "int32",
"description": "User's Mentor Profile ID of the program. (Not to be confused with the user's id on the User Profile)"
},
"mentoring_program_id": {
"type": "integer",
"format": "int32",
"description": "ID of the program"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "User's ID on their User Profile used across the network. (Not to be confused with the user's mentor profile id on the program)"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Date when the mentor profile was created"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Date when the mentor was last updated"
},
"accepted_mentees_count": {
"type": "integer",
"format": "int32",
"description": "Count of mentees user has accepted"
},
"status_transition_dates": {
"type": "object",
"description": "The changes of status and their related date"
},
"status": {
"type": "string",
"description": "The user's current mentor status in this program"
},
"location": {
"description": "The user's location",
"type": "object",
"properties": {
"city": {
"type": "string",
"description": "City"
},
"country": {
"type": "string",
"description": "Country"
},
"country_code": {
"type": "string",
"description": "ISO3166-2 Country code"
},
"address": {
"type": "string",
"description": "Address"
},
"lat": {
"type": "number",
"format": "float",
"description": "Latitude"
},
"lng": {
"type": "number",
"format": "float",
"description": "Longitude"
}
}
},
"skills": {
"type": "string",
"description": "List of user's skills"
},
"name": {
"type": "string",
"description": "User's name"
},
"customizable_attributes": {
"type": "object",
"description": "Values for the program's customizable attributes"
}
},
"description": "Admin_V3_Mentoring_MentorProfileEntity model"
}Get information on a mentor profileGET/api/admin/v3/mentoring/mentor_profiles/{id}{?program_id}
Required parameters are:
program_id: ID of the program.id: Unique ID of the mentor profile.
URI Parameters
- id
number(required)ID of the mentor
- program_id
number(required)ID of the program
PUT /api/admin/v3/mentoring/mentor_profiles/id
Requests
Body
{
"program_id": 1,
"mentor_profile[status]": "Hello, world!",
"mentor_profile[customizable_attributes]": "Hello, world!"
}Schema
{
"type": "object",
"properties": {
"program_id": {
"type": "number",
"description": "ID of the program"
},
"mentor_profile[status]": {
"type": "string",
"description": "Status of the mentor"
},
"mentor_profile[customizable_attributes]": {
"type": "string",
"description": "Values for the program's customizable attributes"
}
},
"required": [
"program_id"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Update information of a specific mentor profile
Schema
{
"type": "object",
"properties": {
"mentor_id": {
"type": "integer",
"format": "int32",
"description": "User's Mentor Profile ID of the program. (Not to be confused with the user's id on the User Profile)"
},
"mentoring_program_id": {
"type": "integer",
"format": "int32",
"description": "ID of the program"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "User's ID on their User Profile used across the network. (Not to be confused with the user's mentor profile id on the program)"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Date when the mentor profile was created"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Date when the mentor was last updated"
},
"accepted_mentees_count": {
"type": "integer",
"format": "int32",
"description": "Count of mentees user has accepted"
},
"status_transition_dates": {
"type": "object",
"description": "The changes of status and their related date"
},
"status": {
"type": "string",
"description": "The user's current mentor status in this program"
},
"location": {
"description": "The user's location",
"type": "object",
"properties": {
"city": {
"type": "string",
"description": "City"
},
"country": {
"type": "string",
"description": "Country"
},
"country_code": {
"type": "string",
"description": "ISO3166-2 Country code"
},
"address": {
"type": "string",
"description": "Address"
},
"lat": {
"type": "number",
"format": "float",
"description": "Latitude"
},
"lng": {
"type": "number",
"format": "float",
"description": "Longitude"
}
}
},
"skills": {
"type": "string",
"description": "List of user's skills"
},
"name": {
"type": "string",
"description": "User's name"
},
"customizable_attributes": {
"type": "object",
"description": "Values for the program's customizable attributes"
}
},
"description": "Admin_V3_Mentoring_MentorProfileEntity model"
}Update information of a specific mentor profilePUT/api/admin/v3/mentoring/mentor_profiles/{id}
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[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"
}URI Parameters
- id
number(required)ID of the mentor profile
POST /api/admin/v3/mentoring/programs
Requests
Body
{
"program[mode]": "Hello, world!",
"program[name]": "Hello, world!",
"program[parent_type]": "Hello, world!",
"program[parent_id]": 1,
"program[description]": "Hello, world!",
"program[cover_picture]": "Hello, world!",
"program[mentee_label]": "Hello, world!",
"program[mentor_label]": "Hello, world!",
"program[maximum_mentees]": 1,
"program[applied_to_be_mentee_text]": "Hello, world!",
"program[applied_to_be_mentor_text]": "Hello, world!",
"program[manager_ids][]": [
1
],
"program[published_at]": "Hello, world!"
}Schema
{
"type": "object",
"properties": {
"program[mode]": {
"type": "string",
"description": "Program type/ how matches are created"
},
"program[name]": {
"type": "string",
"description": "Title of the program"
},
"program[parent_type]": {
"type": "string",
"description": "Program creator type"
},
"program[parent_id]": {
"type": "number",
"description": "Program creator ID"
},
"program[description]": {
"type": "string",
"description": "Description of the program"
},
"program[cover_picture]": {
"type": "string",
"description": "Cover picture of the program"
},
"program[mentee_label]": {
"type": "string",
"description": "Mentee custom label"
},
"program[mentor_label]": {
"type": "string",
"description": "Mentor custom label"
},
"program[maximum_mentees]": {
"type": "number",
"description": "Maximum number of mentees allowed per mentor"
},
"program[applied_to_be_mentee_text]": {
"type": "string",
"description": "Text displayed at the top of the mentee application form"
},
"program[applied_to_be_mentor_text]": {
"type": "string",
"description": "Text displayed at the top of the mentor application form"
},
"program[manager_ids][]": {
"type": "array",
"items": {
"type": "number"
},
"description": "IDs of admins to get automated emails about this program"
},
"program[published_at]": {
"type": "string",
"description": "Date when the program was published"
}
},
"required": [
"program[mode]",
"program[name]"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Create a new mentoring program
Schema
{
"type": "object",
"properties": {
"applied_to_be_mentee_text": {
"type": "string",
"description": "Text displayed at the top of the mentee application form."
},
"applied_to_be_mentor_text": {
"type": "string",
"description": "Text displayed at the top of the mentor application form."
},
"cover_picture": {
"description": "Cover picture of the program.",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "ID of the Global Storage Upload"
},
"file_name": {
"type": "string",
"description": "Global Storage Upload file name."
},
"content_type": {
"type": "string",
"description": "Global Storage Upload content type."
},
"url": {
"type": "string",
"description": "Global Storage Upload URL."
}
}
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Date the program was created."
},
"description": {
"type": "string",
"description": "The program's description."
},
"id": {
"type": "integer",
"format": "int32",
"description": "The program's unique ID."
},
"manager_ids": {
"type": "integer",
"format": "int32",
"description": "The admin IDs of the program managers. These admins will receive the automated admin communications of the program."
},
"maximum_mentees": {
"type": "integer",
"format": "int32",
"description": "The maximum number of mentees a mentor can have."
},
"mentee_label": {
"type": "string",
"description": "How mentees of this program are called in the Front Office."
},
"mentor_label": {
"type": "string",
"description": "How mentors of this program are called in the Front Office."
},
"mode": {
"type": "string",
"description": "The program's type. (User Match or Admin Match)"
},
"name": {
"type": "string",
"description": "The program's name."
},
"parent_type": {
"type": "string",
"description": "Whether or not the program is created by the network or by a group."
},
"parent_id": {
"type": "integer",
"format": "int32",
"description": "The ID of the program's creator. (The network's ID or a specific group's ID)"
},
"published_at": {
"type": "string",
"format": "date-time",
"description": "The date the program was last published."
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "The date the program was last updated."
}
},
"description": "Admin_V3_Mentoring_ProgramEntity model"
}Create a new mentoring programPOST/api/admin/v3/mentoring/programs
Required parameters are:
mode: Program type or how matches are created in the program. Possible values areuser_matchfor programs where mentees apply directly to mentors, andadmin_matchfor 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 areNetworkfor the network created programs, andTopics::Topicfor 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.
GET /api/admin/v3/mentoring/programs?page=&per_page=
Responses
List of mentoring programs
Schema
{
"type": "object",
"properties": {
"applied_to_be_mentee_text": {
"type": "string",
"description": "Text displayed at the top of the mentee application form."
},
"applied_to_be_mentor_text": {
"type": "string",
"description": "Text displayed at the top of the mentor application form."
},
"cover_picture": {
"description": "Cover picture of the program.",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "ID of the Global Storage Upload"
},
"file_name": {
"type": "string",
"description": "Global Storage Upload file name."
},
"content_type": {
"type": "string",
"description": "Global Storage Upload content type."
},
"url": {
"type": "string",
"description": "Global Storage Upload URL."
}
}
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Date the program was created."
},
"description": {
"type": "string",
"description": "The program's description."
},
"id": {
"type": "integer",
"format": "int32",
"description": "The program's unique ID."
},
"manager_ids": {
"type": "integer",
"format": "int32",
"description": "The admin IDs of the program managers. These admins will receive the automated admin communications of the program."
},
"maximum_mentees": {
"type": "integer",
"format": "int32",
"description": "The maximum number of mentees a mentor can have."
},
"mentee_label": {
"type": "string",
"description": "How mentees of this program are called in the Front Office."
},
"mentor_label": {
"type": "string",
"description": "How mentors of this program are called in the Front Office."
},
"mode": {
"type": "string",
"description": "The program's type. (User Match or Admin Match)"
},
"name": {
"type": "string",
"description": "The program's name."
},
"parent_type": {
"type": "string",
"description": "Whether or not the program is created by the network or by a group."
},
"parent_id": {
"type": "integer",
"format": "int32",
"description": "The ID of the program's creator. (The network's ID or a specific group's ID)"
},
"published_at": {
"type": "string",
"format": "date-time",
"description": "The date the program was last published."
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "The date the program was last updated."
}
},
"description": "Admin_V3_Mentoring_ProgramEntity model"
}List of mentoring programsGET/api/admin/v3/mentoring/programs{?page,per_page}
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 areNetworkfor the network created programs, andTopics::Topicfor 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 areuser_matchfor programs where mentees apply directly to mentors, andadmin_matchfor programs where admins create matches between mentors and mentees.published: Publication status of the program.
URI Parameters
- page
string(required)Page of results to fetch.
- per_page
string(required)Number of results to return per page.
GET /api/admin/v3/mentoring/programs/id
Responses
Get information on a mentoring program
Schema
{
"type": "object",
"properties": {
"applied_to_be_mentee_text": {
"type": "string",
"description": "Text displayed at the top of the mentee application form."
},
"applied_to_be_mentor_text": {
"type": "string",
"description": "Text displayed at the top of the mentor application form."
},
"cover_picture": {
"description": "Cover picture of the program.",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "ID of the Global Storage Upload"
},
"file_name": {
"type": "string",
"description": "Global Storage Upload file name."
},
"content_type": {
"type": "string",
"description": "Global Storage Upload content type."
},
"url": {
"type": "string",
"description": "Global Storage Upload URL."
}
}
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Date the program was created."
},
"description": {
"type": "string",
"description": "The program's description."
},
"id": {
"type": "integer",
"format": "int32",
"description": "The program's unique ID."
},
"manager_ids": {
"type": "integer",
"format": "int32",
"description": "The admin IDs of the program managers. These admins will receive the automated admin communications of the program."
},
"maximum_mentees": {
"type": "integer",
"format": "int32",
"description": "The maximum number of mentees a mentor can have."
},
"mentee_label": {
"type": "string",
"description": "How mentees of this program are called in the Front Office."
},
"mentor_label": {
"type": "string",
"description": "How mentors of this program are called in the Front Office."
},
"mode": {
"type": "string",
"description": "The program's type. (User Match or Admin Match)"
},
"name": {
"type": "string",
"description": "The program's name."
},
"parent_type": {
"type": "string",
"description": "Whether or not the program is created by the network or by a group."
},
"parent_id": {
"type": "integer",
"format": "int32",
"description": "The ID of the program's creator. (The network's ID or a specific group's ID)"
},
"published_at": {
"type": "string",
"format": "date-time",
"description": "The date the program was last published."
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "The date the program was last updated."
}
},
"description": "Admin_V3_Mentoring_ProgramEntity model"
}Get information on a mentoring programGET/api/admin/v3/mentoring/programs/{id}
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 areNetworkfor the network created programs, andTopics::Topicfor 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.
URI Parameters
- id
number(required)ID of the program
PUT /api/admin/v3/mentoring/programs/id
Requests
Body
{
"program[parent_type]": "Hello, world!",
"program[parent_id]": 1,
"program[name]": "Hello, world!",
"program[description]": "Hello, world!",
"program[cover_picture]": "Hello, world!",
"program[mentee_label]": "Hello, world!",
"program[mentor_label]": "Hello, world!",
"program[maximum_mentees]": 1,
"program[applied_to_be_mentee_text]": "Hello, world!",
"program[applied_to_be_mentor_text]": "Hello, world!",
"program[manager_ids][]": [
1
],
"program[published_at]": "Hello, world!"
}Schema
{
"type": "object",
"properties": {
"program[parent_type]": {
"type": "string",
"description": "Program creator type"
},
"program[parent_id]": {
"type": "number",
"description": "Program creator ID"
},
"program[name]": {
"type": "string",
"description": "Title of the program"
},
"program[description]": {
"type": "string",
"description": "Description of the program"
},
"program[cover_picture]": {
"type": "string",
"description": "Cover picture of the program"
},
"program[mentee_label]": {
"type": "string",
"description": "Mentee custom label"
},
"program[mentor_label]": {
"type": "string",
"description": "Mentor custom label"
},
"program[maximum_mentees]": {
"type": "number",
"description": "Maximum number of mentees allowed per mentor"
},
"program[applied_to_be_mentee_text]": {
"type": "string",
"description": "Text displayed at the top of the mentee application form"
},
"program[applied_to_be_mentor_text]": {
"type": "string",
"description": "Text displayed at the top of the mentor application form"
},
"program[manager_ids][]": {
"type": "array",
"items": {
"type": "number"
},
"description": "IDs of admins to get automated emails about this program"
},
"program[published_at]": {
"type": "string",
"description": "Date when the program was published"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Update information of a specific mentoring program
Schema
{
"type": "object",
"properties": {
"applied_to_be_mentee_text": {
"type": "string",
"description": "Text displayed at the top of the mentee application form."
},
"applied_to_be_mentor_text": {
"type": "string",
"description": "Text displayed at the top of the mentor application form."
},
"cover_picture": {
"description": "Cover picture of the program.",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "ID of the Global Storage Upload"
},
"file_name": {
"type": "string",
"description": "Global Storage Upload file name."
},
"content_type": {
"type": "string",
"description": "Global Storage Upload content type."
},
"url": {
"type": "string",
"description": "Global Storage Upload URL."
}
}
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Date the program was created."
},
"description": {
"type": "string",
"description": "The program's description."
},
"id": {
"type": "integer",
"format": "int32",
"description": "The program's unique ID."
},
"manager_ids": {
"type": "integer",
"format": "int32",
"description": "The admin IDs of the program managers. These admins will receive the automated admin communications of the program."
},
"maximum_mentees": {
"type": "integer",
"format": "int32",
"description": "The maximum number of mentees a mentor can have."
},
"mentee_label": {
"type": "string",
"description": "How mentees of this program are called in the Front Office."
},
"mentor_label": {
"type": "string",
"description": "How mentors of this program are called in the Front Office."
},
"mode": {
"type": "string",
"description": "The program's type. (User Match or Admin Match)"
},
"name": {
"type": "string",
"description": "The program's name."
},
"parent_type": {
"type": "string",
"description": "Whether or not the program is created by the network or by a group."
},
"parent_id": {
"type": "integer",
"format": "int32",
"description": "The ID of the program's creator. (The network's ID or a specific group's ID)"
},
"published_at": {
"type": "string",
"format": "date-time",
"description": "The date the program was last published."
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "The date the program was last updated."
}
},
"description": "Admin_V3_Mentoring_ProgramEntity model"
}Update information of a specific mentoring programPUT/api/admin/v3/mentoring/programs/{id}
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 areNetworkfor the network created programs, andTopics::Topicfor 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 areuser_matchfor programs where mentees apply directly to mentors, andadmin_matchfor 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.
URI Parameters
- id
number(required)ID of the program to be updated
POST /api/admin/v3/mentoring/programs/id/duplicate
Requests
Body
{
"program[parent_type]": "Hello, world!",
"program[parent_id]": 1
}Schema
{
"type": "object",
"properties": {
"program[parent_type]": {
"type": "string",
"description": "Program creator type"
},
"program[parent_id]": {
"type": "number",
"description": "Program creator ID"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Duplicate a program
Schema
{
"type": "object",
"properties": {
"applied_to_be_mentee_text": {
"type": "string",
"description": "Text displayed at the top of the mentee application form."
},
"applied_to_be_mentor_text": {
"type": "string",
"description": "Text displayed at the top of the mentor application form."
},
"cover_picture": {
"description": "Cover picture of the program.",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "ID of the Global Storage Upload"
},
"file_name": {
"type": "string",
"description": "Global Storage Upload file name."
},
"content_type": {
"type": "string",
"description": "Global Storage Upload content type."
},
"url": {
"type": "string",
"description": "Global Storage Upload URL."
}
}
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Date the program was created."
},
"description": {
"type": "string",
"description": "The program's description."
},
"id": {
"type": "integer",
"format": "int32",
"description": "The program's unique ID."
},
"manager_ids": {
"type": "integer",
"format": "int32",
"description": "The admin IDs of the program managers. These admins will receive the automated admin communications of the program."
},
"maximum_mentees": {
"type": "integer",
"format": "int32",
"description": "The maximum number of mentees a mentor can have."
},
"mentee_label": {
"type": "string",
"description": "How mentees of this program are called in the Front Office."
},
"mentor_label": {
"type": "string",
"description": "How mentors of this program are called in the Front Office."
},
"mode": {
"type": "string",
"description": "The program's type. (User Match or Admin Match)"
},
"name": {
"type": "string",
"description": "The program's name."
},
"parent_type": {
"type": "string",
"description": "Whether or not the program is created by the network or by a group."
},
"parent_id": {
"type": "integer",
"format": "int32",
"description": "The ID of the program's creator. (The network's ID or a specific group's ID)"
},
"published_at": {
"type": "string",
"format": "date-time",
"description": "The date the program was last published."
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "The date the program was last updated."
}
},
"description": "Admin_V3_Mentoring_ProgramEntity model"
}Duplicate a programPOST/api/admin/v3/mentoring/programs/{id}/duplicate
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 areNetworkfor the network created programs, andTopics::Topicfor 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.
URI Parameters
- id
number(required)ID of the program to be duplicated
POST /api/admin/v3/mentoring/relationships
Requests
Body
{
"program_id": 1,
"relationship[status]": "Hello, world!",
"relationship[mentee_id]": 1,
"relationship[mentor_id]": 1,
"relationship[application_message]": "Hello, world!"
}Schema
{
"type": "object",
"properties": {
"program_id": {
"type": "number",
"description": "ID of the program"
},
"relationship[status]": {
"type": "string",
"description": "Status of the relationship"
},
"relationship[mentee_id]": {
"type": "number",
"description": "ID of the mentee"
},
"relationship[mentor_id]": {
"type": "number",
"description": "ID of the mentor"
},
"relationship[application_message]": {
"type": "string",
"description": "Message of the mentee application"
}
},
"required": [
"program_id",
"relationship[status]",
"relationship[mentee_id]",
"relationship[mentor_id]"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Create a new relationship
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "ID of the relationship"
},
"status": {
"type": "string",
"description": "Status of the relationship"
},
"ended_relationship_message": {
"type": "string",
"description": "Message for the ended relationship"
},
"application_message": {
"type": "string",
"description": "Message of the mentee application"
},
"mentoring_program_id": {
"type": "integer",
"format": "int32",
"description": "ID of the program"
},
"mentor_id": {
"type": "integer",
"format": "int32",
"description": "ID of the mentor"
},
"mentee_id": {
"type": "integer",
"format": "int32",
"description": "ID of the mentee"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Date when the relationship was created"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Date when the relationship was last updated"
},
"rejection_message": {
"type": "string",
"description": "Message for the rejected relationship"
},
"status_transition_dates": {
"type": "object",
"description": "The changes of status and their related date"
},
"mentor_user_id": {
"type": "integer",
"format": "int32",
"description": "User's ID on their User Profile used across the network. (Not to be confused with the user's mentor profile id on the program)"
},
"mentee_user_id": {
"type": "integer",
"format": "int32",
"description": "User's ID on their User Profile used across the network. (Not to be confused with the user's mentee profile id on the program)"
},
"mentor_name": {
"type": "string",
"description": "Name of the mentor"
},
"mentee_name": {
"type": "string",
"description": "Name of the mentee"
}
},
"description": "Admin_V3_Mentoring_RelationshipEntity model"
}Create a new relationshipPOST/api/admin/v3/mentoring/relationships
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[application_message]: Message of the mentee application.
GET /api/admin/v3/mentoring/relationships?page=&per_page=&program_id=
Responses
List of relationships
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "ID of the relationship"
},
"status": {
"type": "string",
"description": "Status of the relationship"
},
"ended_relationship_message": {
"type": "string",
"description": "Message for the ended relationship"
},
"application_message": {
"type": "string",
"description": "Message of the mentee application"
},
"mentoring_program_id": {
"type": "integer",
"format": "int32",
"description": "ID of the program"
},
"mentor_id": {
"type": "integer",
"format": "int32",
"description": "ID of the mentor"
},
"mentee_id": {
"type": "integer",
"format": "int32",
"description": "ID of the mentee"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Date when the relationship was created"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Date when the relationship was last updated"
},
"rejection_message": {
"type": "string",
"description": "Message for the rejected relationship"
},
"status_transition_dates": {
"type": "object",
"description": "The changes of status and their related date"
},
"mentor_user_id": {
"type": "integer",
"format": "int32",
"description": "User's ID on their User Profile used across the network. (Not to be confused with the user's mentor profile id on the program)"
},
"mentee_user_id": {
"type": "integer",
"format": "int32",
"description": "User's ID on their User Profile used across the network. (Not to be confused with the user's mentee profile id on the program)"
},
"mentor_name": {
"type": "string",
"description": "Name of the mentor"
},
"mentee_name": {
"type": "string",
"description": "Name of the mentee"
}
},
"description": "Admin_V3_Mentoring_RelationshipEntity model"
}List of relationshipsGET/api/admin/v3/mentoring/relationships{?page,per_page,program_id}
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.
URI Parameters
- page
string(required)Page of results to fetch.
- per_page
string(required)Number of results to return per page.
- program_id
number(required)ID of the program
GET /api/admin/v3/mentoring/relationships/id?program_id=
Responses
Get information on a relationship
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "ID of the relationship"
},
"status": {
"type": "string",
"description": "Status of the relationship"
},
"ended_relationship_message": {
"type": "string",
"description": "Message for the ended relationship"
},
"application_message": {
"type": "string",
"description": "Message of the mentee application"
},
"mentoring_program_id": {
"type": "integer",
"format": "int32",
"description": "ID of the program"
},
"mentor_id": {
"type": "integer",
"format": "int32",
"description": "ID of the mentor"
},
"mentee_id": {
"type": "integer",
"format": "int32",
"description": "ID of the mentee"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Date when the relationship was created"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Date when the relationship was last updated"
},
"rejection_message": {
"type": "string",
"description": "Message for the rejected relationship"
},
"status_transition_dates": {
"type": "object",
"description": "The changes of status and their related date"
},
"mentor_user_id": {
"type": "integer",
"format": "int32",
"description": "User's ID on their User Profile used across the network. (Not to be confused with the user's mentor profile id on the program)"
},
"mentee_user_id": {
"type": "integer",
"format": "int32",
"description": "User's ID on their User Profile used across the network. (Not to be confused with the user's mentee profile id on the program)"
},
"mentor_name": {
"type": "string",
"description": "Name of the mentor"
},
"mentee_name": {
"type": "string",
"description": "Name of the mentee"
}
},
"description": "Admin_V3_Mentoring_RelationshipEntity model"
}Get information on a relationshipGET/api/admin/v3/mentoring/relationships/{id}{?program_id}
Required parameters are:
program_id: ID of the program.id: Unique ID of the mentor profile.
URI Parameters
- id
number(required)ID of the relationship
- program_id
number(required)ID of the program
PUT /api/admin/v3/mentoring/relationships/id
Requests
Body
{
"program_id": 1,
"relationship[status]": "Hello, world!",
"relationship[application_message]": "Hello, world!",
"relationship[ended_relationship_message]": "Hello, world!",
"relationship[rejection_message]": "Hello, world!"
}Schema
{
"type": "object",
"properties": {
"program_id": {
"type": "number",
"description": "ID of the program"
},
"relationship[status]": {
"type": "string",
"description": "Status of the relationship"
},
"relationship[application_message]": {
"type": "string",
"description": "Message of the mentee application"
},
"relationship[ended_relationship_message]": {
"type": "string",
"description": "Message of the ended relationship"
},
"relationship[rejection_message]": {
"type": "string",
"description": "Message of the rejection"
}
},
"required": [
"program_id"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Update information of a specific relationship
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "ID of the relationship"
},
"status": {
"type": "string",
"description": "Status of the relationship"
},
"ended_relationship_message": {
"type": "string",
"description": "Message for the ended relationship"
},
"application_message": {
"type": "string",
"description": "Message of the mentee application"
},
"mentoring_program_id": {
"type": "integer",
"format": "int32",
"description": "ID of the program"
},
"mentor_id": {
"type": "integer",
"format": "int32",
"description": "ID of the mentor"
},
"mentee_id": {
"type": "integer",
"format": "int32",
"description": "ID of the mentee"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Date when the relationship was created"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Date when the relationship was last updated"
},
"rejection_message": {
"type": "string",
"description": "Message for the rejected relationship"
},
"status_transition_dates": {
"type": "object",
"description": "The changes of status and their related date"
},
"mentor_user_id": {
"type": "integer",
"format": "int32",
"description": "User's ID on their User Profile used across the network. (Not to be confused with the user's mentor profile id on the program)"
},
"mentee_user_id": {
"type": "integer",
"format": "int32",
"description": "User's ID on their User Profile used across the network. (Not to be confused with the user's mentee profile id on the program)"
},
"mentor_name": {
"type": "string",
"description": "Name of the mentor"
},
"mentee_name": {
"type": "string",
"description": "Name of the mentee"
}
},
"description": "Admin_V3_Mentoring_RelationshipEntity model"
}Update information of a specific relationshipPUT/api/admin/v3/mentoring/relationships/{id}
Required parameters are:
program_id: ID of the program.id: ID of the relationshiprelationship[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[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
URI Parameters
- id
number(required)ID of the relationship
DELETE /api/admin/v3/mentoring/relationships/id?program_id=
Responses
Delete a relationship
Delete a relationshipDELETE/api/admin/v3/mentoring/relationships/{id}{?program_id}
Required parameters are:
program_id: ID of the program.id: ID of the relationship to be deleted.
URI Parameters
- id
number(required)ID of the relationship
- program_id
number(required)ID of the program
POST /api/admin/v3/mentoring/customizable_attributes
Requests
Body
{
"program_id": 1,
"customizable_attribute[type]": "Hello, world!",
"customizable_attribute[customizable_type]": "Hello, world!",
"customizable_attribute[display_name]": "Hello, world!",
"customizable_attribute[required]": true,
"customizable_attribute[placeholder]": "Hello, world!",
"customizable_attribute[tooltip]": "Hello, world!",
"customizable_attribute[config][is_displayed_in_mentoring_card]": true,
"customizable_attribute[config][is_displayed_in_mentoring_form]": true,
"customizable_attribute[config][is_displayed_in_search_filters]": true,
"customizable_attribute[text_size]": 1,
"customizable_attribute[options][]": [],
"customizable_attribute[multi]": true,
"customizable_attribute[json_options]": "Hello, world!"
}Schema
{
"type": "object",
"properties": {
"program_id": {
"type": "number",
"description": "ID of the program"
},
"customizable_attribute[type]": {
"type": "string",
"description": "Type of the customizable attribute"
},
"customizable_attribute[customizable_type]": {
"type": "string",
"description": "Mentee or Mentor customizable attribute"
},
"customizable_attribute[display_name]": {
"type": "string",
"description": "Name of the label"
},
"customizable_attribute[required]": {
"type": "boolean",
"description": "Whether the customizable attribute is required or not"
},
"customizable_attribute[placeholder]": {
"type": "string",
"description": "Placeholder for the customizable attribute"
},
"customizable_attribute[tooltip]": {
"type": "string",
"description": "Tooltip for the customizable attribute"
},
"customizable_attribute[config][is_displayed_in_mentoring_card]": {
"type": "boolean",
"description": "Whether the customizable attribute is displayed in the mentoring card"
},
"customizable_attribute[config][is_displayed_in_mentoring_form]": {
"type": "boolean",
"description": "Whether the customizable attribute is displayed in the mentoring form"
},
"customizable_attribute[config][is_displayed_in_search_filters]": {
"type": "boolean",
"description": "For Select customizable attribute. Whether the customizable attribute is displayed in the search filters"
},
"customizable_attribute[text_size]": {
"type": "number",
"description": "For Text customizable attribute, the size of the text (optional)"
},
"customizable_attribute[options][]": {
"type": "array",
"description": "For Select customizable attribute, the array of options (required if type is select)\n\n+"
},
"customizable_attribute[multi]": {
"type": "boolean",
"description": "For Select customizable attribute, whether it is multi select or not (optional)"
},
"customizable_attribute[json_options]": {
"type": "string",
"description": "For DoubleSelect customizable attribute, the json options (required if type is double_select)"
}
},
"required": [
"program_id",
"customizable_attribute[type]",
"customizable_attribute[customizable_type]",
"customizable_attribute[display_name]"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Create a new customizable attribute
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"customizable_id": {
"type": "integer",
"format": "int32",
"description": "Customizable ID"
},
"type": {
"type": "string",
"enum": [
"CustomizableAttribute::Boolean",
"CustomizableAttribute::Date",
"CustomizableAttribute::DoubleSelect",
"CustomizableAttribute::Number",
"CustomizableAttribute::Select",
"CustomizableAttribute::Text"
],
"description": "Customizable Attribute type"
},
"customizable_type": {
"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",
"mentorships",
"mentorships_mentee",
"mentorships_mentor",
"ne_event",
"ne_ticket",
"topic_approval",
"topic_mentorships",
"topic_mentorships_mentee",
"topic_mentorships_mentor",
"user",
"ventures_venture"
],
"description": "Customizable Attribute associated model (User, Experience)"
},
"name": {
"type": "string",
"description": "Customizable Attribute name"
},
"display_name": {
"type": "string",
"description": "Customizable Attribute displayed name"
},
"tooltip": {
"type": "string",
"description": "Customizable Attribute tooltip"
},
"placeholder": {
"type": "string",
"description": "Customizable Attribute placeholder"
},
"multi": {
"type": "boolean",
"description": "Customizable Attribute multi activated ?"
},
"text_size": {
"type": "integer",
"format": "int32",
"description": "Customizable Attribute text_size"
},
"visibility": {
"type": "string",
"enum": [
"admin_only",
"tagged_user",
"everybody",
"not_visible"
],
"description": "Customizable Attribute visibility"
},
"user_editable": {
"type": "boolean",
"description": "Customizable Attribute editable by the user ?"
},
"required": {
"type": "boolean",
"description": "Customizable Attribute required ?"
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "Customizable Attribute array of options"
},
"json_options": {
"type": "object",
"description": "Customizable Attribute json options (for double select)"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Customizable Attribute creation date"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Customizable Attribute last update date"
},
"selected_value": {
"type": "string",
"description": "Customizable Attribute selected value"
}
},
"description": "CustomizableAttribute model"
}Create a new customizable attributePOST/api/admin/v3/mentoring/customizable_attributes
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"}.
GET /api/admin/v3/mentoring/customizable_attributes?page=&per_page=&program_id=
Responses
List of customizable attributes
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"customizable_id": {
"type": "integer",
"format": "int32",
"description": "Customizable ID"
},
"type": {
"type": "string",
"enum": [
"CustomizableAttribute::Boolean",
"CustomizableAttribute::Date",
"CustomizableAttribute::DoubleSelect",
"CustomizableAttribute::Number",
"CustomizableAttribute::Select",
"CustomizableAttribute::Text"
],
"description": "Customizable Attribute type"
},
"customizable_type": {
"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",
"mentorships",
"mentorships_mentee",
"mentorships_mentor",
"ne_event",
"ne_ticket",
"topic_approval",
"topic_mentorships",
"topic_mentorships_mentee",
"topic_mentorships_mentor",
"user",
"ventures_venture"
],
"description": "Customizable Attribute associated model (User, Experience)"
},
"name": {
"type": "string",
"description": "Customizable Attribute name"
},
"display_name": {
"type": "string",
"description": "Customizable Attribute displayed name"
},
"tooltip": {
"type": "string",
"description": "Customizable Attribute tooltip"
},
"placeholder": {
"type": "string",
"description": "Customizable Attribute placeholder"
},
"multi": {
"type": "boolean",
"description": "Customizable Attribute multi activated ?"
},
"text_size": {
"type": "integer",
"format": "int32",
"description": "Customizable Attribute text_size"
},
"visibility": {
"type": "string",
"enum": [
"admin_only",
"tagged_user",
"everybody",
"not_visible"
],
"description": "Customizable Attribute visibility"
},
"user_editable": {
"type": "boolean",
"description": "Customizable Attribute editable by the user ?"
},
"required": {
"type": "boolean",
"description": "Customizable Attribute required ?"
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "Customizable Attribute array of options"
},
"json_options": {
"type": "object",
"description": "Customizable Attribute json options (for double select)"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Customizable Attribute creation date"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Customizable Attribute last update date"
},
"selected_value": {
"type": "string",
"description": "Customizable Attribute selected value"
}
},
"description": "CustomizableAttribute model"
}List of customizable attributesGET/api/admin/v3/mentoring/customizable_attributes{?page,per_page,program_id}
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.
URI Parameters
- page
string(required)Page of results to fetch.
- per_page
string(required)Number of results to return per page.
- program_id
number(required)ID of the program
PUT /api/admin/v3/mentoring/customizable_attributes/id
Requests
Body
{
"program_id": 1,
"customizable_attribute[display_name]": "Hello, world!",
"customizable_attribute[required]": true,
"customizable_attribute[placeholder]": "Hello, world!",
"customizable_attribute[tooltip]": "Hello, world!",
"customizable_attribute[config][is_displayed_in_mentoring_card]": true,
"customizable_attribute[config][is_displayed_in_mentoring_form]": true,
"customizable_attribute[config][is_displayed_in_search_filterslti]": true,
"customizable_attribute[text_size]": 1,
"customizable_attribute[options][]": [],
"customizable_attribute[multi]": true,
"customizable_attribute[json_options]": "Hello, world!"
}Schema
{
"type": "object",
"properties": {
"program_id": {
"type": "number",
"description": "ID of the program"
},
"customizable_attribute[display_name]": {
"type": "string",
"description": "Name of the label"
},
"customizable_attribute[required]": {
"type": "boolean",
"description": "Whether the customizable attribute is required or not"
},
"customizable_attribute[placeholder]": {
"type": "string",
"description": "Placeholder for the customizable attribute"
},
"customizable_attribute[tooltip]": {
"type": "string",
"description": "Tooltip for the customizable attribute"
},
"customizable_attribute[config][is_displayed_in_mentoring_card]": {
"type": "boolean",
"description": "Whether the customizable attribute is displayed in the mentoring card"
},
"customizable_attribute[config][is_displayed_in_mentoring_form]": {
"type": "boolean",
"description": "Whether the customizable attribute is displayed in the mentoring form"
},
"customizable_attribute[config][is_displayed_in_search_filterslti]": {
"type": "boolean",
"description": "For Select customizable attribute. Whether the customizable attribute is displayed in the search filters"
},
"customizable_attribute[text_size]": {
"type": "number",
"description": "For Text customizable attribute, the size of the text"
},
"customizable_attribute[options][]": {
"type": "array",
"description": "For Select customizable attribute, the array of options\n\n+"
},
"customizable_attribute[multi]": {
"type": "boolean",
"description": "For Select customizable attribute, whether it is multi select or not"
},
"customizable_attribute[json_options]": {
"type": "string",
"description": "For DoubleSelect customizable attribute, the json options"
}
},
"required": [
"program_id"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Update information of a specific customizable attribute
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"customizable_id": {
"type": "integer",
"format": "int32",
"description": "Customizable ID"
},
"type": {
"type": "string",
"enum": [
"CustomizableAttribute::Boolean",
"CustomizableAttribute::Date",
"CustomizableAttribute::DoubleSelect",
"CustomizableAttribute::Number",
"CustomizableAttribute::Select",
"CustomizableAttribute::Text"
],
"description": "Customizable Attribute type"
},
"customizable_type": {
"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",
"mentorships",
"mentorships_mentee",
"mentorships_mentor",
"ne_event",
"ne_ticket",
"topic_approval",
"topic_mentorships",
"topic_mentorships_mentee",
"topic_mentorships_mentor",
"user",
"ventures_venture"
],
"description": "Customizable Attribute associated model (User, Experience)"
},
"name": {
"type": "string",
"description": "Customizable Attribute name"
},
"display_name": {
"type": "string",
"description": "Customizable Attribute displayed name"
},
"tooltip": {
"type": "string",
"description": "Customizable Attribute tooltip"
},
"placeholder": {
"type": "string",
"description": "Customizable Attribute placeholder"
},
"multi": {
"type": "boolean",
"description": "Customizable Attribute multi activated ?"
},
"text_size": {
"type": "integer",
"format": "int32",
"description": "Customizable Attribute text_size"
},
"visibility": {
"type": "string",
"enum": [
"admin_only",
"tagged_user",
"everybody",
"not_visible"
],
"description": "Customizable Attribute visibility"
},
"user_editable": {
"type": "boolean",
"description": "Customizable Attribute editable by the user ?"
},
"required": {
"type": "boolean",
"description": "Customizable Attribute required ?"
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "Customizable Attribute array of options"
},
"json_options": {
"type": "object",
"description": "Customizable Attribute json options (for double select)"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Customizable Attribute creation date"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Customizable Attribute last update date"
},
"selected_value": {
"type": "string",
"description": "Customizable Attribute selected value"
}
},
"description": "CustomizableAttribute model"
}Update information of a specific customizable attributePUT/api/admin/v3/mentoring/customizable_attributes/{id}
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"}.
URI Parameters
- id
number(required)ID of the customizable attribute
DELETE /api/admin/v3/mentoring/customizable_attributes/id?program_id=
Responses
Delete a customizable attribute
Delete a customizable attributeDELETE/api/admin/v3/mentoring/customizable_attributes/{id}{?program_id}
Required parameters are:
id: ID of the customizable attribute.program_id: ID of the program.
URI Parameters
- id
number(required)ID of the customizable attribute
- program_id
number(required)ID of the program
order_management ¶
Operations about order_managements
POST /api/admin/v3/order_management/manual_transaction
Requests
Body
{
"manual_transaction[subscription_id]": 1,
"manual_transaction[price]": 1,
"manual_transaction[payment_method_type]": "Hello, world!",
"manual_transaction[currency_id]": 1,
"manual_transaction[notes]": "Hello, world!",
"manual_transaction[date]": "Hello, world!"
}Schema
{
"type": "object",
"properties": {
"manual_transaction[subscription_id]": {
"type": "number"
},
"manual_transaction[price]": {
"type": "number"
},
"manual_transaction[payment_method_type]": {
"type": "string"
},
"manual_transaction[currency_id]": {
"type": "number"
},
"manual_transaction[notes]": {
"type": "string"
},
"manual_transaction[date]": {
"type": "string"
}
},
"required": [
"manual_transaction[subscription_id]",
"manual_transaction[price]",
"manual_transaction[payment_method_type]",
"manual_transaction[currency_id]"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Manual Transaction Creation
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Manual Transaction ID"
},
"total_in_cents": {
"type": "integer",
"format": "int32",
"description": "Manual Transaction price in cents"
},
"notes": {
"type": "string",
"description": "Manual Transaction notes"
},
"status": {
"type": "string",
"description": "Manual Transaction status"
},
"currency": {
"type": "string",
"description": "ISO code of the Currency of the Manual Transaction"
},
"parent": {
"description": "Parent membership subscription",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Parent ID"
},
"type": {
"type": "string",
"description": "Parent type"
}
}
},
"date": {
"type": "string",
"format": "date-time",
"description": "Manual Transaction date - iso8601"
},
"payment_method_type": {
"type": "string",
"description": "Manual Transaction payment method"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Manual Transaction creation date - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Manual Transaction date of last update - iso8601"
}
},
"description": "Admin_V3_OrderManagement_ManualTransactionEntity model"
}Manual Transaction CreationPOST/api/admin/v3/order_management/manual_transaction
Create a new Manual Transaction
Required parameters are :
Subscription Id,
price,
payment_method_type,
currency_id,
PUT /api/admin/v3/order_management/manual_transaction/id
Requests
Body
{
"manual_transaction[manual_transaction_id]": 1,
"manual_transaction[price]": 1,
"manual_transaction[payment_method_type]": "Hello, world!",
"manual_transaction[currency_id]": 1,
"manual_transaction[notes]": "Hello, world!",
"manual_transaction[date]": "Hello, world!"
}Schema
{
"type": "object",
"properties": {
"manual_transaction[manual_transaction_id]": {
"type": "number"
},
"manual_transaction[price]": {
"type": "number"
},
"manual_transaction[payment_method_type]": {
"type": "string"
},
"manual_transaction[currency_id]": {
"type": "number"
},
"manual_transaction[notes]": {
"type": "string"
},
"manual_transaction[date]": {
"type": "string"
}
},
"required": [
"manual_transaction[manual_transaction_id]"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Manual Transaction Update
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Manual Transaction ID"
},
"total_in_cents": {
"type": "integer",
"format": "int32",
"description": "Manual Transaction price in cents"
},
"notes": {
"type": "string",
"description": "Manual Transaction notes"
},
"status": {
"type": "string",
"description": "Manual Transaction status"
},
"currency": {
"type": "string",
"description": "ISO code of the Currency of the Manual Transaction"
},
"parent": {
"description": "Parent membership subscription",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Parent ID"
},
"type": {
"type": "string",
"description": "Parent type"
}
}
},
"date": {
"type": "string",
"format": "date-time",
"description": "Manual Transaction date - iso8601"
},
"payment_method_type": {
"type": "string",
"description": "Manual Transaction payment method"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Manual Transaction creation date - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Manual Transaction date of last update - iso8601"
}
},
"description": "Admin_V3_OrderManagement_ManualTransactionEntity model"
}Manual Transaction UpdatePUT/api/admin/v3/order_management/manual_transaction/{id}
Update a Manual Transaction
Required parameters are :
- Manual Transaction Id
URI Parameters
- id
number(required)
DELETE /api/admin/v3/order_management/manual_transaction/id?manual_transaction_id=
Responses
Manual Transaction Deletion
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Manual Transaction ID"
},
"total_in_cents": {
"type": "integer",
"format": "int32",
"description": "Manual Transaction price in cents"
},
"notes": {
"type": "string",
"description": "Manual Transaction notes"
},
"status": {
"type": "string",
"description": "Manual Transaction status"
},
"currency": {
"type": "string",
"description": "ISO code of the Currency of the Manual Transaction"
},
"parent": {
"description": "Parent membership subscription",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Parent ID"
},
"type": {
"type": "string",
"description": "Parent type"
}
}
},
"date": {
"type": "string",
"format": "date-time",
"description": "Manual Transaction date - iso8601"
},
"payment_method_type": {
"type": "string",
"description": "Manual Transaction payment method"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Manual Transaction creation date - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Manual Transaction date of last update - iso8601"
}
},
"description": "Admin_V3_OrderManagement_ManualTransactionEntity model"
}Manual Transaction DeletionDELETE/api/admin/v3/order_management/manual_transaction/{id}{?manual_transaction_id}
Destroy a Manual Transaction
Required parameters are :
- Manual Transaction Id,
URI Parameters
- id
number(required)- manual_transaction_id
number(required)
email_analytics_v2 ¶
Operations about email_analytics_v2s
GET /api/admin/v3/email_analytics_v2/deliveries
Responses
List of Email Analytics Deliveries v2
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "ID of the Email Analytics Delivery"
},
"email": {
"type": "string",
"description": "Email Analytics Deliver email."
},
"user_type": {
"type": "integer",
"format": "int32",
"description": "Email Analytics Delivery User Type. Can be User, Admin, or null (external email)"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "Email Analytics Delivery User ID."
},
"subject": {
"type": "string",
"description": "Email Analytics Delivery Subject of the email campaign."
},
"campaign_id": {
"type": "integer",
"format": "int32",
"description": "Email Analytics Delivery Campaign ID. ID of the email campaign associated to the delivery."
},
"sent_at": {
"type": "string",
"format": "date-time",
"description": "Email Analytics Delivery sent at. Time at which the delivery was sent (iso8601)."
},
"delivered_at": {
"type": "string",
"format": "date-time",
"description": "Email Analytics Delivery delivered at. Time at which the delivery was delivered (iso8601)."
},
"opened_at": {
"type": "string",
"format": "date-time",
"description": "Email Analytics Delivery opened at. Time at which the delivery was opened (iso8601)."
},
"clicked_at": {
"type": "string",
"format": "date-time",
"description": "Email Analytics Delivery clicked at. Time at which the delivery was clicked (iso8601)."
},
"bounced_at": {
"type": "string",
"format": "date-time",
"description": "Email Analytics Delivery bounced at. Time at which the delivery was bounced (iso8601)."
},
"dropped_at": {
"type": "string",
"format": "date-time",
"description": "Email Analytics Delivery dropped at. Time at which the delivery was dropped (iso8601)."
},
"spam_reported_at": {
"type": "string",
"format": "date-time",
"description": "Email Analytics Delivery spam_reported at. Time at which the delivery was spam_reported (iso8601)."
}
},
"description": "Admin_V3_EmailAnalyticsV2_DeliveryEntity model"
}List of Email Analytics Deliveries v2GET/api/admin/v3/email_analytics_v2/deliveries
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)
URI Parameters
- start_date
string(required)- end_date
string(required)- user_id
string(required)- page
string(required)- per_page
string(required)string(required)- user_type
string(required)- subject
string(required)- campaign_id
string(required)- status
string(required)
forums ¶
Operations about forums
POST /api/admin/v3/forums/discussions
Requests
Body
{
"user_id": 1,
"title": "Hello, world!",
"content": "Hello, world!",
"pinned_on_index_page": true,
"cover_picture": "Hello, world!",
"storage_attachments[]": [],
"category_ids[]": [],
"topic_id": 1,
"feedable_at": "Hello, world!",
"embed_options[embed_likes]": true,
"embed_options[embed_comments]": true,
"embed_options[embed_user]": true,
"embed_options[embed_stripped_content]": true,
"embed_options[embed_categories]": true,
"embed_options[embed_attachments]": true
}Schema
{
"type": "object",
"properties": {
"user_id": {
"type": "number",
"description": "User ID"
},
"title": {
"type": "string",
"description": "Title of the discussion"
},
"content": {
"type": "string",
"description": "HTML content of the discussion"
},
"pinned_on_index_page": {
"type": "boolean",
"description": "Whether or not the discussion should be pinned on the index page"
},
"cover_picture": {
"type": "string",
"description": "Direct upload of the picture which will serve as a cover for the discussion"
},
"storage_attachments[]": {
"type": "array",
"description": "Direct upload of several files which will be attached to the discussion\n\n+"
},
"category_ids[]": {
"type": "array",
"description": "List of category IDs\n\n+"
},
"topic_id": {
"type": "number",
"description": "ID of the related group if it's not a network discussion"
},
"feedable_at": {
"type": "string",
"description": "Datetime of the publication"
},
"embed_options[embed_likes]": {
"type": "boolean"
},
"embed_options[embed_comments]": {
"type": "boolean"
},
"embed_options[embed_user]": {
"type": "boolean"
},
"embed_options[embed_stripped_content]": {
"type": "boolean"
},
"embed_options[embed_categories]": {
"type": "boolean"
},
"embed_options[embed_attachments]": {
"type": "boolean"
}
},
"required": [
"user_id",
"title",
"content"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Create a new forum discussion
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique identifier for each notification record in the database."
},
"title": {
"type": "string",
"description": "Title of the discussion"
},
"content": {
"type": "string",
"description": "HTML content of the discussion"
},
"pinned_on_index_page": {
"type": "boolean",
"description": "Whether the discussion is pinned on the index page or not"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Date and time when the discussion was created"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Date and time when the discussion was last updated"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "ID of the User who created the discussion"
},
"feedable_at": {
"type": "string",
"format": "date-time",
"description": "Date and time when the discussion will be published"
},
"categories": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"name": {
"type": "string",
"description": "Name of the category"
}
},
"description": "NetworkCategoryCompact model"
},
"description": "Array of the related categories"
},
"comments_count": {
"type": "integer",
"format": "int32",
"description": "The number of comments"
},
"likes_count": {
"type": "integer",
"format": "int32",
"description": "The number of likes"
},
"cover_picture_url": {
"type": "string",
"description": "URL of the cover picture for the discussion"
},
"storage_attachments": {
"type": "string",
"description": "A string containing files attached to the discussion"
},
"storage_uploads": {
"type": "string",
"description": "A string containing files uploaded within the content of the discussion"
},
"user": {
"description": "More information about the user who created the discussion",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"email": {
"type": "string",
"description": "User email"
},
"name": {
"type": "string",
"description": "User full name"
},
"sub_network_ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": "IDs list of user sub networks"
},
"extended_updated_at": {
"type": "string",
"format": "date-time",
"description": "User full profile ( with experiences, educations, customs) last update date time - iso8601"
},
"likeable_type": {
"type": "string",
"description": "Type to use on API query"
},
"current_user_like_id": {
"type": "integer",
"format": "int32",
"description": "Like ID of the current_user if they like the Likeable"
},
"likes_count": {
"type": "integer",
"format": "int32",
"description": "Total count of likes on this Likeable"
},
"commentable_type": {
"type": "string",
"description": "Type to use on API query"
},
"comments_count": {
"type": "string",
"description": "Total count of comment for this Commentable"
},
"email2": {
"type": "string",
"description": "User secondary email"
},
"email3": {
"type": "string",
"description": "User complementary email"
},
"primary_email_choice": {
"type": "string",
"enum": [
"email",
"email2",
"email3"
],
"description": "User primary email choice"
},
"firstname": {
"type": "string",
"description": "User first name"
},
"lastname": {
"type": "string",
"description": "User last name"
},
"maidenname": {
"type": "string",
"description": "User maiden name"
},
"prefix_firstname": {
"type": "string",
"description": "User prefix firstname"
},
"prefix_name": {
"type": "string",
"description": "User prefix name"
},
"suffix_name": {
"type": "string",
"description": "User suffix name"
},
"external_id": {
"type": "string",
"description": "User ID in your database"
},
"sso_identifier": {
"type": "string",
"description": "User identifier for SSO"
},
"previous_id": {
"type": "string",
"description": "User ID in your community system"
},
"last_visited_at": {
"type": "string",
"format": "date-time",
"description": "Date of last visit - iso8601. READ only, can't be updated"
},
"sign_in_count": {
"type": "string",
"description": "Number of platform visits. READ only, can't be updated"
},
"is_active": {
"type": "boolean",
"description": "User account enabled ?"
},
"gender": {
"type": "string",
"enum": [
"male",
"female",
"other"
],
"description": "User gender (male/female/other)"
},
"birthday": {
"type": "string",
"format": "date",
"description": "User birth date"
},
"birthplace": {
"type": "string",
"description": "User birth place"
},
"headline": {
"type": "string",
"description": "User headline"
},
"summary": {
"type": "string",
"description": "User summary"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "User creation date time - iso8601. READ only, can't be updated"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "User last update date time - iso8601. READ only, can't be updated"
},
"confirmed_at": {
"type": "string",
"format": "date-time",
"description": "User activation date time - iso8601. READ only, can't be updated"
},
"citizenship_ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": "List of citizenship IDs"
},
"citizenship_country_codes": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of ISO-3166-2 citizenship country codes"
},
"deceased": {
"type": "boolean",
"description": "User deceased ?"
},
"deceased_at": {
"type": "string",
"format": "date-time",
"description": "User decease date time - iso8601."
},
"photo": {
"type": "object",
"properties": {
"compressed-url": {
"type": "string",
"description": "User compressed photo url"
},
"large-url": {
"type": "string",
"description": "User large photo url"
},
"medium-url": {
"type": "string",
"description": "User medium photo url"
},
"thumb-url": {
"type": "string",
"description": "User thumb photo url"
},
"mini-url": {
"type": "string",
"description": "User mini photo url"
},
"friend-url": {
"type": "string",
"description": "User friend photo url"
},
"icon-url": {
"type": "string",
"description": "User icon photo url"
}
},
"description": "User photo urls"
},
"do_not_contact": {
"type": "boolean",
"description": "User can be contacted ?"
},
"mobile_perso": {
"type": "string",
"description": "User mobile perso number"
},
"mobile_pro": {
"type": "string",
"description": "User mobile pro number"
},
"landline_perso": {
"type": "string",
"description": "User landline perso number"
},
"landline_pro": {
"type": "string",
"description": "User landline pro number"
},
"preferred_phone_number": {
"type": "string",
"enum": [
"mobile_pro",
"mobile_perso",
"landline_pro",
"landline_perso",
"none"
],
"description": "User preferred phone number"
},
"postal_personal": {
"description": "User personal postal address",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"address_1": {
"type": "string",
"description": "Address line 1"
},
"address_2": {
"type": "string",
"description": "Address line 2"
},
"address_3": {
"type": "string",
"description": "Address line 3"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "State"
},
"full_name": {
"type": "string",
"description": "Full name"
},
"postal_code": {
"type": "string",
"description": "Zip code"
},
"country": {
"type": "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"
],
"description": "Country"
},
"default_billing_address": {
"type": "boolean",
"description": "is the default billing address for the user ?"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Postal address creation date time - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Postal address last update date time - iso8601"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "User ID linked to postal address"
}
}
},
"postal_work": {
"description": "User work postal address",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"address_1": {
"type": "string",
"description": "Address line 1"
},
"address_2": {
"type": "string",
"description": "Address line 2"
},
"address_3": {
"type": "string",
"description": "Address line 3"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "State"
},
"full_name": {
"type": "string",
"description": "Full name"
},
"postal_code": {
"type": "string",
"description": "Zip code"
},
"country": {
"type": "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"
],
"description": "Country"
},
"default_billing_address": {
"type": "boolean",
"description": "is the default billing address for the user ?"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Postal address creation date time - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Postal address last update date time - iso8601"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "User ID linked to postal address"
}
}
},
"preferred_postal_address": {
"type": "string",
"enum": [
"postal_personal",
"postal_work"
],
"description": "User preferred postal address"
},
"config": {
"description": "User specific configuration",
"type": "object",
"properties": {
"private_profile": {
"type": "boolean",
"description": "Unique ID"
},
"opt_out_of_directory": {
"type": "boolean",
"description": "Unique ID"
},
"opt_out_of_group_directories": {
"type": "array",
"items": {
"type": "object"
},
"description": "Unique ID"
},
"opt_out_of_messaging": {
"type": "boolean",
"description": "Opt out of messaging"
},
"share_gender": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of gender"
},
"share_prefix_firstname": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of prefix_firstname"
},
"share_honorary_title": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of honorary_title"
},
"share_prefix_name": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of prefix_name"
},
"share_suffix_name": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of suffix_name"
},
"share_maidenname": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of maidenname"
},
"share_birthday": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of birthday"
},
"share_birthplace": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of birthplace"
},
"share_headline": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of headline"
},
"share_live_location": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of live_location"
},
"share_sub_networks": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of sub_networks"
},
"share_nationalities": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of nationalities"
},
"share_resume": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of resume"
},
"share_summary": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of summary"
},
"share_industries": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of industries"
},
"share_skills": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of skills"
},
"share_facebook_profile_url": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of facebook_profile_url"
},
"share_instagram_profile_url": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of instagram_profile_url"
},
"share_twitter": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of twitter"
},
"share_skype": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of skype"
},
"share_linkedin_profile_url": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of linkedin_profile_url"
},
"share_website": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of website"
},
"share_bbm": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of bbm"
},
"share_email": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of email"
},
"share_email2": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of email2"
},
"share_email3": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of email3"
},
"share_mobile_perso": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of mobile_perso"
},
"share_landline_perso": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of landline_perso"
},
"share_mobile_pro": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of mobile_pro"
},
"share_landline_pro": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of landline_pro"
},
"share_postal_personal": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of postal_personal"
},
"share_postal_work": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of postal_work"
},
"share_memberships": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of memberships"
},
"share_educations": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of educations"
},
"share_experiences": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of experiences"
}
}
},
"role_id": {
"type": "integer",
"format": "int32",
"description": "User role ID"
},
"awards": {
"type": "string",
"description": "User awards"
},
"linkedin_profile_url": {
"type": "string",
"description": "User linkedin profile URL"
},
"website": {
"type": "string",
"description": "User Website URL"
},
"skype": {
"type": "string",
"description": "User skype profile"
},
"bbm": {
"type": "string",
"description": "User BlackBerry Messenger profile"
},
"twitter": {
"type": "string",
"description": "User twitter profile"
},
"timezone": {
"type": "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"
],
"description": "User timezone"
},
"facebook_profile_url": {
"type": "string",
"description": "User facebook profile URL"
},
"instagram_profile_url": {
"type": "string",
"description": "User instagram profile URL"
},
"honorary_title": {
"type": "string",
"enum": [
"mr",
"mrs",
"ms",
"dr",
"prof"
],
"description": "User's honorary title"
},
"live_location": {
"description": "User's current location.",
"type": "object",
"properties": {
"city": {
"type": "string",
"description": "City"
},
"country": {
"type": "string",
"description": "Country"
},
"country_code": {
"type": "string",
"description": "ISO3166-2 Country code"
},
"address": {
"type": "string",
"description": "Address"
},
"lat": {
"type": "number",
"format": "float",
"description": "Latitude"
},
"lng": {
"type": "number",
"format": "float",
"description": "Longitude"
}
}
},
"resume": {
"type": "string",
"description": "URL link to the user's resume. This link will be expired if you do not open it in the 60 sec after your request. Another request will be needed"
},
"locale": {
"type": "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"
],
"description": "User Locale"
},
"share_email": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding email"
},
"share_email2": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding secondary email"
},
"share_email3": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding complementary email"
},
"share_postal_address_personal": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding postal home location"
},
"share_postal_address_work": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding postal work location"
},
"share_nationalities": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding nationalities"
},
"share_resume": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding resume"
},
"share_mobile_pro": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding work mobile phone"
},
"share_mobile_perso": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding personal mobile phone"
},
"share_landline_pro": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding professional landline phone"
},
"share_landline_perso": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding personal landline phone"
},
"skills": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"name": {
"type": "string",
"description": "Skill name"
}
}
},
"description": "READ ONLY, list of user skills"
},
"custom_attributes": {
"type": "array",
"items": {
"type": "object"
},
"description": "Array of customizable attributes with name, value and type"
}
}
}
},
"description": "Admin_V3_Forums_DiscussionEntity model"
}Unprocessable entity
Schema
{
"type": "object",
"properties": {
"status": {
"type": "integer",
"format": "int32",
"description": "Status Code"
},
"errors": {
"type": "string",
"description": "Errors list"
}
},
"description": "Error model"
}Create a new forum discussionPOST/api/admin/v3/forums/discussions
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
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.
GET /api/admin/v3/forums/discussions?topic_id=&page=&per_page=&sort_by=&order=&keyword=&pinned_on_index_page=
Responses
List forum discussions
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique identifier for each notification record in the database."
},
"title": {
"type": "string",
"description": "Title of the discussion"
},
"content": {
"type": "string",
"description": "HTML content of the discussion"
},
"pinned_on_index_page": {
"type": "boolean",
"description": "Whether the discussion is pinned on the index page or not"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Date and time when the discussion was created"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Date and time when the discussion was last updated"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "ID of the User who created the discussion"
},
"feedable_at": {
"type": "string",
"format": "date-time",
"description": "Date and time when the discussion will be published"
},
"categories": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"name": {
"type": "string",
"description": "Name of the category"
}
},
"description": "NetworkCategoryCompact model"
},
"description": "Array of the related categories"
},
"comments_count": {
"type": "integer",
"format": "int32",
"description": "The number of comments"
},
"likes_count": {
"type": "integer",
"format": "int32",
"description": "The number of likes"
},
"cover_picture_url": {
"type": "string",
"description": "URL of the cover picture for the discussion"
},
"storage_attachments": {
"type": "string",
"description": "A string containing files attached to the discussion"
},
"storage_uploads": {
"type": "string",
"description": "A string containing files uploaded within the content of the discussion"
},
"user": {
"description": "More information about the user who created the discussion",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"email": {
"type": "string",
"description": "User email"
},
"name": {
"type": "string",
"description": "User full name"
},
"sub_network_ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": "IDs list of user sub networks"
},
"extended_updated_at": {
"type": "string",
"format": "date-time",
"description": "User full profile ( with experiences, educations, customs) last update date time - iso8601"
},
"likeable_type": {
"type": "string",
"description": "Type to use on API query"
},
"current_user_like_id": {
"type": "integer",
"format": "int32",
"description": "Like ID of the current_user if they like the Likeable"
},
"likes_count": {
"type": "integer",
"format": "int32",
"description": "Total count of likes on this Likeable"
},
"commentable_type": {
"type": "string",
"description": "Type to use on API query"
},
"comments_count": {
"type": "string",
"description": "Total count of comment for this Commentable"
},
"email2": {
"type": "string",
"description": "User secondary email"
},
"email3": {
"type": "string",
"description": "User complementary email"
},
"primary_email_choice": {
"type": "string",
"enum": [
"email",
"email2",
"email3"
],
"description": "User primary email choice"
},
"firstname": {
"type": "string",
"description": "User first name"
},
"lastname": {
"type": "string",
"description": "User last name"
},
"maidenname": {
"type": "string",
"description": "User maiden name"
},
"prefix_firstname": {
"type": "string",
"description": "User prefix firstname"
},
"prefix_name": {
"type": "string",
"description": "User prefix name"
},
"suffix_name": {
"type": "string",
"description": "User suffix name"
},
"external_id": {
"type": "string",
"description": "User ID in your database"
},
"sso_identifier": {
"type": "string",
"description": "User identifier for SSO"
},
"previous_id": {
"type": "string",
"description": "User ID in your community system"
},
"last_visited_at": {
"type": "string",
"format": "date-time",
"description": "Date of last visit - iso8601. READ only, can't be updated"
},
"sign_in_count": {
"type": "string",
"description": "Number of platform visits. READ only, can't be updated"
},
"is_active": {
"type": "boolean",
"description": "User account enabled ?"
},
"gender": {
"type": "string",
"enum": [
"male",
"female",
"other"
],
"description": "User gender (male/female/other)"
},
"birthday": {
"type": "string",
"format": "date",
"description": "User birth date"
},
"birthplace": {
"type": "string",
"description": "User birth place"
},
"headline": {
"type": "string",
"description": "User headline"
},
"summary": {
"type": "string",
"description": "User summary"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "User creation date time - iso8601. READ only, can't be updated"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "User last update date time - iso8601. READ only, can't be updated"
},
"confirmed_at": {
"type": "string",
"format": "date-time",
"description": "User activation date time - iso8601. READ only, can't be updated"
},
"citizenship_ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": "List of citizenship IDs"
},
"citizenship_country_codes": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of ISO-3166-2 citizenship country codes"
},
"deceased": {
"type": "boolean",
"description": "User deceased ?"
},
"deceased_at": {
"type": "string",
"format": "date-time",
"description": "User decease date time - iso8601."
},
"photo": {
"type": "object",
"properties": {
"compressed-url": {
"type": "string",
"description": "User compressed photo url"
},
"large-url": {
"type": "string",
"description": "User large photo url"
},
"medium-url": {
"type": "string",
"description": "User medium photo url"
},
"thumb-url": {
"type": "string",
"description": "User thumb photo url"
},
"mini-url": {
"type": "string",
"description": "User mini photo url"
},
"friend-url": {
"type": "string",
"description": "User friend photo url"
},
"icon-url": {
"type": "string",
"description": "User icon photo url"
}
},
"description": "User photo urls"
},
"do_not_contact": {
"type": "boolean",
"description": "User can be contacted ?"
},
"mobile_perso": {
"type": "string",
"description": "User mobile perso number"
},
"mobile_pro": {
"type": "string",
"description": "User mobile pro number"
},
"landline_perso": {
"type": "string",
"description": "User landline perso number"
},
"landline_pro": {
"type": "string",
"description": "User landline pro number"
},
"preferred_phone_number": {
"type": "string",
"enum": [
"mobile_pro",
"mobile_perso",
"landline_pro",
"landline_perso",
"none"
],
"description": "User preferred phone number"
},
"postal_personal": {
"description": "User personal postal address",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"address_1": {
"type": "string",
"description": "Address line 1"
},
"address_2": {
"type": "string",
"description": "Address line 2"
},
"address_3": {
"type": "string",
"description": "Address line 3"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "State"
},
"full_name": {
"type": "string",
"description": "Full name"
},
"postal_code": {
"type": "string",
"description": "Zip code"
},
"country": {
"type": "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"
],
"description": "Country"
},
"default_billing_address": {
"type": "boolean",
"description": "is the default billing address for the user ?"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Postal address creation date time - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Postal address last update date time - iso8601"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "User ID linked to postal address"
}
}
},
"postal_work": {
"description": "User work postal address",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"address_1": {
"type": "string",
"description": "Address line 1"
},
"address_2": {
"type": "string",
"description": "Address line 2"
},
"address_3": {
"type": "string",
"description": "Address line 3"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "State"
},
"full_name": {
"type": "string",
"description": "Full name"
},
"postal_code": {
"type": "string",
"description": "Zip code"
},
"country": {
"type": "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"
],
"description": "Country"
},
"default_billing_address": {
"type": "boolean",
"description": "is the default billing address for the user ?"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Postal address creation date time - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Postal address last update date time - iso8601"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "User ID linked to postal address"
}
}
},
"preferred_postal_address": {
"type": "string",
"enum": [
"postal_personal",
"postal_work"
],
"description": "User preferred postal address"
},
"config": {
"description": "User specific configuration",
"type": "object",
"properties": {
"private_profile": {
"type": "boolean",
"description": "Unique ID"
},
"opt_out_of_directory": {
"type": "boolean",
"description": "Unique ID"
},
"opt_out_of_group_directories": {
"type": "array",
"items": {
"type": "object"
},
"description": "Unique ID"
},
"opt_out_of_messaging": {
"type": "boolean",
"description": "Opt out of messaging"
},
"share_gender": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of gender"
},
"share_prefix_firstname": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of prefix_firstname"
},
"share_honorary_title": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of honorary_title"
},
"share_prefix_name": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of prefix_name"
},
"share_suffix_name": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of suffix_name"
},
"share_maidenname": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of maidenname"
},
"share_birthday": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of birthday"
},
"share_birthplace": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of birthplace"
},
"share_headline": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of headline"
},
"share_live_location": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of live_location"
},
"share_sub_networks": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of sub_networks"
},
"share_nationalities": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of nationalities"
},
"share_resume": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of resume"
},
"share_summary": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of summary"
},
"share_industries": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of industries"
},
"share_skills": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of skills"
},
"share_facebook_profile_url": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of facebook_profile_url"
},
"share_instagram_profile_url": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of instagram_profile_url"
},
"share_twitter": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of twitter"
},
"share_skype": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of skype"
},
"share_linkedin_profile_url": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of linkedin_profile_url"
},
"share_website": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of website"
},
"share_bbm": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of bbm"
},
"share_email": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of email"
},
"share_email2": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of email2"
},
"share_email3": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of email3"
},
"share_mobile_perso": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of mobile_perso"
},
"share_landline_perso": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of landline_perso"
},
"share_mobile_pro": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of mobile_pro"
},
"share_landline_pro": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of landline_pro"
},
"share_postal_personal": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of postal_personal"
},
"share_postal_work": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of postal_work"
},
"share_memberships": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of memberships"
},
"share_educations": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of educations"
},
"share_experiences": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of experiences"
}
}
},
"role_id": {
"type": "integer",
"format": "int32",
"description": "User role ID"
},
"awards": {
"type": "string",
"description": "User awards"
},
"linkedin_profile_url": {
"type": "string",
"description": "User linkedin profile URL"
},
"website": {
"type": "string",
"description": "User Website URL"
},
"skype": {
"type": "string",
"description": "User skype profile"
},
"bbm": {
"type": "string",
"description": "User BlackBerry Messenger profile"
},
"twitter": {
"type": "string",
"description": "User twitter profile"
},
"timezone": {
"type": "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"
],
"description": "User timezone"
},
"facebook_profile_url": {
"type": "string",
"description": "User facebook profile URL"
},
"instagram_profile_url": {
"type": "string",
"description": "User instagram profile URL"
},
"honorary_title": {
"type": "string",
"enum": [
"mr",
"mrs",
"ms",
"dr",
"prof"
],
"description": "User's honorary title"
},
"live_location": {
"description": "User's current location.",
"type": "object",
"properties": {
"city": {
"type": "string",
"description": "City"
},
"country": {
"type": "string",
"description": "Country"
},
"country_code": {
"type": "string",
"description": "ISO3166-2 Country code"
},
"address": {
"type": "string",
"description": "Address"
},
"lat": {
"type": "number",
"format": "float",
"description": "Latitude"
},
"lng": {
"type": "number",
"format": "float",
"description": "Longitude"
}
}
},
"resume": {
"type": "string",
"description": "URL link to the user's resume. This link will be expired if you do not open it in the 60 sec after your request. Another request will be needed"
},
"locale": {
"type": "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"
],
"description": "User Locale"
},
"share_email": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding email"
},
"share_email2": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding secondary email"
},
"share_email3": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding complementary email"
},
"share_postal_address_personal": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding postal home location"
},
"share_postal_address_work": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding postal work location"
},
"share_nationalities": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding nationalities"
},
"share_resume": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding resume"
},
"share_mobile_pro": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding work mobile phone"
},
"share_mobile_perso": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding personal mobile phone"
},
"share_landline_pro": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding professional landline phone"
},
"share_landline_perso": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding personal landline phone"
},
"skills": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"name": {
"type": "string",
"description": "Skill name"
}
}
},
"description": "READ ONLY, list of user skills"
},
"custom_attributes": {
"type": "array",
"items": {
"type": "object"
},
"description": "Array of customizable attributes with name, value and type"
}
}
}
},
"description": "Admin_V3_Forums_DiscussionEntity model"
}Unprocessable entity
Schema
{
"type": "object",
"properties": {
"status": {
"type": "integer",
"format": "int32",
"description": "Status Code"
},
"errors": {
"type": "string",
"description": "Errors list"
}
},
"description": "Error model"
}List forum discussionsGET/api/admin/v3/forums/discussions{?topic_id,page,per_page,sort_by,order,keyword,pinned_on_index_page}
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).
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.
URI Parameters
- topic_id
string(required)ID of the group
- page
string(required)Page number (default: 1)
- per_page
string(required)Results per page (default: 10)
- sort_by
string(required)Way to sort
- order
string(required)Direction to sort
- keyword
string(required)Keyword contained in the title or the content
- pinned_on_index_page
string(required)Whether the discussions are pinned on the index page or not
DELETE /api/admin/v3/forums/discussions/delete
Responses
Delete a forum discussion
Unprocessable entity
Schema
{
"type": "object",
"properties": {
"status": {
"type": "integer",
"format": "int32",
"description": "Status Code"
},
"errors": {
"type": "string",
"description": "Errors list"
}
},
"description": "Error model"
}Delete a forum discussionDELETE/api/admin/v3/forums/discussions/delete
This endpoint deletes a forum discussion.
Mandatory parameter
id, the ID of the discussion to delete
URI Parameters
- id
number(required)ID of the discussion to delete
GET /api/admin/v3/forums/discussions/id
Responses
Show a forum discussion
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique identifier for each notification record in the database."
},
"title": {
"type": "string",
"description": "Title of the discussion"
},
"content": {
"type": "string",
"description": "HTML content of the discussion"
},
"pinned_on_index_page": {
"type": "boolean",
"description": "Whether the discussion is pinned on the index page or not"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Date and time when the discussion was created"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Date and time when the discussion was last updated"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "ID of the User who created the discussion"
},
"feedable_at": {
"type": "string",
"format": "date-time",
"description": "Date and time when the discussion will be published"
},
"categories": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"name": {
"type": "string",
"description": "Name of the category"
}
},
"description": "NetworkCategoryCompact model"
},
"description": "Array of the related categories"
},
"comments_count": {
"type": "integer",
"format": "int32",
"description": "The number of comments"
},
"likes_count": {
"type": "integer",
"format": "int32",
"description": "The number of likes"
},
"cover_picture_url": {
"type": "string",
"description": "URL of the cover picture for the discussion"
},
"storage_attachments": {
"type": "string",
"description": "A string containing files attached to the discussion"
},
"storage_uploads": {
"type": "string",
"description": "A string containing files uploaded within the content of the discussion"
},
"user": {
"description": "More information about the user who created the discussion",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"email": {
"type": "string",
"description": "User email"
},
"name": {
"type": "string",
"description": "User full name"
},
"sub_network_ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": "IDs list of user sub networks"
},
"extended_updated_at": {
"type": "string",
"format": "date-time",
"description": "User full profile ( with experiences, educations, customs) last update date time - iso8601"
},
"likeable_type": {
"type": "string",
"description": "Type to use on API query"
},
"current_user_like_id": {
"type": "integer",
"format": "int32",
"description": "Like ID of the current_user if they like the Likeable"
},
"likes_count": {
"type": "integer",
"format": "int32",
"description": "Total count of likes on this Likeable"
},
"commentable_type": {
"type": "string",
"description": "Type to use on API query"
},
"comments_count": {
"type": "string",
"description": "Total count of comment for this Commentable"
},
"email2": {
"type": "string",
"description": "User secondary email"
},
"email3": {
"type": "string",
"description": "User complementary email"
},
"primary_email_choice": {
"type": "string",
"enum": [
"email",
"email2",
"email3"
],
"description": "User primary email choice"
},
"firstname": {
"type": "string",
"description": "User first name"
},
"lastname": {
"type": "string",
"description": "User last name"
},
"maidenname": {
"type": "string",
"description": "User maiden name"
},
"prefix_firstname": {
"type": "string",
"description": "User prefix firstname"
},
"prefix_name": {
"type": "string",
"description": "User prefix name"
},
"suffix_name": {
"type": "string",
"description": "User suffix name"
},
"external_id": {
"type": "string",
"description": "User ID in your database"
},
"sso_identifier": {
"type": "string",
"description": "User identifier for SSO"
},
"previous_id": {
"type": "string",
"description": "User ID in your community system"
},
"last_visited_at": {
"type": "string",
"format": "date-time",
"description": "Date of last visit - iso8601. READ only, can't be updated"
},
"sign_in_count": {
"type": "string",
"description": "Number of platform visits. READ only, can't be updated"
},
"is_active": {
"type": "boolean",
"description": "User account enabled ?"
},
"gender": {
"type": "string",
"enum": [
"male",
"female",
"other"
],
"description": "User gender (male/female/other)"
},
"birthday": {
"type": "string",
"format": "date",
"description": "User birth date"
},
"birthplace": {
"type": "string",
"description": "User birth place"
},
"headline": {
"type": "string",
"description": "User headline"
},
"summary": {
"type": "string",
"description": "User summary"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "User creation date time - iso8601. READ only, can't be updated"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "User last update date time - iso8601. READ only, can't be updated"
},
"confirmed_at": {
"type": "string",
"format": "date-time",
"description": "User activation date time - iso8601. READ only, can't be updated"
},
"citizenship_ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": "List of citizenship IDs"
},
"citizenship_country_codes": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of ISO-3166-2 citizenship country codes"
},
"deceased": {
"type": "boolean",
"description": "User deceased ?"
},
"deceased_at": {
"type": "string",
"format": "date-time",
"description": "User decease date time - iso8601."
},
"photo": {
"type": "object",
"properties": {
"compressed-url": {
"type": "string",
"description": "User compressed photo url"
},
"large-url": {
"type": "string",
"description": "User large photo url"
},
"medium-url": {
"type": "string",
"description": "User medium photo url"
},
"thumb-url": {
"type": "string",
"description": "User thumb photo url"
},
"mini-url": {
"type": "string",
"description": "User mini photo url"
},
"friend-url": {
"type": "string",
"description": "User friend photo url"
},
"icon-url": {
"type": "string",
"description": "User icon photo url"
}
},
"description": "User photo urls"
},
"do_not_contact": {
"type": "boolean",
"description": "User can be contacted ?"
},
"mobile_perso": {
"type": "string",
"description": "User mobile perso number"
},
"mobile_pro": {
"type": "string",
"description": "User mobile pro number"
},
"landline_perso": {
"type": "string",
"description": "User landline perso number"
},
"landline_pro": {
"type": "string",
"description": "User landline pro number"
},
"preferred_phone_number": {
"type": "string",
"enum": [
"mobile_pro",
"mobile_perso",
"landline_pro",
"landline_perso",
"none"
],
"description": "User preferred phone number"
},
"postal_personal": {
"description": "User personal postal address",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"address_1": {
"type": "string",
"description": "Address line 1"
},
"address_2": {
"type": "string",
"description": "Address line 2"
},
"address_3": {
"type": "string",
"description": "Address line 3"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "State"
},
"full_name": {
"type": "string",
"description": "Full name"
},
"postal_code": {
"type": "string",
"description": "Zip code"
},
"country": {
"type": "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"
],
"description": "Country"
},
"default_billing_address": {
"type": "boolean",
"description": "is the default billing address for the user ?"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Postal address creation date time - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Postal address last update date time - iso8601"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "User ID linked to postal address"
}
}
},
"postal_work": {
"description": "User work postal address",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"address_1": {
"type": "string",
"description": "Address line 1"
},
"address_2": {
"type": "string",
"description": "Address line 2"
},
"address_3": {
"type": "string",
"description": "Address line 3"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "State"
},
"full_name": {
"type": "string",
"description": "Full name"
},
"postal_code": {
"type": "string",
"description": "Zip code"
},
"country": {
"type": "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"
],
"description": "Country"
},
"default_billing_address": {
"type": "boolean",
"description": "is the default billing address for the user ?"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Postal address creation date time - iso8601"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Postal address last update date time - iso8601"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "User ID linked to postal address"
}
}
},
"preferred_postal_address": {
"type": "string",
"enum": [
"postal_personal",
"postal_work"
],
"description": "User preferred postal address"
},
"config": {
"description": "User specific configuration",
"type": "object",
"properties": {
"private_profile": {
"type": "boolean",
"description": "Unique ID"
},
"opt_out_of_directory": {
"type": "boolean",
"description": "Unique ID"
},
"opt_out_of_group_directories": {
"type": "array",
"items": {
"type": "object"
},
"description": "Unique ID"
},
"opt_out_of_messaging": {
"type": "boolean",
"description": "Opt out of messaging"
},
"share_gender": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of gender"
},
"share_prefix_firstname": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of prefix_firstname"
},
"share_honorary_title": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of honorary_title"
},
"share_prefix_name": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of prefix_name"
},
"share_suffix_name": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of suffix_name"
},
"share_maidenname": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of maidenname"
},
"share_birthday": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of birthday"
},
"share_birthplace": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of birthplace"
},
"share_headline": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of headline"
},
"share_live_location": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of live_location"
},
"share_sub_networks": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of sub_networks"
},
"share_nationalities": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of nationalities"
},
"share_resume": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of resume"
},
"share_summary": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of summary"
},
"share_industries": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of industries"
},
"share_skills": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of skills"
},
"share_facebook_profile_url": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of facebook_profile_url"
},
"share_instagram_profile_url": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of instagram_profile_url"
},
"share_twitter": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of twitter"
},
"share_skype": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of skype"
},
"share_linkedin_profile_url": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of linkedin_profile_url"
},
"share_website": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of website"
},
"share_bbm": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of bbm"
},
"share_email": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of email"
},
"share_email2": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of email2"
},
"share_email3": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of email3"
},
"share_mobile_perso": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of mobile_perso"
},
"share_landline_perso": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of landline_perso"
},
"share_mobile_pro": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of mobile_pro"
},
"share_landline_pro": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of landline_pro"
},
"share_postal_personal": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of postal_personal"
},
"share_postal_work": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of postal_work"
},
"share_memberships": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of memberships"
},
"share_educations": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of educations"
},
"share_experiences": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "Privacy sharing status of experiences"
}
}
},
"role_id": {
"type": "integer",
"format": "int32",
"description": "User role ID"
},
"awards": {
"type": "string",
"description": "User awards"
},
"linkedin_profile_url": {
"type": "string",
"description": "User linkedin profile URL"
},
"website": {
"type": "string",
"description": "User Website URL"
},
"skype": {
"type": "string",
"description": "User skype profile"
},
"bbm": {
"type": "string",
"description": "User BlackBerry Messenger profile"
},
"twitter": {
"type": "string",
"description": "User twitter profile"
},
"timezone": {
"type": "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"
],
"description": "User timezone"
},
"facebook_profile_url": {
"type": "string",
"description": "User facebook profile URL"
},
"instagram_profile_url": {
"type": "string",
"description": "User instagram profile URL"
},
"honorary_title": {
"type": "string",
"enum": [
"mr",
"mrs",
"ms",
"dr",
"prof"
],
"description": "User's honorary title"
},
"live_location": {
"description": "User's current location.",
"type": "object",
"properties": {
"city": {
"type": "string",
"description": "City"
},
"country": {
"type": "string",
"description": "Country"
},
"country_code": {
"type": "string",
"description": "ISO3166-2 Country code"
},
"address": {
"type": "string",
"description": "Address"
},
"lat": {
"type": "number",
"format": "float",
"description": "Latitude"
},
"lng": {
"type": "number",
"format": "float",
"description": "Longitude"
}
}
},
"resume": {
"type": "string",
"description": "URL link to the user's resume. This link will be expired if you do not open it in the 60 sec after your request. Another request will be needed"
},
"locale": {
"type": "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"
],
"description": "User Locale"
},
"share_email": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding email"
},
"share_email2": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding secondary email"
},
"share_email3": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding complementary email"
},
"share_postal_address_personal": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding postal home location"
},
"share_postal_address_work": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding postal work location"
},
"share_nationalities": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding nationalities"
},
"share_resume": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding resume"
},
"share_mobile_pro": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding work mobile phone"
},
"share_mobile_perso": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding personal mobile phone"
},
"share_landline_pro": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding professional landline phone"
},
"share_landline_perso": {
"type": "string",
"enum": [
"with_admin",
"with_all",
"with_bookmarked_users"
],
"description": "User's visibility information regarding personal landline phone"
},
"skills": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"name": {
"type": "string",
"description": "Skill name"
}
}
},
"description": "READ ONLY, list of user skills"
},
"custom_attributes": {
"type": "array",
"items": {
"type": "object"
},
"description": "Array of customizable attributes with name, value and type"
}
}
}
},
"description": "Admin_V3_Forums_DiscussionEntity model"
}Unprocessable entity
Schema
{
"type": "object",
"properties": {
"status": {
"type": "integer",
"format": "int32",
"description": "Status Code"
},
"errors": {
"type": "string",
"description": "Errors list"
}
},
"description": "Error model"
}Show a forum discussionGET/api/admin/v3/forums/discussions/{id}
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.
URI Parameters
- id
number(required)ID of the discussion to show
PUT /api/admin/v3/forums/discussions/id
Requests
Body
{
"title": "Hello, world!",
"content": "Hello, world!",
"pinned_on_index_page": true,
"cover_picture": "Hello, world!",
"storage_attachments[]": [],
"category_ids[]": [],
"feedable_at": "Hello, world!",
"embed_options[embed_likes]": true,
"embed_options[embed_comments]": true,
"embed_options[embed_user]": true,
"embed_options[embed_stripped_content]": true,
"embed_options[embed_categories]": true,
"embed_options[embed_attachments]": true
}Schema
{
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "Title of the discussion"
},
"content": {
"type": "string",
"description": "HTML content of the discussion"
},
"pinned_on_index_page": {
"type": "boolean",
"description": "Whether or not the discussion should be pinned on the index page"
},
"cover_picture": {
"type": "string",
"description": "Direct upload of the picture which will serve as a cover for the discussion"
},
"storage_attachments[]": {
"type": "array",
"description": "Direct upload of several files which will be attached to the discussion\n\n+"
},
"category_ids[]": {
"type": "array",
"description": "List of category IDs\n\n+"
},
"feedable_at": {
"type": "string",
"description": "Datetime of the publication"
},
"embed_options[embed_likes]": {
"type": "boolean"
},
"embed_options[embed_comments]": {
"type": "boolean"
},
"embed_options[embed_user]": {
"type": "boolean"
},
"embed_options[embed_stripped_content]": {
"type": "boolean"
},
"embed_options[embed_categories]": {
"type": "boolean"
},
"embed_options[embed_attachments]": {
"type": "boolean"
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Responses
Update a forum discussion
Schema
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique identifier for each notification record in the database."
},
"title": {
"type": "string",
"description": "Title of the discussion"
},
"content": {
"type": "string",
"description": "HTML content of the discussion"
},
"pinned_on_index_page": {
"type": "boolean",
"description": "Whether the discussion is pinned on the index page or not"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Date and time when the discussion was created"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Date and time when the discussion was last updated"
},
"user_id": {
"type": "integer",
"format": "int32",
"description": "ID of the User who created the discussion"
},
"feedable_at": {
"type": "string",
"format": "date-time",
"description": "Date and time when the discussion will be published"
},
"categories": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"name": {
"type": "string",
"description": "Name of the category"
}
},
"description": "NetworkCategoryCompact model"
},
"description": "Array of the related categories"
},
"comments_count": {
"type": "integer",
"format": "int32",
"description": "The number of comments"
},
"likes_count": {
"type": "integer",
"format": "int32",
"description": "The number of likes"
},
"cover_picture_url": {
"type": "string",
"description": "URL of the cover picture for the discussion"
},
"storage_attachments": {
"type": "string",
"description": "A string containing files attached to the discussion"
},
"storage_uploads": {
"type": "string",
"description": "A string containing files uploaded within the content of the discussion"
},
"user": {
"description": "More information about the user who created the discussion",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"email": {
"type": "string",
"description": "User email"
},
"name": {
"type": "string",
"description": "User full name"
},
"sub_network_ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": "IDs list of user sub networks"
},
"extended_updated_at": {
"type": "string",
"format": "date-time",
"description": "User full profile ( with experiences, educations, customs) last update date time - iso8601"
},
"likeable_type": {
"type": "string",
"description": "Type to use on API query"
},
"current_user_like_id": {
"type": "integer",
"format": "int32",
"description": "Like ID of the current_user if they like the Likeable"
},
"likes_count": {
"type": "integer",
"format": "int32",
"description": "Total count of likes on this Likeable"
},
"commentable_type": {
"type": "string",
"description": "Type to use on API query"
},
"comments_count": {
"type": "string",
"description": "Total count of comment for this Commentable"
},
"email2": {
"type": "string",
"description": "User secondary email"
},
"email3": {
"type": "string",
"description": "User complementary email"
},
"primary_email_choice": {
"type": "string",
"enum": [
"email",
"email2",
"email3"
],
"description": "User primary email choice"
},
"firstname": {
"type": "string",
"description": "User first name"
},
"lastname": {
"type": "string",
"description": "User last name"
},
"maidenname": {
"type": "string",
"description": "User maiden name"
},
"prefix_firstname": {
"type": "string",
"description": "User prefix firstname"
},
"prefix_name": {
"type": "string",
"description": "User prefix name"
},
"suffix_name": {
"type": "string",
"description": "User suffix name"
},
"external_id": {
"type": "string",
"description": "User ID in your database"
},
"sso_identifier": {
"type": "string",
"description": "User identifier for SSO"
},
"previous_id": {
"type": "string",
"description": "User ID in your community system"
},
"last_visited_at": {
"type": "string",
"format": "date-time",
"description": "Date of last visit - iso8601. READ only, can't be updated"
},
"sign_in_count": {
"type": "string",
"description": "Number of platform visits. READ only, can't be updated"
},
"is_active": {
"type": "boolean",
"description": "User account enabled ?"
},
"gender": {
"type": "string",
"enum": [
"male",
"female",
"other"
],
"description": "User gender (male/female/other)"
},
"birthday": {
"type": "string",
"format": "date",
"description": "User birth date"
},
"birthplace": {
"type": "string",
"description": "User birth place"
},
"headline": {
"type": "string",
"description": "User headline"
},
"summary": {
"type": "string",
"description": "User summary"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "User creation date time - iso8601. READ only, can't be updated"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "User last update date time - iso8601. READ only, can't be updated"
},
"confirmed_at": {
"type": "string",
"format": "date-time",
"description": "User activation date time - iso8601. READ only, can't be updated"
},
"citizenship_ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": "List of citizenship IDs"
},
"citizenship_country_codes": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of ISO-3166-2 citizenship country codes"
},
"deceased": {
"type": "boolean",
"description": "User deceased ?"
},
"deceased_at": {
"type": "string",
"format": "date-time",
"description": "User decease date time - iso8601."
},
"photo": {
"type": "object",
"properties": {
"compressed-url": {
"type": "string",
"description": "User compressed photo url"
},
"large-url": {
"type": "string",
"description": "User large photo url"
},
"medium-url": {
"type": "string",
"description": "User medium photo url"
},
"thumb-url": {
"type": "string",
"description": "User thumb photo url"
},
"mini-url": {
"type": "string",
"description": "User mini photo url"
},
"friend-url": {
"type": "string",
"description": "User friend photo url"
},
"icon-url": {
"type": "string",
"description": "User icon photo url"
}
},
"description": "User photo urls"
},
"do_not_contact": {
"type": "boolean",
"description": "User can be contacted ?"
},
"mobile_perso": {
"type": "string",
"description": "User mobile perso number"
},
"mobile_pro": {
"type": "string",
"description": "User mobile pro number"
},
"landline_perso": {
"type": "string",
"description": "User landline perso number"
},
"landline_pro": {
"type": "string",
"description": "User landline pro number"
},
"preferred_phone_number": {
"type": "string",
"enum": [
"mobile_pro",
"mobile_perso",
"landline_pro",
"landline_perso",
"none"
],
"description": "User preferred phone number"
},
"postal_personal": {
"description": "User personal postal address",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Unique ID"
},
"address_1": {
"type": "string",
"description": "Address line 1"
},
"address_2": {
"type": "string",
"description": "Address line 2"
},
"address_3": {
"type": "string",
"description": "Address line 3"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "State"
},
"full_name": {
"type": "string",
"description": "Full name"
},
"postal_code": {
"type": "string",
"description": "Zip code"
},
"country": {
"type": "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"