Converve API documentation version v1
http://demo.converve.com/api/v1
Home
Welcome to the Converve API Documentation. The API allows you to connect to your converve event and retrieve data.
Authentication
To authenticate against the API you need to use Basic HTTP Authentication.
Access is limited to administrator accounts.
If authentication fails a 401 Error is send. If you try to access a resource that your account is not allowed to access a 403 Error is send.
Field names
The API field names are linked to the field descriptions used in the system. If a field description changes (e.g. Company => Organistation) it will also change in the API.
Profiles
There are three types of profiles: Company, Person and Product. A full profile needs at least one of each type.
A company can have multiple person profiles and multiple product profiles.
A product can be linked to multiple person profiles and to a single company profile.
A person can be linked to multiple product profiles and to a single company profile.
Date/Time
All date time references are represented in Unix time
Query Parameters
Query parameters for GET requests are appended to the URL.
For POST request you can either send them as application/x-www-form-urlencoded or multipart/form-data for sending binary data.-
More information: http://www.w3schools.com/tags/ref_httpmethods.asp
Response
Responses from the API are sent in JSON format.
Curl Example
This curl command queries the API and returns the list of companies from category id 1.
curl --user "api@converve.de:password" "http://demo.converve.com/api/v1/companies?category_id=1"
/companies
List all companies
Query Parameters
- details: (boolean)
The entire profiles will be returned. Instead of just the basic infos. (true,false)
- category_id: (number)
Filter by Category Id
- status_id: (number)
Filter by Status id (0-5)
- New
- Accepted
- Rejected
- OnHold
- Accepted [not paid]
- Canceld
HTTP status code 200
Body
Type: application/json
Example:
[
{
"id": "1",
"name": "Software Pro",
"date_created": "1365651574",
"date_updated": "1421916757",
"category": {
"id": "1",
"name": "Exhibitors"
},
"status": {
"id": 0,
"name": "New"
}
},
{
"id": "2",
"name": "Live Next'",
"date_created": "1365651774",
"date_updated": "1421413633",
"category": {
"id": "1",
"name": "Exhibitors"
},
"status": {
"id": 1,
"name": "Accepted"
}
}
]
Add a new Company
Query Parameters
- category_id: required (number)
Category for the new company
Body
Type: application/x-www-form-urlencoded
Form Parameters- Company: (string)
A detailed list of all fields can be retrieved using the /categories/{category_id} endpoint.
HTTP status code 200
New company profile has been created. You will receive basic information from this profile.
Body
Type: application/json
Example:
[
{
"id": "1",
"name": "Software Pro",
"date_created": "1365651574",
"date_updated": "1421916757",
"category": {
"id": "1",
"name": "Exhibitors"
},
"status": {
"id": 0,
"name": "New"
}
}
]
HTTP status code 400
Something went wrong. See HTTP status message for further details
Retrieve a Company resource
URI Parameters
- company_id: required (string)
HTTP status code 200
Body
Type: application/json
Example:
{
"id": "218",
"date_created": "1418213510",
"date_updated": "1423567511",
"Company": "Converve GmbH",
"Street": "Küsterkamp 1",
"ZIP Code": "25355",
"City": "Barmstedt",
"Country": {
"code": "DE",
"name": "Germany"
},
"Telephone": "+49 (0) 4123 922 61-0",
"Website": "https://www.converve.de",
"Line of business": "Matchmaking",
"Company Description": "Manage all features of your networking event on the Converve Platform. Converve Networking Software comes as a highly customizable package of intuitive online software tools. Organizing any phase of your event has never been more simple and seamless. Together we will make your event extraordinary!",
"Hall": "10",
"Stand": "12A",
"Category": {
"id": "1",
"name": "Exhibitors"
}
}
Update a Company
URI Parameters
- company_id: required (string)
Body
Type: application/x-www-form-urlencoded
Form Parameters- Company: (string)
A detailed list of all fields can be retrieved using the /categories/{category_id} endpoint.
HTTP status code 200
The profile has been updated. You will receive basic information from this profile.
Body
Type: application/json
Example:
[
{
"id": "1",
"name": "Software Pro",
"date_created": "1365651574",
"date_updated": "1421916757",
"category": {
"id": "1",
"name": "Exhibitors"
},
"status": {
"id": 0,
"name": "New"
}
}
]
HTTP status code 400
Something went wrong. See HTTP status message for further details
Delete a Company.
URI Parameters
- company_id: required (string)
HTTP status code 200
The profile has been deleted.
Retrieve a list of persons (ID and Name)
URI Parameters
- company_id: required (string)
Query Parameters
- status_id: (number)
Filter by Status id (0/1)
- Inactive
- Active
HTTP status code 200
Body
Type: application/json
Example:
[
{
"id": "223",
"name": "Sören Gregor",
"date_created": 1418213510,
"date_updated": 1423570682,
"status": {
"id": 1,
"name": "Active"
}
}
]
Retrieve a list of products (ID and Name)
URI Parameters
- company_id: required (string)
Query Parameters
- status_id: (number)
Filter by Status id (0/1)
- Inactive
- Active
HTTP status code 200
Body
Type: application/json
Example:
[
{
"id": "210",
"name": "Networking software for your events",
"date_created": 1418213510,
"date_updated": 1423829979,
"status": {
"id": 1,
"name": "Active"
}
}
]
This is an alias for calling /companies with QUERY PARAMETERS details enabled.
/persons
List all person profiles
Query Parameters
- category_id: (number)
Filter by Category Id
- details: (boolean)
The entire profiles will be returned. Instead of just the basic infos. (true,false)
- status_id: (number)
Filter by Status id (0/1)
- Inactive
- Active
- company_id: (number)
Filter by Company Id
HTTP status code 200
Body
Type: application/json
Example:
[
{
"id": "1",
"name": "Mandy Beach",
"date_created": 1365651574,
"date_updated": 1378906520,
"status": {
"id": 1,
"name": "Active"
}
},
{
"id": "5",
"name": "Tanja Watts",
"date_created": 1366115124,
"date_updated": 1369137534,
"status": {
"id": 1,
"name": "Active"
}
}
]
Add a new Person
Body
Type: application/x-www-form-urlencoded
Form Parameters- Company: (string)
A detailed list of all fields can be retrieved using the /categories/{category_id} endpoint.
HTTP status code 200
New person profile has been created. You will receive basic information from this profile.
Body
Type: application/json
Example:
[
{
"id":"271",
"name":"Vera Bredung",
"date_created":1448553910,
"date_updated":1448553910,
"status": {
"id":1,
"name":"Active"
}
}
]
HTTP status code 400
Something went wrong. See HTTP status message for further details
Retrieve a Person resource
URI Parameters
- person_id: required (string)
HTTP status code 200
Body
Type: application/json
Example:
{
"id": "223",
"date_created": 1418213510,
"date_updated": 1423570682,
"Title": "",
"First Name": "Sören",
"Last Name": "Gregor",
"Jobtitle": "",
"Personal company e-mail": "soeren.gregor@match-making.de",
"Mobile phone during event": "+49 1234 4567890",
"Telephone": "+49 (0)4123 92261-0",
"status": {
"id": 1,
"name": "Active"
},
"company": {
"id": "218",
"name": "Converve GmbH"
}
}
Update a Person profile
URI Parameters
- person_id: required (string)
Body
Type: application/x-www-form-urlencoded
Form Parameters- Company: (string)
A detailed list of all fields can be retrieved using the /categories/{category_id} endpoint.
HTTP status code 200
The profile has been updated. You will receive basic information from this profile.
Body
Type: application/json
Example:
[
{
"id":"271",
"name":"Vera Bredung",
"date_created":1448553910,
"date_updated":1448553910,
"status": {
"id":1,
"name":"Active"
}
}
]
HTTP status code 400
Something went wrong. See HTTP status message for further details
Delete a Person.
URI Parameters
- person_id: required (string)
HTTP status code 200
The profile has been deleted.
Retrieve a list of product profiles linked to the person
URI Parameters
- person_id: required (string)
Query Parameters
- status_id: (number)
Filter by Status id (0/1)
- Inactive
- Active
HTTP status code 200
Body
Type: application/json
Example:
[
{
"id": "210",
"name": "Networking software for your events",
"date_created": 1418213510,
"date_updated": 1423829979,
"status": {
"id": 1,
"name": "Active"
}
}
]
This is an alias for calling /persons with QUERY PARAMETERS details enabled.
/products
List all available product profiles.
Query Parameters
- category_id: (number)
Filter by Category Id
- details: (boolean)
The entire profiles will be returned. Instead of just the basic infos. (true,false)
- status_id: (number)
Filter by Status id (0/1)
- Inactive
- Active
- company_id: (number)
Filter by Company Id
HTTP status code 200
Body
Type: application/json
Example:
[
{
"id": "1",
"name": "-",
"date_created": 1365651574,
"date_updated": 1376918496,
"status": {
"id": 1,
"name": "Active"
}
},
{
"id": "2",
"name": "-",
"date_created": 1365651774,
"date_updated": 1404725939,
"status": {
"id": 1,
"name": "Active"
}
}
]
Add a new Product
Body
Type: application/x-www-form-urlencoded
Form Parameters- Company: (integer)
A detailed list of all fields can be retrieved using the /categories/{category_id} endpoint.
HTTP status code 200
New product profile has been created. You will receive basic information from this profile.
Body
Type: application/json
Example:
[
{
"id": "1",
"name": "Software Pro",
"date_created": "1365651574",
"date_updated": "1421916757",
"category": {
"id": "1",
"name": "Exhibitors"
},
"status": {
"id": 0,
"name": "New"
}
}
]
HTTP status code 400
Something went wrong. See HTTP status message for further details
Receive a product resource
URI Parameters
- product_id: required (string)
HTTP status code 200
Body
Type: application/json
Example:
{
"id": "210",
"date_created": 1418213510,
"date_updated": 1423829979,
"Title": "Networking software for your events",
"What we offer": "A Converve networking event boosts first-class business contacts, profitable long-term networking and measurable ROI. Transform your business networking and increase attendance. ",
"What we are looking for": "As an event organizer you know that B2B networking events and appointment matching programs are quite simply the best way for executives to connect with other key decision-makers in their industry. Unfortunately, without the right software the events can be difficult to organize, tricky to import data and nearly impossible to customize.",
"status": {
"id": 1,
"name": "Active"
},
"company": {
"id": "218",
"name": "Converve GmbH"
}
}
Update a Product profile
URI Parameters
- product_id: required (string)
Body
Type: application/x-www-form-urlencoded
Form Parameters- Company: (string)
A detailed list of all fields can be retrieved using the /categories/{category_id} endpoint.
HTTP status code 200
The profile has been updated. You will receive basic information from this profile.
Body
Type: application/json
Example:
[
{
"id": "1",
"name": "Software Pro",
"date_created": "1365651574",
"date_updated": "1421916757",
"category": {
"id": "1",
"name": "Exhibitors"
},
"status": {
"id": 0,
"name": "New"
}
}
]
HTTP status code 400
Something went wrong. See HTTP status message for further details
Delete a Product.
URI Parameters
- product_id: required (string)
HTTP status code 200
The profile has been deleted.
Receive a list of person profiles linked to the product.
URI Parameters
- product_id: required (string)
Query Parameters
- status_id: (number)
Filter by Status id (0/1)
- Inactive
- Active
HTTP status code 200
Body
Type: application/json
Example:
[
{
"id": "223",
"name": "Sören Gregor",
"date_created": 1418213510,
"date_updated": 1423570682,
"status": {
"id": 1,
"name": "Active"
}
},
{
"id": "252",
"name": "Mark Kessels",
"date_created": 1423648841,
"date_updated": 1423648841,
"status": {
"id": 1,
"name": "Active"
}
}
]
This is an alias for calling /products with QUERY PARAMETERS details enabled.
/categories
List all available categories.
Query Parameters
- details: (boolean)
The entire profiles will be returned. Instead of just the basic infos. (true,false)
HTTP status code 200
Body
Type: application/json
Example:
[
{
"id": "2",
"name": "Visitors",
"date_created": 1421245636,
"date_updated": 1421164626
},
{
"id": "1",
"name": "Exhibitors",
"date_created": 1421164626,
"date_updated": 1425310345
}
]
Receive a Category resource. Including an overview of profile fields.
URI Parameters
- category_id: required (string)
HTTP status code 200
Body
Type: application/json
Example:
{
"id": "1",
"date_created": 1421164626,
"date_updated": 1425310345,
"name": "Exhibitors",
"color": "#b283ce",
"public": "true",
"registration": "true",
"profiles":
}
Receive all companies from a category.
URI Parameters
- category_id: required (string)
HTTP status code 200
Body
Type: application/json
Example:
[
{
"id": "1",
"name": "Software Pro",
"date_created": "1365651574",
"date_updated": "1421916757",
"category": {
"id": "1",
"name": "Exhibitors"
},
"status": {
"id": 0,
"name": "New"
}
},
{
"id": "2",
"name": "Live Next'",
"date_created": "1365651774",
"date_updated": "1421413633",
"category": {
"id": "1",
"name": "Exhibitors"
},
"status": {
"id": 1,
"name": "Accepted"
}
}
]
This is an alias for calling /categories with QUERY PARAMETERS details enabled.
/invoices
List all invoices. The currency is Euro, USD or CAD depending on the setup of the event platform. The amounts show up with up to two digits after the decimal point.
Query Parameters
- category_id: (number)
Filter by Category Id
- details: (boolean)
The entire profiles will be returned. Instead of just the basic infos. (true,false)
HTTP status code 200
Body
Type: application/json
Example:
[
{
"id": "5",
"number": "005",
"amount_total": 4020,
"amount_paid": 0,
"company": {
"id": "1",
"name": "Software Pro"
},
"date_created": 1371128692,
"date_updated": 1371128692
},
{
"id": "6",
"number": "006",
"amount_total": 232,
"amount_paid": 0,
"company": {
"id": "72",
"name": "North Only"
},
"date_created": 1374758717,
"date_updated": 1374758717
}
]
Receive an invoice resource.
URI Parameters
- invoice_id: required (string)
HTTP status code 200
Body
Type: application/json
Example:
{
"id": "42",
"number": "042",
"amount_total": 9000,
"amount_paid": 9000,
"amount_due": 0,
"amount_net": 7500,
"amount_tax": 1500,
"company": {
"id": "7",
"name": "Big Live"
},
"items": [
{
"id": "33",
"name": "Representative",
"description": "",
"quantity": "1",
"price": "1500",
"total": 1500
}
],
"payments": [
{
"id": 38,
"amount": "9000",
"date_created": "1402990443",
"type": "PayPal",
"payment_id": "973335822A5494638"
}
],
"date_created": 1402990443,
"date_updated": 1402990443
}
This is an alias for calling /invoices with QUERY PARAMETERS details enabled.
/prepop
List of prepopulated users
Query Parameters
- category_id: (number)
Filter by Category Id
- details: (boolean)
The entire profiles will be returned. Instead of just the basic infos. (true,false)
Insert a new prepopluated user
Query Parameters
- category_id: required (number)
Category for the new user
Body
Type: application/x-www-form-urlencoded
Form Parameters- Company: (string)
A detailed list of all fields can be retrieved using the /categories endpoint.
Receive an prepop resource.
URI Parameters
- prepop_id: required (string)
Send the prepop email
URI Parameters
- prepop_id: required (string)