NAV navbar
bash

Authentication

Oauth 2.0

To authorize, use this code:

# With shell, you can just pass the correct header with each request
curl -X POST \
  https://public-api.expertfile.com/v2/oauth/token \
  -H 'cache-control: no-cache' \
  -H 'content-type: application/x-www-form-urlencoded' \
  -d 'client_id=<YOUR_ID>&client_secret=<YOUR_SECRET>&grant_type=client_credentials'

Make sure to add you client ID and client secret.

Expertfile expects an access token to be included in all API requests to the server in a header that looks like the following:

Authorization: Bearer xxx-xxx-xxx

Body Parameters

Parameter Required Description
grant_type true string
enter client_credentials
client_id true string
your organization client id
client_secret true string
your organization client secret

Experts

Get All Experts

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert"
  -X GET
  -H "Authorization: Bearer xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": {
    "experts": [
      {
        "username": "myusername",
        "corporation": "mycorporation",
        "topics":[
          {
            "title": "topicname1"
          }, 
          {
            "title": "topicname2"
          }
        ],
        "tagline": "My tagline",
        "avatar": {
          "small": "my small avatar url",
          "medium": "my medium avatar url",
          "large": "my large avatar url",
          "original": "my original avatar url"
        }
      }
    ],
    "total": 12,
    "aggregations": {

    }
  },
  "success": true
}

This endpoint retrieves all Experts.

To retreive the original photo uploaded to ExpertFile, access "avatar.original".

HTTP Request

GET https://public-api.expertfile.com/v2/organization/:corporation/expert

Url Parameters

Parameter Desription
corporation integer
The corporation id

Query Parameters

Parameter Default Description
q - string
search query.
access public string
This can be public, private or all.
status all string
This can be published, unpublished or all.
page_size 10 integer
no. of experts to return.
page_from 0 integer
countries all string
array of countries(i.e. ["CA","US"])
topics all string
array of topics(i.e. ["topic1","topic2"])
industries all string
array of industries(i.e. ["industry1","industry2"])
categories all string
array of categories(i.e. ["cat1","cat2"])
tags all string
array of tags(i.e. ["tag1","tag2"])
companies all string
fields - string
array of tags(i.e. ["fullname","username"]) See Helper->Return Fields section for list)
sort name string
name or featured.
searchfield - string
fullname to query only name field.

Get a Specific Expert

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/username"
  -X GET
  -H "Authorization: Bearer xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": {
   "accomplishment":[],
   "account": [
   {
      "id": 53,
      "firstname": "Firstname",
      "lastname": "lastname",
      "corporation_id": 767,
      "job_title": "my job title",
      "gener": 0,
      "location_city": "Toronto",
      "location_state": "ON",
      "location_country": "CA",
      "location_postal": "M5G 1L7",
      "location_address": "my address",
      "email": "myemail@example.com",
      "company": "my company name",
      "phone_number": "123-456-7890",
      "username": "peter.evans"
   }
   ],
   "affiliation": [],
   "article": [],
   "assessment": [],
   "availability": [
   {
      "availability_keynote": 1,
      "availability_moderator": 1,
      "availability_panelist": 1,
      "availability_workshop": 1,
      "availability_host_mc": 1,
      "availability_appearance": 0,
      "availability_corptraining": 1,
      "availability_open": 1
   }
   ],
   "book": [],
   "biography": [
   {
      "biography": ""
   }
   ],
   "course": [],
   "corporationProfile": [],
   "corporationSocial": [],
   "eventAppearance": [],
   "education": [],
   "document": [],
   "video": [],
   "language": [],
   "partnership": [],
   "industry": [],
   "patents": [],
   "qanda": [{
      "questions": [],
      "count": 0
   }],    
   "spotlight": [{
      "spotlights": [],
      "count": 0
   }]
  },
  "success": true
}

This endpoint retrieves a specific Expert and all their profile data including linked expert content assets such as Spotlights and Q&A. Be sure you examine the sample response to see which fields will be returned.

HTTP Request

GET https://public-api.expertfile.com/v2/organization/:corporation/expert/:username

URL Parameters

Parameter Description
corporation integer
The corporation id
username string
The username of the expert to retrieve

##Add an Expert

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert"
  -X POST
  -H "Authorization: Bearer xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": [
    {
      "firstname" : "firstName",
      "lastname" : "lastName",
      "job_title" : "jobTitle",
      "email" : "you@email.com",
      "company" : "companyName",
      "phone_number" : "phoneNumber",
      "location_city" : "city",
      "location_state" : "state_province",
      "location_country" : "country",
      "location_postal" : "postalCode",
      "location_address" :"address"    
    }
  ],
  "success": true
}

HTTP Request

POST https://public-api.expertfile.com/v2/organization/:corporation/expert

URL Parameters

Parameter Description
corporation integer
The corporation id

Body Parameters

Parameter Required Description
firstname true string
first name
lastname true string
last name
job_title true string
job title
email true string
email address
company true string
company
department optional string
department
phone_number optional string
phone number
phone_number_extension optional string
phone number extension
location_city optional string
city
location_state optional string
state or province
location_country optional string
country
location_postal optional string
postal code
location_address optional string
address
location_building optional string
building
location_room optional string
room

Update an Expert

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username"
  -X PUT
  -H "Authorization: Bearer xxx-xxx-xxx"

if successful, The above command returns JSON structured like this:

{
  "data": {
    "user": "you.username",
    "updated": true
  },
  "success": true
}

This endpoint updates a expert.

HTTP Request

PUT https://public-api.expertfile.com/v2/organization/:corporation/expert/:username

URL Parameters

Parameter Description
corporation integer
The corporation id
username string
The username of the expert

Body Parameters

Parameter Required Description
firstname optional string
first name
lastname optional string
last name
job_title optional string
job title
email optional string
email address
company optional string
company
department optional string
department
phone_number optional string
phone number
phone_number_extension optional string
phone number extension
location_city optional string
city
location_state optional string
state or province
location_country optional string
country
location_postal optional string
postal code
location_address optional string
address
location_building optional string
building
location_room optional string
room
is_private optional integer
1 or 0
is_published optional integer
1 or 0

Delete a Specific Expert

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:id"
  -X DELETE
  -H "Authorization: Bearer xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data" : {
    "id": 2,
    "deleted" : true
  },
  "success": true
}

This endpoint deletes a specific Expert.

HTTP Request

DELETE https://public-api.expertfile.com/v2/organization/:corporation/expert/:username

URL Parameters

Parameter Description
corporation integer
The corporation id
username string
The username of the expert to retrieve

#Biography

##Get Biography

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/biography"
  -X GET
  -H "Authorization: xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": [
    {
      "biography" : "your biography"
    }
  ]
}

This endpoint retrieves an expert's biography

HTTP Request

GET https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/biography

URL Parameters

Parameter Description
corporation integer
The corporation id
username string
The username of the expert

Add Biography

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/biography"
  -X POST
  -H "Authorization: Bearer xxx-xxx-xxx"

if successful, The above command returns JSON structured like this:

{
  "data": [
    {
      { "id" : null }
    }
  ]
}

This endpoint adds a Biography.

HTTP Request

POST https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/biography

URL Parameters

Parameter Description
corporation integer
The corporation id
username string
The username of the expert

Body Parameters

Parameter Required Description
description optional string
biography content

#Tagline

##Get Tagline

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/tagline"
  -X GET
  -H "Authorization: xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": [
    {
      "tagline" : "your tagline"
    }
  ]
}

This endpoint retrieves an expert's tagline

HTTP Request

GET https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/tagline

URL Parameters

Parameter Description
corporation integer
The corporation id
username string
The username of the expert

Add Tagline

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/tagline"
  -X POST
  -H "Authorization: Bearer xxx-xxx-xxx"

if successful, The above command returns JSON structured like this:

{
  "data": [
    {
      "tagline" : {
        { "id" : null }
      }
    }
  ]
}

This endpoint adds a tagline.

HTTP Request

POST https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/tagline

URL Parameters

Parameter Description
corporation integer
The corporation id
username string
The username of the expert

Body Parameters

Parameter Required Description
tagline optional string
tagline content

HTTP Request

GET https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/link

URL Parameters

Parameter Description
corporation integer
The corporation id
username string
The username of the expert to retrieve

#Link

##Get All Links

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/link"
  -X GET
  -H "Authorization: xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": [
    {
      "id": 1,
      "name": "link name",
      "url": "http://www.example.com/",
    },
    {
      "id": 2,
      "name": "link name1",
      "url": "http://www.example.com/1",
    }
  ]
}

This endpoint retrieves all Links.

HTTP Request

GET https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/link

URL Parameters

Parameter Description
corporation integer
The corporation id
username string
The username of the expert to retrieve
curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/link/:id"
  -X GET
  -H "Authorization: Bearer xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": [
    {
      "id": 1,
      "name": "link name",
      "url": "http://linkurl.com"
    }
  ],
  "success": true
}

This endpoint retrieves a specific Link.

HTTP Request

GET https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/link/:id

URL Parameters

Parameter Description
id integer
Id of the link to retrieve.
corporation integer
The corporation id
username string
The username of the expert to retrieve
curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/link/"
  -X POST
  -H "Authorization: xxx-xxx-xxx"

if successful, The above command returns JSON structured like this:

{
  "data": {
    "id" : 2
  },
  "success": true
}

This endpoint adds a link for expert.

HTTP Request

POST https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/link/

URL Parameters

Parameter Description
corporation integer
The corporation id
username string
The username of the expert

Body Parameters

Parameter Required Description
name true string
name of the link
url true string
the actual url
curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/link/:id"
  -X PUT
  -H "Authorization: Bearer xxx-xxx-xxx"

if successful, The above command returns JSON structured like this:

{
  "data": {
    "id": 2,
    "updated": true
  },
  "success": true
}

This endpoint updates a link for expert.

HTTP Request

PUT https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/link/:id

URL Parameters

Parameter Description
id integer
id of the link
corporation integer
The corporation id
username string
The username of the expert

Body Parameters

Parameter Required Description
name optional string
name of the link
url optional string
the actual url
curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/link/:id"
  -X DELETE
  -H "Authorization: xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": {
    "id": 2,
    "deleted": true
  },
  "success": true
}

This endpoint deletes a specific link.

HTTP Request

DELETE https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/link/:id

URL Parameters

Parameter Description
id integer
The ID of the link
corporation integer
The corporation id
username string
The username of the expert

#Sample Talk

##Get All Sample Talks

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/sampletalk"
  -X GET
  -H "Authorization: xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": [
    {
      "id": 1,
      "title": "Title",
      "description": "Description"
    },
    {
      "id": 2,
      "title": "Title",
      "description": "Description"
    }
  ],
  "success": true
}

This endpoint retrieves all Sample Talks.

HTTP Request

GET https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/sampletalk

URL Parameters

Parameter Description
corporation integer
The corporation id
username string
The username of the expert to retrieve

Get a Specific Sample Talk

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/sampletalk/:id"
  -X GET
  -H "Authorization: xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": [
    {
      "id": 1,
      "title": "title",
      "description": "description"
    }
  ],
  "success": true
}

This endpoint retrieves a specific Sample Talk.

HTTP Request

GET https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/sampletalk/:id

URL Parameters

Parameter Description
id integer
Id of the link to retrieve
corporation integer
The corporation id
username string
The username of the expert to retrieve

Add a SampleTalk

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/sampletalk/"
  -X POST
  -H "Authorization: xxx-xxx-xxx"

if successful, The above command returns JSON structured like this:

{
  "data": {
    "id" : 2
  },
  "success": true
}

This endpoint adds a Sample Talk for an expert.

HTTP Request

POST https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/sampletalk/

URL Parameters

Parameter Description
corporation integer
The corporation id
username string
The username of the expert

Body Parameters

Parameter Required Description
title true string
title of the talk
description true string
description of the talk

Update a SampleTalk

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/sampletalk/:id"
  -X PUT
  -H "Authorization: xxx-xxx-xxx"

if successful, The above command returns JSON structured like this:

{
  "data": {
    "id": 2,
    "updated": true
  },
  "success": true
}

This endpoint updates a Sample Talk for an expert.

HTTP Request

PUT https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/sampletalk/:id

URL Parameters

Parameter Description
id integer
id of Sample Talk
corporation integer
The corporation id
username string
The username of the expert

Body Parameters

Parameter Required Description
title optional string
title of the talk
description optional string
description of the talk

Delete a Specific Sample Talk

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/sampletalk/:id"
  -X DELETE
  -H "Authorization: xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": {
    "id" : 2,
    "deleted": true
  },
  "success": true
}

This endpoint deletes a specific Sample Talk

HTTP Request

DELETE https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/sampletalk/:id

URL Parameters

Parameter Description
id integer
The ID of the link to delete
corporation integer
The corporation id
username string
The username of the expert

#Accomplishment

##Get All Accomplishment

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/accomplishment"
  -X GET
  -H "Authorization: xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": [
    {
      "id": 1,
      "title": "my accomplishment title",
      "description": "my accomplishment description",
      "start": 1349841600, //unix time
      "end": 1349841600, //unix time
      "type": 71
    },
    {
      "id": 2,
      "title": "my another accomplishment title",
      "description": "my another accomplishment description",
      "start": 1349841600, //unix time
      "end": 1349841600, //unix time
      "type": 71
    }
  ],
  "success": true
}

This endpoint retrieves all Accomplishments.

HTTP Request

GET https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/accomplishment

Parameter Description
corporation integer
The corporation id
username string
The username of the expert to retrieve

Get a Specific Accomplishment

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/accomplishment/:id"
  -H "Authorization: xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": [
    {
      "id": 1,
      "title": "my accomplishment title",
      "description": "my accomplishment description",
      "start": 1349841600, //unix time
      "end": 1349841600, //unix time
      "type": 71
    }
  ],
  "success": true
}

This endpoint retrieves a specific Accomplishment.

HTTP Request

GET https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/accomplishment/:id

URL Parameters

Parameter Description
id integer
Id of the sample talk to retrieve
corporation integer
The corporation id
username string
The username of the expert to retrieve

Add an Accomplishment

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/accomplishment/"
  -X POST
  -H "Authorization: Bearer xxx-xxx-xxx"

if successful, The above command returns JSON structured like this:

{
  "data": {
    "id" : 2
  },
  "success": true
}

This endpoint adds an Accomplishment for an expert.

HTTP Request

POST https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/accomplishment/

URL Parameters

Parameter Description
corporation integer
The corporation id
username string
The username of the expert

Body Parameters

Parameter Required Description
title required string
title of the talk
description required string
description of the talk
type optional string
Type of accomplishment. 71 for 'professional' and 73 for 'personal'
date optional integer
date in unix time

##Update a Specific Accomplishment

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/accomplishment/:id"
  -X PUT
  -H "Authorization: Bearer xxx-xxx-xxx"

if successful, The above command returns JSON structured like this:

{
  "data": {
    "id": 2,
    "updated": true
  },
  "success": true
}

This endpoint updates an Accomplishment for an expert.

HTTP Request

PUT https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/accomplishment/:id

URL Parameters

Parameter Description
id integer
id of accomplishment
corporation integer
The corporation id
username string
The username of the expert

Body Parameters

Parameter Required Description
title optional string
title of the talk
description optional string
description of the talk
type optional string
Type of accomplishment. 71 for 'professional' and 73 for 'personal'
date optional integer
date in unix time

Delete a Specific Accomplishment

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/accompishment/:id"
  -X DELETE
  -H "Authorization: Bearer xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": {
    "id": 2,
    "deleted": true
  },
  "success": true
}

This endpoint deletes a specific Accomplishment.

HTTP Request

DELETE https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/accomplishment/:id

URL Parameters

Parameter Description
id integer
The ID of the accomplishment to delete
corporation integer
The corporation id
username string
The username of the expert

#Affiliation

##Get All Affiliation

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/affiliation"
  -X GET
  -H "Authorization: xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": [
    {
      "id": 1,
      "name": "my affiliation name",
      "notes": "",
      "link": ""
    },{
      "id": 2,
      "name": "my another affiliation name",
      "notes": "",
      "link": ""
    }
  ],
  "success": true
}

This endpoint retrieves all Affiliations.

HTTP Request

GET https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/affiliation

Parameter Description
corporation integer
The corporation id
username string
The username of the expert to retrieve

Get a Specific Affiliation

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/affiliation/:id"
  -X GET
  -H "Authorization: xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": [
    {
      "id": 1,
      "name": "my affiliation name",
      "notes": "",
      "link": ""
    }
  ],
  "success": true
}

This endpoint retrieves a specific Affiliation.

HTTP Request

GET https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/affiliation/:id

URL Parameters

Parameter Description
id integer
Id of the affiliation to retrieve
corporation integer
The corporation id
username string
The username of the expert to retrieve

Add an Affiliation

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/affiliation/"
  -X POST
  -H "Authorization: xxx-xxx-xxx"

if successful, The above command returns JSON structured like this:

{
  "data": {
    "id" : 2
  },
  "success": true
}

This endpoint adds an Affiliation for an expert.

HTTP Request

POST https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/affiliation/

URL Parameters

Parameter Description
corporation integer
The corporation id
username string
The username of the expert

Body Parameters

Parameter Required Description
name required string
name of the affiliation

##Update an Affiliation

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/affiliation/:id"
  -X PUT
  -H "Authorization: xxx-xxx-xxx"

if successful, The above command returns JSON structured like this:

{
  "data": {
    "id": 2,
    "updated": true
  },
  "success": true
}

This endpoint updates an Affiliation for an expert.

HTTP Request

PUT https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/affiliation/:id

URL Parameters

Parameter Description
corporation integer
The corporation id
username string
The username of the expert

Body Parameters

Parameter Required Description
name optional string
name of the affiliation

Delete a Specific affiliation

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/affiliation/:id"
  -X DELETE
  -H "Authorization: xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": {
    "id": 2,
    "deleted": true
  },
  "success": true
}

This endpoint deletes a specific Affiliation.

HTTP Request

DELETE https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/affiliation/:id

URL Parameters

Parameter Description
id integer
The ID of the affiliation to delete
corporation integer
The corporation id
username string
The username of the expert

#Event Appearances

##Get All Event Appearances

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/eventappearance"
  -X GET
  -H "Authorization: xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": [
    {
      "id": 1,
      "title": "title 1",
      "event_name": "Event Name",
      "location": "Toronto",
      "date": 1362027600, //unix time
    },
    {
      "id": 2,
      "title": "title 2",
      "event_name": "Event Name 2",
      "location": "Toronto",
      "date": 1362028900, //unix time
    }
  ],
  "success": true
}

This endpoint retrieves all Event Apperances for an expert.

HTTP Request

GET https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/eventappearance

Parameter Description
corporation integer
The corporation id
username string
The username of the expert to retrieve

Get a Specific Event Appearance

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/eventappearance/:id"
  -X GET
  -H "Authorization: xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data":[
    {
      "id": 1,
      "title": "title 1",
      "event_name": "Event Name",
      "location": "Toronto",
      "date": 1362027600, //unix time
    }
  ],
  "success": true
}

This endpoint retrieves a specific event appearance for an expert.

HTTP Request

GET https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/eventappearance/:id

URL Parameters

Parameter Description
id integer
Id of the link to retrieve.
corporation integer
The corporation id
username string
The username of the expert to retrieve

Add an Event Appearance

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/eventappearance/"
  -X POST
  -H "Authorization: Bearer xxx-xxx-xxx"

if successful, The above command returns JSON structured like this:

{
  "data": {
    "id" : 2
  },
  "success": true
}

This endpoint adds an Event Appearance for an expert.

HTTP Request

POST https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/eventappearance/

URL Parameters

Parameter Description
corporation integer
The corporation id
username string
The username of the expert

Body Parameters

Parameter Required Description
title required string
title of the Event
event_name required string
name of the event
location optional string
name of the city/country where event took place
date optional integer
date in unix time

##Update an Event Appearance

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/eventappearance/:id"
  -X PUT
  -H "Authorization: Bearer xxx-xxx-xxx"

if successful, The above command returns JSON structured like this:

{
  "data": {
    "id": 2,
    "updated": true
  },
  "success": true
}

This endpoint updates an Event Appearance for an expert.

HTTP Request

PUT https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/eventappearance/:id

URL Parameters

Parameter Description
corporation integer
The corporation id
username string
The username of the expert

Body Parameters

Parameter Required Description
title optional string
title of the Event
event_name optional string
name of the event
location optional string
name of the city/country where event took place
date optional integer
date in unix time

Delete a Specific Event Appearance

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/eventappearance/:id"
  -X DELETE
  -H "Authorization: xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": {
    "id": 2,
    "deleted": true
  },
  "success": true
}

This endpoint deletes a specific Event Appearance.

HTTP Request

DELETE https://public-api.expertfile.com/v2/organization/:corporation/:username/eventappearance/:id

URL Parameters

Parameter Description
id integer
The ID of the Event Appearance to delete
corporation integer
The corporation id
username string
The username of the expert

#Media Appearance

##Get All Media Appearance

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/mediaappearance"
  -X GET
  -H "Authorization: xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": [
    {
      "id": 1,
      "title": "title 1",
      "organization": "organization 1",
      "type": "",
      "url": "",
      "details": "details",
      "date": 1497412800,
      "cover_url": "",
      "large_cover_url": "",
      "cover_alt_title": ""
    },
    {
      "id": 2,
      "title": "title 2",
      "organization": "organization 2",
      "type": "",
      "url": "",
      "details": "details",
      "date": 1497412800,
      "cover_url": "",
      "large_cover_url": "",
      "cover_alt_title": ""
    }
  ],
  "success": true
}

This endpoint retrieves all Media Appearances for an expert.

HTTP Request

GET https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/mediaappearance

Parameter Description
corporation integer
The corporation id
username string
The username of the expert to retrieve

Get a Specific Media Appearance

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/mediaappearance/:id"
  -H "Authorization: xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": [
    {
      "id": 1,
      "title": "title 1",
      "organization": "organization 1",
      "type": "",
      "url": "",
      "details": "details",
      "date": 1497412800,
      "cover_url": "",
      "large_cover_url": "",
      "cover_alt_title": ""
    }
  ],
  "success": true
}

This endpoint retrieves a specific Media Appearance.

HTTP Request

GET https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/mediaappearance/:id

URL Parameters

Parameter Description
id integer
Id of the link to retrieve.
corporation integer
The corporation id
username string
The username of the expert to retrieve

Add a Media Appearance

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/mediaappearance/"
  -X POST
  -H "Authorization: xxx-xxx-xxx"

if successful, The above command returns JSON structured like this:

{
  "data": {
    "id" : 2
  },
  "success": true
}

This endpoint adds a Media Appearance for an expert.

HTTP Request

POST https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/mediaappearance/

URL Parameters

Parameter Description
corporation integer
The corporation id
username string
The username of the expert

Body Parameters

Parameter Required Description
title required string
title of the media appearance
organization required string
name of the organization
details required string
details of the media appearance
type optional string
this can be one of 'print', 'online', 'tv', 'radio'
url optional string
link to the media appearance
date optional integer
date in unix time

##Update a Media Appearance

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/mediaappearance/:id"
  -X PUT
  -H "Authorization: xxx-xxx-xxx"

if successful, The above command returns JSON structured like this:

{
  "data": {
    "id": 2,
    "updated": true
  },
  "success": true
}

This endpoint updates a Media Appearance for an expert.

HTTP Request

PUT https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/mediaappearance/:id

URL Parameters

Parameter Description
corporation integer
The corporation id
username string
The username of the expert

Body Parameters

Parameter Required Description
title optional string
title of the media appearance
organization optional string
name of the organization
details optional string
details of the media appearance
type optional string
this can be one of 'print', 'online', 'tv', 'radio'
url optional string
link to the media appearance
date optional integer
date in unix time

Delete a Specific Media Appearance

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/mediaappearance/:id"
  -X DELETE
  -H "Authorization: Bearer xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": {
    "id": 2,
    "deleted": true
  },
  "success": true
}

This endpoint deletes a specific Media Appearance.

HTTP Request

DELETE https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/:id

URL Parameters

Parameter Description
id integer
The ID of the Media Appearance to delete
corporation integer
The corporation id
username string
The username of the expert

#Education

##Get All Education

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/education"
  -X GET
  -H "Authorization: xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": [
    {
      "id": 1,
      "institution": "My Institution",
      "degree": "My Degree",
      "description": "",
      "major": "My major",
      "date": 1998 // year 
    },
    {
      "id": 2,
      "institution": "My 2nd Institution",
      "degree": "My 2nd Degree",
      "description": "",
      "major": "My 2nd major",
      "date": 1998
    }
  ],
  "success": true
}

This endpoint retrieves all Education.

HTTP Request

GET https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/education

Parameter Description
corporation integer
The corporation id
username string
The username of the expert to retrieve

Get a Specific Education

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/education/:id"
  -X GET
  -H "Authorization: xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": [
    {
      "id": 1,
      "institution": "My Institution",
      "degree": "My Degree",
      "description": "",
      "major": "My major",
      "date": 1998
    }
  ],
  "success": true
}

This endpoint retrieves a specific Education.

HTTP Request

GET https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/:id

URL Parameters

Parameter Description
id integer
Id of the link to retrieve.
corporation integer
The corporation id
username string
The username of the expert to retrieve

Add Education

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/education/"
  -X POST
  -H "Authorization: xxx-xxx-xxx"

if successful, The above command returns JSON structured like this:

{
  "data": {
    "id" : 2
  },
  "success": true
}

This endpoint adds an Education for an expert.

HTTP Request

POST https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/education/

URL Parameters

Parameter Description
corporation integer
The corporation id
username string
The username of the expert

Body Parameters

Parameter Required Description
institution required name of the instituion
degree required degree obtained.
major optional Level of study. Bachelors/Masters/Phd
description optional string
additional information for the degree
date optional integer
year of graduation. Enter '1998' if graduation year is 1998

Update an Education

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/education/:id"
  -X PUT
  -H "Authorization: xxx-xxx-xxx"

if successful, The above command returns JSON structured like this:

{
  "data": {
    "id": 2,
    "updated": true
  },
  "success": true
}

This endpoint updates an Education for an expert.

HTTP Request

PUT https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/education/:id

URL Parameters

Parameter Description
corporation integer
The corporation id
username string
The username of the expert

Body Parameters

Parameter Required Description
institution optional string
name of the instituion
degree optional string
degree obtained.
major optional string
Level of study. Bachelors/Masters/Phd
description optional string
additional information for the degree
date optional integer
year of graduation. Enter '1998' if graduation year is 1998

Delete a Specific Education

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/education/:id"
  -X DELETE
  -H "Authorization: xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": {
    "id": 2,
    "deleted": true
  },
  "success": true
}

This endpoint deletes a specific Education.

HTTP Request

DELETE https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/accomplishment/:id

URL Parameters

Parameter Description
id integer
The ID of the Education to delete
corporation integer
The corporation id
username string
The username of the expert

#Testimonial

##Get All Testimonial

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/testimonial"
  -X GET
  -H "Authorization: xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": [
    {
      "id": 1,
      "name": "name",
      "title": "title",
      "email": "",
      "company": "company",
      "url": "https://url.com",
      "recommendation": "my amazing recommendation",
      "date": null
    },
    {
      "id": 2,
      "name": "name",
      "title": "title",
      "email": "",
      "company": "company",
      "url": "https://url.com",
      "recommendation": "my 2nd amazing recommendation",
      "date": null
    }
  ],
  "success": true
}

This endpoint retrieves all Testimonials for an expert.

HTTP Request

GET https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/testimonial

Parameter Description
corporation integer
The corporation id
username string
The username of the expert to retrieve

Get a Specific Testimonial

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/testimonial/:id"
  -X GET
  -H "Authorization: xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data":[
    {
      "id": 1,
      "name": "name",
      "title": "title",
      "email": "",
      "company": "company",
      "url": "https://url.com", //company url
      "recommendation": "my amazing recommendation",
      "date": null
    }
  ],
  "success": true
}

This endpoint retrieves a specific Testimonial.

HTTP Request

GET https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/testimonial/:id

URL Parameters

Parameter Description
id integer
Id of the link to retrieve.
corporation integer
The corporation id
username string
The username of the expert to retrieve

Add Testimonial

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/testimonial/"
  -X POST
  -H "Authorization: xxx-xxx-xxx"

if successful, The above command returns JSON structured like this:

{
  "data": {
    "id" : 2
  },
  "success": true
}

This endpoint adds an Testimonial for an expert.

HTTP Request

POST https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/testimonial/

URL Parameters

Parameter Description
corporation integer
The corporation id
username string
The username of the expert

Body Parameters

Parameter Required Description
name required string
name of the person
title required string
job title of the person
company required string
company person works for
recommendation required string
recommendation note
url optional string
url of the company where person works

Update a Testimonial

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/testimonial/:id"
  -X PUT
  -H "Authorization: xxx-xxx-xxx"

if successful, The above command returns JSON structured like this:

{
  "data": {
    "id": 2,
    "updated": true
  },
  "success": true
}

This endpoint updates a Testimonial for an expert.

HTTP Request

PUT https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/testimonial/:id

URL Parameters

Parameter Description
corporation integer
The corporation id
username string
The username of the expert

Body Parameters

Parameter Required Description
name optional string
name of the person
title optional string
job title of the person
company optional string
company person works for
recommendation optional string
recommendation note
url optional string
url of the company where person works

Delete a Specific Testimonial

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/testimonial/:id"
  -X DELETE
  -H "Authorization: xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": {
    "id": 2,
    "deleted": true
  },
  "success": true
}

This endpoint deletes a specific Testimonial.

HTTP Request

DELETE https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/accomplishment/:id

URL Parameters

Parameter Description
id integer
The ID of the testimonial to delete
corporation integer
The corporation id
username string
The username of the expert

#Patent

##Get All Patent

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/patent"
  -X GET
  -H "Authorization: xxx-xxx-xxx"

The above command returns JSON structured like this:


{
  "data": [
    {
      "id": 1,
      "title": "Title1",
      "detail": "detail1",
      "number": "100789",
      "date": 1499140800,
      "url": "http://www.example.com"
    },
    {
      "id": 2,
      "title": "Title2",
      "detail": "detail2",
      "number": "100789",
      "date": 1499140800,
      "url": "http://www.example.com"
    }
  ],
  "success": true
}

This endpoint retrieves all Patents.

HTTP Request

GET https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/patent

Parameter Description
corporation integer
The corporation id
username string
The username of the expert to retrieve

Get a Specific Patent

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/patent/:id"
  -X GET
  -H "Authorization: xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": [{
      "id": 1,
      "title": "Title1",
      "detail": "detail1",
      "number": "100789",
      "date": 1499140800,
      "url": "http://www.example.com"
  }],
  "success": true
}

This endpoint retrieves a specific Patent.

HTTP Request

GET https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/patent/:id

URL Parameters

Parameter Description
id integer
Id of the link to retrieve.
corporation integer
The corporation id
username string
The username of the expert to retrieve

Add Patent

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/patent/"
  -X POST
  -H "Authorization: xxx-xxx-xxx"

if successful, The above command returns JSON structured like this:

{
  "data": {
    "id" : 2
  },
  "success": true
}

This endpoint adds a Patent for an expert.

HTTP Request

POST https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/patent/

URL Parameters

Parameter Description
corporation integer
The corporation id
username string
The username of the expert

Body Parameters

Parameter Required Description
number required string
patent number
title required string
title of the patent
detail required string
description of the patent
date optional integer
date of the patent granted in unix time
url optional string
url of the patent

##Update a Patent

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/patent/:id"
  -X PUT
  -H "Authorization: xxx-xxx-xxx"

if successful, The above command returns JSON structured like this:

{
  "data": {
    "id": 2,
    "updated": true
  },
  "success": true
}

This endpoint updates a Patent for an expert.

HTTP Request

PUT https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/patent/:id

URL Parameters

Parameter Description
corporation integer
The corporation id
username string
The username of the expert

Body Parameters

Parameter Required Description
number optional string
patent number
title optional string
title of the patent
detail optional string
description of the patent
date optional integer
date of the patent granted in unix time
url optional string
url of the patent

Delete a Specific Patent

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/patent/:id"
  -X DELETE
  -H "Authorization: Bearer xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": {
    "id" : 2,
    "deleted": true
  },
  "success": true
}

This endpoint deletes a specific Patent.

HTTP Request

DELETE https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/patent/:id

URL Parameters

Parameter Description
id integer
The ID of the patent to delete
corporation integer
The corporation id
username string
The username of the expert

#Research Grant

##Get All Research Grant

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/researchgrant"
  -X GET
  -H "Authorization: Bearer xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": [
    {
      "id": 1,
      "title": "title1",
      "organization": "organization1",
      "url": "http://www.example.com",
      "details": "detail1",
      "date": 1499140800,
      "amount": "100"
    },
    {
      "id": 2,
      "title": "title1",
      "organization": "organization2",
      "url": "http://www.example.com",
      "details": "detail2",
      "date": 1499140800,
      "amount": "100"
    }
  ]
}

This endpoint retrieves all Reseach Grants.

HTTP Request

GET https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/researchgrant

Parameter Description
corporation integer
The corporation id
username string
The username of the expert to retrieve

Get a Specific Research grant

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/researchgrant/:id"
  -X GET
  -H "Authorization: xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": [
    {
      "id": 1,
      "title": "title1",
      "organization": "organization1",
      "url": "http://www.example.com",
      "details": "detail1",
      "date": 1499140800,
      "amount": "100"
    }
  ],
  "success": true
}

This endpoint retrieves a specific Research Grant.

HTTP Request

GET https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/researchgrant/:id

URL Parameters

Parameter Description
id integer
Id of the link to retrieve.
corporation integer
The corporation id
username string
The username of the expert to retrieve

Add Research Grant

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/researchgrant/"
  -X POST
  -H "Authorization: xxx-xxx-xxx"

if successful, The above command returns JSON structured like this:

{
  "data": {
    "id" : 2
  },
  "success": true
}

This endpoint adds a Research Grant for an expert.

HTTP Request

POST https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/researchgrant/

URL Parameters

Parameter Description
corporation integer
The corporation id
username string
The username of the expert

Body Parameters

Parameter Required Description
organization required string
organization to give grant
title required string
title of the grant
detail required string
description of the grant
date optional integer
date in unix time
url optional string
url
amount optional string
amount granted

##Update a Research Grant

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/researchgrant/:id"
  -X PUT
  -H "Authorization: xxx-xxx-xxx"

if successful, The above command returns JSON structured like this:

{
  "data": {
    "id" : 2,
    "updated": true
  },
  "success": true
}

This endpoint updates a Research Grant for an expert.

HTTP Request

PUT https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/researchgrant/:id

URL Parameters

Parameter Description
corporation integer
The corporation id
username string
The username of the expert

Body Parameters

Parameter Required Description
organization optional string
organization to give grant
title optional string
title of the grant
detail optional string
description of the grant
date optional integer
date in unix time
url optional string
url
amount optional string
amount granted

Delete a Specific Research Grant

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/researchgrant/:id"
  -X DELETE
  -H "Authorization: Bearer xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": {
    "id" : 2,
    "deleted": true
  },
  "success": true
}

This endpoint deletes a specific Research Grant.

HTTP Request

DELETE https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/researchgrant/:id

URL Parameters

Parameter Description
id integer
The ID of the link to research grant
corporation integer
The corporation id
username string
The username of the expert

#Partnerships

##Get All Partnerships

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/partnership"
  -X GET
  -H "Authorization: xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": [
    {
      "id": 1,
      "title": "title1",
      "individual": "partner name1",
      "organization": "organization",
      "url": "http://www.example.com",
      "details": "detail1",
      "date": 1499140800
    },
    {
      "id": 2,
      "title": "title2",
      "individual": "partner name",
      "organization": "organization",
      "url": "http://www.example.com",
      "details": "detail1",
      "date": 1499140800
    }
  ],
  "success": true
}

This endpoint retrieves all Partnerships for an expert.

HTTP Request

GET https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/partnership

Parameter Description
corporation integer
The corporation id
username string
The username of the expert to retrieve

Get a Specific Partnership

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/partnership/:id"
  -X GET
  -H "Authorization: xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": [
    {
      "id": 1,
      "title": "title1",
      "individual": "partner name1",
      "organization": "organization",
      "url": "http://www.example.com",
      "details": "detail1",
      "date": 1499140800
    }
  ],
  "success": true
}

This endpoint retrieves a specific Partnership for an expert.

HTTP Request

GET https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/partnership/:id

URL Parameters

Parameter Description
id integer
Id of the Partnership to retrieve.
corporation integer
The corporation id
username string
The username of the expert to retrieve

Add Partnership

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/partnership/"
  -X POST
  -H "Authorization: xxx-xxx-xxx"

if successful, The above command returns JSON structured like this:

{
  "data": {
    "id" : 2
  },
  "success": true
}

This endpoint adds a Partnership for an expert.

HTTP Request

POST https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/partnership/

URL Parameters

Parameter Description
corporation integer
The corporation id
username string
The username of the expert

Body Parameters

Parameter Required Description
title required string
partnership title
individual required string
partner name
details required string
description of the partnership
date optional integer
date in unix time
url optional string
url
organization optional string
organization

##Update a Partnership

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/partnership/:id"
  -X PUT
  -H "Authorization: xxx-xxx-xxx"

if successful, The above command returns JSON structured like this:

{
  "data": {
    "id" : 2,
    "updated": true
  },
  "success": true
}

This endpoint updates a Partnership for an expert.

HTTP Request

PUT https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/partnership/:id

URL Parameters

Parameter Description
corporation integer
The corporation id
username string
The username of the expert

Body Parameters

Parameter Required Description
title optional string
partnership title
individual optional string
partner name
details optional string
description of the partnership
date optional integer
date in unix time
url optional string
url
organization optional string
organization

Delete a Specific Partnership

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/partnership/:id"
  -X DELETE
  -H "Authorization: Bearer xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": {
    "id" : 2,
    "deleted": true
  },
  "success": true
}

This endpoint deletes a specific Partnership.

HTTP Request

DELETE https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/partnership/:id

URL Parameters

Parameter Description
id integer
id of the Partnership to delete
corporation integer
The corporation id
username string
The username of the expert to retrieve

#Courses

##Get All Courses

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/course"
  -X GET
  -H "Authorization: Bearer xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": [
    {
      "id": 1,
      "title": "course title",
      "details": "course detail",
      "url": "http://www.example.com"
    },
    {
      "id": 2,
      "title": "course title2",
      "details": "course detail2",
      "url": "http://www.example2.com"
    }
  ],
  "success": true
}

This endpoint retrieves all Courses.

HTTP Request

GET https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/course

Parameter Description
corporation integer
The corporation id
username string
The username of the expert to retrieve

Get a Specific Course

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/course/:id"
  -X GET
  -H "Authorization: xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": [
    {
      "id": 1,
      "title": "course title",
      "details": "course detail",
      "url": "http://www.example.com"
    }
  ],
  "success": true
}

This endpoint retrieves a specific Course.

HTTP Request

GET https://public-api.expertfile.com/v2/organization/:corporation/expert/:id

URL Parameters

Parameter Description
id integer
id of the link to retrieve.
corporation integer
The corporation id
username string
The username of the expert to retrieve

Add Course

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/course/"
  -X POST
  -H "Authorization: Bearer xxx-xxx-xxx"

if successful, The above command returns JSON structured like this:

{
  "data": {
    "id" : 2
  },
  "success": true
}

This endpoint adds a Course for an expert.

HTTP Request

POST https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/course/

URL Parameters

Parameter Description
corporation integer
The corporation id
username string
The username of the expert

Body Parameters

Parameter Required Description
title required string
course title
details required string
description/details of the course
url optional string
url

##Update a Specific Course

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/course/:id"
  -X PUT
  -H "Authorization: Bearer xxx-xxx-xxx"

if successful, The above command returns JSON structured like this:

{
  "data": {
    "id" : 2,
    "updated": true
  },
  "success": true
}

This endpoint updates a Course for an expert.

HTTP Request

PUT https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/course/:id

URL Parameters

Parameter Description
corporation integer
The corporation id
username string
The username of the expert

Body Parameters

Parameter Required Description
title optional string
course title
details optional string
description/details of the course
url optional string
url

Delete a Specific Course

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/course/:id"
  -X DELETE
  -H "Authorization: Bearer xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": {
    "id" : 2,
    "deleted": true
  },
  "success": true
}

This endpoint deletes a specific Course.

HTTP Request

DELETE https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/course/:id

URL Parameters

Parameter Description
id integer
id of the course to delete
corporation integer
The corporation id
username string
The username of the expert to retrieve

#Articles

##Get All Articles

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/article"
  -X GET
  -H "Authorization: Bearer xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": [
    {
      "id": 1,
      "title": "article title",
      "publisher": "article publication",
      "details": "article detail",
      "date": 1499140800,
      "url": "http://www.example.com",
      "authors": "author"
    },
    {
      "id": 2,
      "title": "article title2",
      "publisher": "article publication2",
      "details": "article detail2",
      "date": 1499140800,
      "url": "http://www.example2.com",
      "authors": "author2"
    }
  ],
  "success": true
}

This endpoint retrieves all Articles for an expert.

HTTP Request

GET https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/article

Parameter Description
corporation integer
The corporation id
username string
The username of the expert to retrieve

Get a Specific Article

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/article/:id"
  -X GET
  -H "Authorization: xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": [
    {
      "id": 1,
      "title": "article title",
      "publisher": "article publication",
      "details": "article detail",
      "date": 1499140800,
      "url": "http://www.example.com",
      "authors": "author"
    }
  ],
  "success": true
}

This endpoint retrieves a specific Article.

HTTP Request

GET https://public-api.expertfile.com/v2/organization/:corporation/expert/:id

URL Parameters

Parameter Description
id integer
id of the link to retrieve.
corporation integer
The corporation id
username string
The username of the expert to retrieve

Add Article

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/article/"
  -X POST
  -H "Authorization: Bearer xxx-xxx-xxx"

if successful, The above command returns JSON structured like this:

{
  "data": {
    "id" : 2
  },
  "success": true
}

This endpoint adds an Article for an expert.

HTTP Request

POST https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/article/

URL Parameters

Parameter Description
corporation integer
The corporation id
username string
The username of the expert

Body Parameters

Parameter Required Description
title required string
course title
publisher required publisher name
details required string
description/details of the course
url optional string
url
authors optional co-authors
url optional string
link to the article

##Update a Artcile

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/article/:id"
  -X PUT
  -H "Authorization: xxx-xxx-xxx"

if successful, The above command returns JSON structured like this:

{
  "data": {
    "id" : 2,
    "updated": true
  },
  "success": true
}

This endpoint updates a specific Article for expert.

HTTP Request

PUT https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/article/:id

URL Parameters

Parameter Description
corporation integer
The corporation id
username string
The username of the expert

Body Parameters

Parameter Required Description
title optional string
course title
publisher optional string
publisher name
details optional string
description/details of the course
authors optional string
co-authors
url optional string
link to the article

Delete a Specific Article

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/article/:id"
  -X DELETE
  -H "Authorization: Bearer xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": {
    "id" : 2,
    "deleted": true
  },
  "success": true
}

This endpoint deletes a specific Article.

HTTP Request

DELETE https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/article/:id

URL Parameters

Parameter Description
id integer
id of the article to delete
corporation integer
The corporation id
username string
The username of the expert to retrieve

#Research Focus

##Get All Research Focus

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/researchfocus"
  -X GET
  -H "Authorization: xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": [
    {
      "id": 1,
      "title": "focus 1",
      "subtitle": "sub title",
      "details": "details 1",
      "date": null,
      "url": "",
      "cover_url": "exampleurl.com",
      "large_cover_url": "exampleurl.com",
      "cover_alt_title": null
    },
    {
      "id": 2,
      "title": "focus 2",
      "subtitle": "sub title",
      "details": "details 2",
      "date": null,
      "url": "",
      "cover_url": "exampleurl.com",
      "large_cover_url": "exampleurl.com",
      "cover_alt_title": null
    }
  ],
  "success": true
}

This endpoint retrieves all Research Focus for an expert.

HTTP Request

GET https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/researchfocus/

Parameter Description
corporation integer
The corporation id
username string
The username of the expert to retrieve

Get a Specific Research Focus

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/researchfocus/:id"
  -X GET
  -H "Authorization: Bearer xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": [
    {
      "id": 1,
      "title": "focus 1",
      "subtitle": "sub title",
      "details": "details 1",
      "date": null,
      "url": "",
      "cover_url": "exampleurl.com",
      "large_cover_url": "exampleurl.com",
      "cover_alt_title": null
    }
  ],
  "success": true
}

This endpoint retrieves a specific Research Focus.

HTTP Request

GET https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/researchfocus/:id

URL Parameters

Parameter Description
id integer
id of the research focus to retrieve
corporation integer
The corporation id
username string
The username of the expert to retrieve

Add Research Focus

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/researchfocus/"
  -X POST
  -H "Authorization: Bearer xxx-xxx-xxx"

if successful, The above command returns JSON structured like this:

{
  "data": {
    "id" : 2
  },
  "success": true
}

This endpoint adds a Research Focus for an expert.

HTTP Request

POST https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/researchfocus/

URL Parameters

Parameter Description
corporation integer
The corporation id
username string
The username of the expert

Body Parameters

Parameter Required Description
title required string
course title
details required string
description/details of the course
url optional string
url
date optional integer
date in unix format
subtitle optional string

##Update a Research Focus

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/researchfocus/"
  -X PUT
  -H "Authorization: Bearer xxx-xxx-xxx"

if successful, The above command returns JSON structured like this:

{
  "data": {
    "id" : 2,
    "updated": true
  },
  "success": true
}

This endpoint updates a specific Research Focus for an expert.

HTTP Request

PUT https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/researchfocus/

URL Parameters

Parameter Description
corporation integer
The corporation id
username string
The username of the expert

Body Parameters

Parameter Required Description
title optional string
course title
details optional string
description/details of the course
url optional string
url
date optional integer
date in unix format
subtitle optional string

Delete a Specific Research Focus

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/researchfocus/:id"
  -X DELETE
  -H "Authorization: xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": {
    "id": 2,
    "deleted" : true
  },
  "success": true
  }
}

This endpoint deletes a specific Research Focus.

HTTP Request

DELETE https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/researchfocus/:id

URL Parameters

Parameter Description
id integer
id of the research focus to delete
corporation integer
The corporation id
username string
The username of the expert to retrieve

#Topics

##Get All Topics

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/topic/"
  -X GET
  -H "Authorization: Bearer xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": [
    {
      "id": 1,
      "name": "topic 1"
    },
    {
      "id": 2,
      "name": "topic 2"
    }
  ],
  "success": true
}

This endpoint retrieves all Topics for an expert.

HTTP Request

GET https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/topic/

Parameter Description
corporation integer
The corporation id
username string
The username of the expert to retrieve

Get a Specific Topic

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/topic/:id"
  -X GET
  -H "Authorization: Bearer xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": [
     {
      "id": 1,
      "name": "topic 1"
     }
  ],
  "success": true
}

This endpoint retrieves a specific Topic for an expert.

HTTP Request

GET https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/topic/:id

URL Parameters

Parameter Description
id integer
id of the topic to retrieve.
corporation integer
The corporation id
username string
The username of the expert to retrieve

Add Topic

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/topic/"
  -X POST
  -H "Authorization: Bearer xxx-xxx-xxx"

if successful, The above command returns JSON structured like this:

{
  "data": {
    "id" : 2
  },
  "success": true
}

This endpoint adds a Topic for an expert.

HTTP Request

POST https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/topic/

URL Parameters

Parameter Description
corporation integer
The corporation id
username string
The username of the expert

Body Parameters

Parameter Required Description
name required string
topic name

Delete a Specific Topic

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/topic/:id"
  -X DELETE
  -H "Authorization: Bearer xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": {
    "id": 2,
    "deleted" : true
  },
  "success": true
}

This endpoint deletes a specific Topic for an expert.

HTTP Request

DELETE https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/topic/:id

URL Parameters

Parameter Description
id integer
id of the topic to delete
corporation integer
The corporation id
username string
The username of the expert to retrieve

#Industry

##Get All Industry

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/industry/"
  -X GET
  -H "Authorization: xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": [
    {
      "id": 1,
      "name": "Industry 1"
    },
    {
      "id": 2,
      "name": "Industry 2"
    }
  ],
  "success": true
}

This endpoint retrieves all Industries.

HTTP Request

GET https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/industry/

Parameter Description
corporation integer
The corporation id
username string
The username of the expert to retrieve

Get a Specific Industry

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/industry/:id"
  -X GET
  -H "Authorization: xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": [
    {
      "id": 1,
      "name": "Industry 1"
    }
  ]
}

This endpoint retrieves a specific Industry for an expert.

HTTP Request

GET https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/industry/:id

URL Parameters

Parameter Description
id integer
id of the industry to retrieve.
corporation integer
The corporation id
username string
The username of the expert to retrieve.

Add Industry

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/industry/"
  -X POST
  -H "Authorization: xxx-xxx-xxx"

if successful, The above command returns JSON structured like this:

{
  "data": {
    "id" : 2
  },
  "success": true
}

This endpoint adds an Industry for an expert.

HTTP Request

POST https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/industry/

URL Parameters

Parameter Description
corporation integer
The corporation id
username string
The username of the expert

Body Parameters

Parameter Required Description
name required string
Industry name

Delete a Specific Insutry

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/industry/:id"
  -X DELETE
  -H "Authorization: Bearer xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data" : {
    "id": 2,
    "deleted" : true
  },
  "success": true
}

This endpoint deletes a specific Industry.

HTTP Request

DELETE https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/industry/:id

URL Parameters

Parameter Description
id integer
id of the industry to delete
corporation integer
The corporation id
username string
The username of the expert to retrieve

#Languages

##Get All languages

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/language/"
  -X GET
  -H "Authorization: Bearer xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": [
    {
      "id": 1,
      "name": "Language1"
    },
    {
      "id": 2,
      "name": "Language2"
    }
  ],
  "success": true
}

This endpoint retrieves all Languages.

HTTP Request

GET https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/language/

Parameter Description
corporation integer
The corporation id
username string
The username of the expert to retrieve

Get a Specific Languages

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/language/:id"
  -X GET
  -H "Authorization: Bearer xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": [
    {
      "id": 1,
      "name": "Language1"
    }
  ],
  "success": true
}

This endpoint retrieves a specific Language.

HTTP Request

GET https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/language/:id

URL Parameters

Parameter Description
id integer
id of the language to retrieve.
corporation integer
The corporation id
username string
The username of the expert to retrieve

Add Language

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/language/"
  -X POST
  -H "Authorization: xxx-xxx-xxx"

if successful, The above command returns JSON structured like this:

{
  "data": {
    "id" : 2
  },
  "success": true
}

This endpoint adds a Language for an expert.

HTTP Request

POST https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/language/

URL Parameters

Parameter Description
corporation integer
The corporation id
username string
The username of the expert

Body Parameters

Parameter Required Description
name required string
langauge name

##Update a Language

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/language/:id"
  -X PUT
  -H "Authorization: xxx-xxx-xxx"

if successful, The above command returns JSON structured like this:

{
  "data": {
    "id" : 2,
    "updated": true
  },
  "success": true
}

This endpoint updates a Language for an expert.

HTTP Request

PUT https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/language/:id

URL Parameters

Parameter Description
corporation integer
The corporation id
username string
The username of the expert

Body Parameters

Parameter Required Description
name optional string
langauge name

Delete a Specific Language

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/language/:id"
  -X DELETE
  -H "Authorization: xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": {
    "id": 2,
    "deleted" : true
  },
  "success": true
}

This endpoint deletes a specific Language.

HTTP Request

DELETE https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/language/:id

URL Parameters

Parameter Description
id integer
id of the research focus to delete
corporation integer
The corporation id
username string
The username of the expert to retrieve

#Fees

##Get All Fees

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/fee"
  -X GET
  -H "Authorization: xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": [
    {
      "fee_min": 100,
      "fee_max": 1000
    }
  ],
  "success": true
}

This endpoint retrieves Fees for an expert.

HTTP Request

GET https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/fee

Parameter Description
corporation integer
The corporation id
username string
The username of the expert to retrieve

Add Fees

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/fee"
  -X POST
  -H "Authorization: xxx-xxx-xxx"

if successful, The above command returns JSON structured like this:

{
  "data": {
    "id" : 2
  },
  "success": true
}

This endpoint adds a Fees for an expert.

HTTP Request

POST https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/fee

URL Parameters

Parameter Description
corporation integer
The corporation id
username string
The username of the expert

Body Parameters

Parameter Required Description
fee_min required integer
min fees
fee_max required integer
max fees

#Availability

##Get Availability

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/availability"
  -X GET
  -H "Authorization: Bearer xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": [
    {
      "availability_keynote": 1,
      "availability_moderator": 1,
      "availability_panelist": 1,
      "availability_workshop": 1,
      "availability_host_mc": 1,
      "availability_appearance": 0,
      "availability_corptraining": 1,
      "availability_open": 1
    }
  ],
  "success": true
}

This endpoint retrieves all Availability.

HTTP Request

GET https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/availability

Parameter Description
corporation integer
The corporation id
username string
The username of the expert to retrieve

##Add Availability

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/availability"
  -X POST
  -H "Authorization: Bearer xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": [
    {
      "availability_keynote": 1,
      "availability_moderator": 1,
      "availability_panelist": 1,
      "availability_workshop": 1,
      "availability_host_mc": 1,
      "availability_appearance": 0,
      "availability_corptraining": 1,
      "availability_open": 1
    }
  ],
  "success": true
}

This endpoint adds Availability.

HTTP Request

POST https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/availability

URL Parameters

Parameter Description
corporation integer
The corporation id
username string
The username of the expert

Body Parameters

Parameter Required Description
availability_keynote optional integer
available for keynote(1 or 0)
availability_moderator optional integer
available for moderator(1 or 0)
availability_panelist optional integer
available for panelist(1 or 0)
availability_workshop optional integer
available for workshop(1 or 0)
availability_host_mc optional integer
available for host/mc (1 or 0)
availability_appearance optional integer
available for author appearance(1 or 0)
availability_corptraining optional integer
available for corporate training(1 or 0)

#Social

##Get All Social

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/social"
  -X GET
  -H "Authorization: Bearer xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": [
    {
      { "id" : null }
    }
  ],
  "success": true
}

This endpoint retrieves all Social Links.

HTTP Request

GET https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/social

Parameter Description
corporation integer
The corporation id
username string
The username of the expert to retrieve

Add Social

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/social/"
  -X POST
  -H "Authorization: Bearer xxx-xxx-xxx"

if successful, The above command returns JSON structured like this:

{
  "data": {
      { "id" : null}
  },
  "success": true
}

This endpoint adds Social Links for an expert.

HTTP Request

POST https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/social/

URL Parameters

Parameter Description
corporation integer
The corporation id
username string
The username of the expert

Body Parameters

Parameter Required Description
twitter optional string
twitter url
facebook optional string
facebook url
linkedin optional string
linkedin url
gplus optional string
gplus url
stackexchange optional string
stackexchange url,
github optional string
github url
flickr optional string
flickr url
pinterest optional string
pinterest url
instagram optional string
instagram url
tumblr optional string
tumblr url
youtube optional string
youtube url

#Categories

##Get All Categories

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/category/"
  -X GET
  -H "Authorization: Bearer xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": [
    {
      "id": 1,
      "name": "category 1"
    },
    {
      "id": 2,
      "name": "category 2"
    }
  ],
  "success": true
}

This endpoint retrieves all Categories for an expert.

HTTP Request

GET https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/category/

Parameter Description
corporation integer
The corporation id
username string
The username of the expert to retrieve

Get a Specific Category

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/category/:id"
  -X GET
  -H "Authorization: Bearer xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": [
     {
      "id": 1,
      "name": "category 1"
     }
  ],
  "success": true
}

This endpoint retrieves a specific Category for an expert.

HTTP Request

GET https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/category/:id

URL Parameters

Parameter Description
id integer
id of the category to retrieve.
corporation integer
The corporation id
username string
The username of the expert to retrieve

Add Category

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/category/"
  -X POST
  -H "Authorization: Bearer xxx-xxx-xxx"

if successful, The above command returns JSON structured like this:

{
  "data": {
    "id" : 2
  },
  "success": true
}

This endpoint adds a Category for an expert.

HTTP Request

POST https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/category/

URL Parameters

Parameter Description
corporation integer
The corporation id
username string
The username of the expert

Body Parameters

Parameter Required Description
name required string
category name

Delete a Specific Category

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/category/:id"
  -X DELETE
  -H "Authorization: Bearer xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": {
    "id": 2,
    "deleted" : true
  },
  "success": true
}

This endpoint deletes a specific Category for an expert.

HTTP Request

DELETE https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/category/:id

URL Parameters

Parameter Description
id integer
id of the category to delete
corporation integer
The corporation id
username string
The username of the expert

#Tags

##Get All Tags

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/tag/"
  -X GET
  -H "Authorization: Bearer xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": [
    {
      "id": 1,
      "name": "tag 1"
    },
    {
      "id": 2,
      "name": "tag 2"
    }
  ],
  "success": true
}

This endpoint retrieves all Tags for an expert.

HTTP Request

GET https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/tag/

Parameter Description
corporation integer
The corporation id
username string
The username of the expert to retrieve

Get a Specific Tag

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/tag/:id"
  -X GET
  -H "Authorization: Bearer xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": [
     {
      "id": 1,
      "name": "tag 1"
     }
  ],
  "success": true
}

This endpoint retrieves a specific Tag for an expert.

HTTP Request

GET https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/tag/:id

URL Parameters

Parameter Description
id integer
id of the tag to retrieve.
corporation integer
The corporation id
username string
The username of the expert to retrieve

Add Tag

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/tag/"
  -X POST
  -H "Authorization: Bearer xxx-xxx-xxx"

if successful, The above command returns JSON structured like this:

{
  "data": {
    "id" : 2
  },
  "success": true
}

This endpoint adds a Tag for an expert.

HTTP Request

POST https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/tag/

URL Parameters

Parameter Description
corporation integer
The corporation id
username string
The username of the expert

Body Parameters

Parameter Required Description
name required string
tag name

Delete a Specific Tag

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/tag/:id"
  -X DELETE
  -H "Authorization: Bearer xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": {
    "id": 2,
    "deleted" : true
  },
  "success": true
}

This endpoint deletes a specific Tag for an expert.

HTTP Request

DELETE https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/tag/:id

URL Parameters

Parameter Description
id integer
id of the tag to delete
corporation integer
The corporation id
username string
The username of the expert

#Industry

##Get All Industry

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/industry/"
  -X GET
  -H "Authorization: xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": [
    {
      "id": 1,
      "name": "Industry 1"
    },
    {
      "id": 2,
      "name": "Industry 2"
    }
  ],
  "success": true
}

This endpoint retrieves all Industries.

HTTP Request

GET https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/industry/

Parameter Description
corporation integer
The corporation id
username string
The username of the expert to retrieve

Get a Specific Industry

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/industry/:id"
  -X GET
  -H "Authorization: xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": [
    {
      "id": 1,
      "name": "Industry 1"
    }
  ]
}

This endpoint retrieves a specific Industry for an expert.

HTTP Request

GET https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/industry/:id

URL Parameters

Parameter Description
id integer
id of the industry to retrieve.
corporation integer
The corporation id
username string
The username of the expert to retrieve.

#YouTube

##Get All YouTube Media

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/media/youtube"
  -X GET
  -H "Authorization: Bearer xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": [
    {
      "id": 1,
      "title": "Title",
      "description": "description",
      "watch_page_url": "watch page url",
      "thumbnail_url": "thumbnail url",
      "flash_player_url": "flashplayerurl",
      "video_id": "video id",
      "thumbnail_alt_title": null
    },
    {
      "id": 2,
      "title": "Title 2",
      "description": "description 2",
      "watch_page_url": "watch page url",
      "thumbnail_url": "thumbnail url",
      "flash_player_url": "flashplayerurl",
      "video_id": "video id",
      "thumbnail_alt_title": null 
    }
  ],
  "success": true
}

This endpoint retrieves all YouTube media for an expert.

HTTP Request

GET https://public-api.expertfile.com/v2/organization/:corporation/:username/media/youtube

Parameter Description
corporation integer
The corporation id
username string
The username of the expert to retrieve

##Get a Specific YouTube item

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/media/youtube/:id"
  -X GET
  -H "Authorization: Bearer xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": [
    {
      "id": 1,
      "title": "Title",
      "description": "description",
      "watch_page_url": "watch page url",
      "thumbnail_url": "thumbnail url",
      "flash_player_url": "flashplayerurl",
      "video_id": "video id",
      "thumbnail_alt_title": null
    }
  ],
  "success": true
}

This endpoint retrieves a specific YouTube item.

HTTP Request

GET https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/media/youtube/:id

Parameter Description
id integer
id of the youtube item to retrieve
corporation integer
The corporation id
username string
The username of the expert to retrieve

#Vimeo

##Get All Vimeo Media

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/media/vimeo"
  -X GET
  -H "Authorization: Bearer xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": [
    {
      "id": 1,
      "title": "Video title",
      "description": "",
      "url": "http://vimeo.com/1",
      "external_id": "1", //vimeo video id. 
      "thumbnail_small": "http://i.vimeocdn.com/video/1.jpg",
      "thumbnail_alt_title": null
    },
    {
      "id": 2,
      "title": "Video title",
      "description": "",
      "url": "http://vimeo.com/1",
      "external_id": "2",
      "thumbnail_small": "http://i.vimeocdn.com/video/1.jpg",
      "thumbnail_alt_title": null
    }
  ],
  "success": true
}

This endpoint retrieves all Vimeo item for an expert.

HTTP Request

GET https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/media/vimeo

Parameter Description
corporation integer
The corporation id
username string
The username of the expert to retrieve

##Get a Specific Vimeo item

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/media/vimeo/:id"
  -X GET
  -H "Authorization: Bearer xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": [
    {
      "id": 1,
      "title": "Video title",
      "description": "",
      "url": "http://vimeo.com/1",
      "external_id": "1", //vimeo video id. 
      "thumbnail_small": "http://i.vimeocdn.com/video/1.jpg",
      "thumbnail_alt_title": null
    }
  ],
  "success": true
}

This endpoint retrieves a specific Vimeo item.

HTTP Request

GET https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/media/vimeo/:id

Parameter Description
id integer
id of the vimeo item to retrieve
corporation integer
The corporation id
username string
The username of the expert to retrieve

#SlideShare

##Get All SlideShare Media

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/media/slideshare"
  -X GET
  -H "Authorization: Bearer xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": [
    {
      "id": 1,
      "title": "title 1",
      "description": "",
      "url": "slideshare url",
      "embed": "slideshare embed url",
      "thumbnail_url": "thumbnail url",
      "external_id": "1"// slideshare docuement id
    },
    {
      "id": 2,
      "title": "title 2",
      "description": "",
      "url": "slideshare url",
      "embed": "slideshare embed url",
      "thumbnail_url": "thumbnail url",
      "external_id": "1"// slideshare docuement id
    }
  ],
  "success": true
}

This endpoint retrieves all SlideShare media for an expert.

HTTP Request

GET https://public-api.expertfile.com/v2/organization/:corporation/:username/media/slideshare

Parameter Description
corporation integer
The corporation id
username string
The username of the expert to retrieve

##Get a Specific SlideShare media

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/media/slideshare/:id"
  -X GET
  -H "Authorization: Bearer xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": [
    {
      "id": 1,
      "title": "title 1",
      "description": "",
      "url": "slideshare url",
      "embed": "slideshare embed url",
      "thumbnail_url": "thumbnail url",
      "external_id": "1"// slideshare docuement id
    }
  ],
  "success": true
}

This endpoint retrieves all SlideShare media for an expert.

HTTP Request

GET https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/media/slideshare/:id

Parameter Description
id integer
id of the slideshare item to retrieve
corporation integer
The corporation id
username string
The username of the expert to retrieve

#Documents

##Get All Documents

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/media/document"
  -X GET
  -H "Authorization: Bearer xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": [
    {
      "id": 1,
      "title": "Title",
      "description": "description",
      "watch_page_url": "watch page url",
      "thumbnail_url": "thumbnail url",
      "flash_player_url": "flashplayerurl",
      "video_id": "video id",
      "thumbnail_alt_title": null
    },
    {
      "id": 2,
      "title": "Title 2",
      "description": "description 2",
      "watch_page_url": "watch page url",
      "thumbnail_url": "thumbnail url",
      "flash_player_url": "flashplayerurl",
      "video_id": "video id",
      "thumbnail_alt_title": null 
    }
  ],
  "success": true
}

This endpoint retrieves all Documents.

HTTP Request

GET https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/media/document

Parameter Description
corporation integer
The corporation id
username string
The username of the expert to retrieve

##Get a Specific Document

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/media/document/:id"
  -X GET
  -H "Authorization: Bearer xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": [
    {
      "id": 1,
      "title": "Title",
      "description": "description",
      "watch_page_url": "watch page url",
      "thumbnail_url": "thumbnail url",
      "flash_player_url": "flashplayerurl",
      "video_id": "video id",
      "thumbnail_alt_title": null
    }
  ],
  "success": true
}

This endpoint retrieves a specific Document.

HTTP Request

GET https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/media/document/:id

Parameter Description
id integer
id of the document item to retrieve
corporation integer
The corporation id
username string
The username of the expert to retrieve

#Photo

##Get All Photos

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/media/photo"
  -X GET
  -H "Authorization: Bearer xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": [
    {
      "id": 1,
      "title": "Title",
      "description": "description",
      "watch_page_url": "watch page url",
      "thumbnail_url": "thumbnail url",
      "flash_player_url": "flashplayerurl",
      "video_id": "video id",
      "thumbnail_alt_title": null
    },
    {
      "id": 2,
      "title": "Title 2",
      "description": "description 2",
      "watch_page_url": "watch page url",
      "thumbnail_url": "thumbnail url",
      "flash_player_url": "flashplayerurl",
      "video_id": "video id",
      "thumbnail_alt_title": null 
    }
  ],
  "success": true
}

This endpoint retrieves all Photos for an expert.

HTTP Request

GET https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/media/photo

Parameter Description
corporation integer
The corporation id
username string
The username of the expert to retrieve

##Get a Specific Photo

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/media/photo/:id"
  -X GET
  -H "Authorization: Bearer xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": [
    {
      "id": 1,
      "title": "Title",
      "description": "description",
      "watch_page_url": "watch page url",
      "thumbnail_url": "thumbnail url",
      "flash_player_url": "flashplayerurl",
      "video_id": "video id",
      "thumbnail_alt_title": null
    }
  ],
  "success": true
}

This endpoint retrieves a specific Photo.

HTTP Request

GET https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/media/photo/:id

Parameter Description
id integer
id of the photo to retrieve
corporation integer
The corporation id
username string
The username of the expert to retrieve

#Video

##Get All Videos

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/media/video"
  -X GET
  -H "Authorization: Bearer xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": [
    {
      "id": 1,
      "title": "Title",
      "description": "description",
      "watch_page_url": "watch page url",
      "thumbnail_url": "thumbnail url",
      "flash_player_url": "flashplayerurl",
      "video_id": "video id",
      "thumbnail_alt_title": null
    },
    {
      "id": 2,
      "title": "Title 2",
      "description": "description 2",
      "watch_page_url": "watch page url",
      "thumbnail_url": "thumbnail url",
      "flash_player_url": "flashplayerurl",
      "video_id": "video id",
      "thumbnail_alt_title": null 
    }
  ],
  "success": true
}

This endpoint retrieves all Videos for an expert.

HTTP Request

GET https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/media/video

Parameter Description
corporation integer
The corporation id
username string
The username of the expert to retrieve

##Get a Specific Video

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/media/video/:id"
  -X GET
  -H "Authorization: Bearer xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": [
    {
      "id": 1,
      "title": "Title",
      "description": "description",
      "watch_page_url": "watch page url",
      "thumbnail_url": "thumbnail url",
      "flash_player_url": "flashplayerurl",
      "video_id": "video id",
      "thumbnail_alt_title": null
    }
  ],
  "success": true
}

This endpoint retrieves a specific Video.

HTTP Request

GET https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/media/video/:id

Parameter Description
id integer
id of the video to retrieve
corporation integer
The corporation id
username string
The username of the expert to retrieve

#CV

##Get CV

curl "https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/cv"
  -X GET
  -H "Authorization: Bearer xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": [
    {
      {
        "id": "ID",
        "url":"url",
        "document_url":"document url"}
    }
  ],
  "success": true
}

This endpoint retrieves a cv.

HTTP Request

GET https://public-api.expertfile.com/v2/organization/:corporation/expert/:username/cv

Parameter Description
corporation integer
The corporation id
username string
The username of the expert to retrieve

Staff

Get All Employees

curl "https://public-api.expertfile.com/v2/organization/:corporation/employee"
  -X GET
  -H "Authorization: Bearer xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": {
    "staff": [
      {
        "username": "myusername",
        "corporation": "mycorporation",
        "tagline": "My tagline",
        "avatar": {
          "small": "my small avatar url",
          "medium": "my medium avatar url",
          "large": "my large avatar url",
          "original": "my original avatar url"
        }
      }
    ],
    "total": 12
  },
  "success": true
}

This endpoint retrieves all Employees. Please note that this endpoint returns both staff users and experts.

To retreive the original photo uploaded to ExpertFile, access "avatar.original".

HTTP Request

GET https://public-api.expertfile.com/v2/organization/:corporation/employee

Url Parameters

Parameter Desription
corporation integer
The corporation id

Query Parameters

Parameter Default Description
q - string
search query.
access public string
This can be public or private.
page_size 10 integer
no. of experts to return.
page_from 0 integer
countries - string
companies - string
fields - string
sort name string
name or featured.
searchfield - string
fullname to query only name field.

Get a Specific Staff

curl "https://public-api.expertfile.com/v2/organization/:corporation/staff/username"
  -X GET
  -H "Authorization: Bearer xxx-xxx-xxx"

The above command returns JSON structured like this:

{
    "data": {
        "account": [
            {
                "id": 1,
                "firstname": "firstname",
                "lastname": "lastname",
                "corporation_id": 1,
                "job_title": "job_title",
                "location_city": "location_city",
                "location_state": "location_state",
                "location_country": "location_country",
                "location_postal": "location_postal",
                "location_address": "location_address",
                "location_building": "location_building",
                "location_room": "location_room",
                "email": "myemail@example.com",
                "company": "company",
                "department": "department",
                "phone_number": "phone_number",
                "phone_number_extension": "phone_number_extension",
                "username": "username",
                "is_published": 0
            }
        ],
        "biography": [
            {
                "biography": ""
            }
        ],
        "category": [],
        "corporationProfile": [
          {
            "id": 1,
            "name": "name",
            "user_name": "username",
            "description": "",
            "location_country": "CA",
            "location_state": "ON",
            "location_city": "Toronto",
            "location_postal": "M5G 1L7",
            "location_address": "address",
            "website": "myswebsite.com",
            "private_username": "xxx"
          }
        ],
        "education": [],
        "language": [],
        "link": [],
        "tag": [],
        "tagline": [
            {
                "tagline": ""
            }
        ],
        "avatar": []
    },
    "success": true
}

This endpoint retrieves a specific Staff User.

HTTP Request

GET https://public-api.expertfile.com/v2/organization/:corporation/staff/:username

URL Parameters

Parameter Description
corporation integer
The corporation id
username string
The username of the staff to retrieve

##Add a Staff User

curl "https://public-api.expertfile.com/v2/organization/:corporation/staff"
  -X POST
  -H "Authorization: Bearer xxx-xxx-xxx"

The above command returns JSON structured like this:

{
    "data": {
        "username": "username",
        "inserted": true
    },
    "success": true
}

HTTP Request

POST https://public-api.expertfile.com/v2/organization/:corporation/staff

URL Parameters

Parameter Description
corporation integer
The corporation id

Body Parameters

Parameter Required Description
firstname true string
first name
lastname true string
last name
job_title true string
job title
email true string
email address
company true string
company
department optional string
department
phone_number optional string
phone number
phone_number_extension optional string
phone number extension
location_city optional string
city
location_state optional string
state or province
location_country optional string
country
location_postal optional string
postal code
location_address optional string
address
location_building optional string
building
location_room optional string
room

Update a Staff User

curl "https://public-api.expertfile.com/v2/organization/:corporation/staff/:username"
  -X PUT
  -H "Authorization: Bearer xxx-xxx-xxx"

if successful, The above command returns JSON structured like this:

{
  "data": {
    "user": "you.username",
    "updated": true
  },
  "success": true
}

This endpoint updates a Staff User.

HTTP Request

PUT https://public-api.expertfile.com/v2/organization/:corporation/staff

URL Parameters

Parameter Description
corporation integer
The corporation id
username string
The username of the staff user

Body Parameters

Parameter Required Description
firstname true string
first name
lastname true string
last name
job_title true string
job title
email true string
email address
company true string
company
department optional string
department
phone_number optional string
phone number
phone_number_extension optional string
phone number extension
location_city optional string
city
location_state optional string
state or province
location_country optional string
country
location_postal optional string
postal code
location_address optional string
address
location_building optional string
building
location_room optional string
room
is_private optional integer
1 or 0
is_published optional integer
1 or 0

Delete a Specific Staff

curl "https://public-api.expertfile.com/v2/organization/:corporation/staff/:id"
  -X DELETE
  -H "Authorization: Bearer xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data" : {
    "id": 2,
    "deleted" : true
  },
  "success": true
}

This endpoint deletes a specific Staff User.

HTTP Request

DELETE https://public-api.expertfile.com/v2/organization/:corporation/staff/:username

URL Parameters

Parameter Description
corporation integer
The corporation id
username string
The username of the staff user to retrieve

#Biography

##Get Biography

curl "https://public-api.expertfile.com/v2/organization/:corporation/staff/:username/biography"
  -X GET
  -H "Authorization: xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": [
    {
      "biography" : "your biography"
    }
  ]
}

This endpoint retrieves an staff user's biography

HTTP Request

GET https://public-api.expertfile.com/v2/organization/:corporation/staff/:username/biography

URL Parameters

Parameter Description
corporation integer
The corporation id
username string
The username of the staff

Add Biography

curl "https://public-api.expertfile.com/v2/organization/:corporation/staff/:username/biography"
  -X POST
  -H "Authorization: Bearer xxx-xxx-xxx"

if successful, The above command returns JSON structured like this:

{
  "data": [
    {
      { "id" : null }
    }
  ]
}

This endpoint adds a Biography.

HTTP Request

POST https://public-api.expertfile.com/v2/organization/:corporation/staff/:username/biography

URL Parameters

Parameter Description
corporation integer
The corporation id
username string
The username of the staff

Body Parameters

Parameter Required Description
description optional string
biography content

#Tagline

##Get Tagline

curl "https://public-api.expertfile.com/v2/organization/:corporation/staff/:username/tagline"
  -X GET
  -H "Authorization: xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": [
    {
      "tagline" : "your tagline"
    }
  ]
}

This endpoint retrieves an staff user's tagline

HTTP Request

GET https://public-api.expertfile.com/v2/organization/:corporation/staff/:username/tagline

URL Parameters

Parameter Description
corporation integer
The corporation id
username string
The username of the staff

Add Tagline

curl "https://public-api.expertfile.com/v2/organization/:corporation/staff/:username/tagline"
  -X POST
  -H "Authorization: Bearer xxx-xxx-xxx"

if successful, The above command returns JSON structured like this:

{
  "data": [
    {
      "tagline" : {
        { "id" : null }
      }
    }
  ]
}

This endpoint adds a tagline.

HTTP Request

POST https://public-api.expertfile.com/v2/organization/:corporation/staff/:username/tagline

URL Parameters

Parameter Description
corporation integer
The corporation id
username string
The username of the staff

Body Parameters

Parameter Required Description
tagline optional string
tagline content

HTTP Request

GET https://public-api.expertfile.com/v2/organization/:corporation/staff/:username/link

URL Parameters

Parameter Description
corporation integer
The corporation id
username string
The username of the staff to retrieve

#Link

##Get All Links

curl "https://public-api.expertfile.com/v2/organization/:corporation/staff/:username/link"
  -X GET
  -H "Authorization: xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": [
    {
      "id": 1,
      "name": "link name",
      "url": "http://www.example.com/",
    },
    {
      "id": 2,
      "name": "link name1",
      "url": "http://www.example.com/1",
    }
  ]
}

This endpoint retrieves all Links.

HTTP Request

GET https://public-api.expertfile.com/v2/organization/:corporation/staff/:username/link

URL Parameters

Parameter Description
corporation integer
The corporation id
username string
The username of the staff to retrieve
curl "https://public-api.expertfile.com/v2/organization/:corporation/staff/:username/link/:id"
  -X GET
  -H "Authorization: Bearer xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": [
    {
      "id": 1,
      "name": "link name",
      "url": "http://linkurl.com"
    }
  ],
  "success": true
}

This endpoint retrieves a specific Link.

HTTP Request

GET https://public-api.expertfile.com/v2/organization/:corporation/staff/:username/link/:id

URL Parameters

Parameter Description
id integer
id of the link to retrieve.
corporation integer
The corporation id
username string
The username of the staff to retrieve
curl "https://public-api.expertfile.com/v2/organization/:corporation/staff/:username/link/"
  -X POST
  -H "Authorization: xxx-xxx-xxx"

if successful, The above command returns JSON structured like this:

{
  "data": {
    "id" : 2
  },
  "success": true
}

This endpoint adds a link for a staff user.

HTTP Request

POST https://public-api.expertfile.com/v2/organization/:corporation/staff/:username/link/

URL Parameters

Parameter Description
corporation integer
The corporation id
username string
The username of the staff

Body Parameters

Parameter Required Description
name true string
name of the link
url true string
the actual url
curl "https://public-api.expertfile.com/v2/organization/:corporation/staff/:username/link/:id"
  -X PUT
  -H "Authorization: Bearer xxx-xxx-xxx"

if successful, The above command returns JSON structured like this:

{
  "data": {
    "id": 2,
    "updated": true
  },
  "success": true
}

This endpoint updates a link for a staff user.

HTTP Request

PUT https://public-api.expertfile.com/v2/organization/:corporation/staff/:username/link/:id

URL Parameters

Parameter Description
id integer
id of the link
corporation integer
The corporation id
username string
The username of the staff

Body Parameters

Parameter Required Description
name optional string
name of the link
url optional string
the actual url
curl "https://public-api.expertfile.com/v2/organization/:corporation/staff/:username/link/:id"
  -X DELETE
  -H "Authorization: xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": {
    "id": 2,
    "deleted": true
  },
  "success": true
}

This endpoint deletes a specific link.

HTTP Request

DELETE https://public-api.expertfile.com/v2/organization/:corporation/staff/:username/link/:id

URL Parameters

Parameter Description
id integer
The ID of the link
corporation integer
The corporation id
username string
The username of the staff

#Education

##Get All Education

curl "https://public-api.expertfile.com/v2/organization/:corporation/staff/:username/education"
  -X GET
  -H "Authorization: xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": [
    {
      "id": 1,
      "institution": "My Institution",
      "degree": "My Degree",
      "description": "",
      "major": "My major",
      "date": 1998 // year 
    },
    {
      "id": 2,
      "institution": "My 2nd Institution",
      "degree": "My 2nd Degree",
      "description": "",
      "major": "My 2nd major",
      "date": 1998
    }
  ],
  "success": true
}

This endpoint retrieves all Education.

HTTP Request

GET https://public-api.expertfile.com/v2/organization/:corporation/staff/:username/education

Parameter Description
corporation integer
The corporation id
username string
The username of the staff to retrieve

Get a Specific Education

curl "https://public-api.expertfile.com/v2/organization/:corporation/staff/:username/education/:id"
  -X GET
  -H "Authorization: xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": [
    {
      "id": 1,
      "institution": "My Institution",
      "degree": "My Degree",
      "description": "",
      "major": "My major",
      "date": 1998
    }
  ],
  "success": true
}

This endpoint retrieves a specific Education.

HTTP Request

GET https://public-api.expertfile.com/v2/organization/:corporation/staff/:username/:id

URL Parameters

Parameter Description
id integer
Id of the link to retrieve.
corporation integer
The corporation id
username string
The username of the staff to retrieve

Add Education

curl "https://public-api.expertfile.com/v2/organization/:corporation/staff/:username/education/"
  -X POST
  -H "Authorization: xxx-xxx-xxx"

if successful, The above command returns JSON structured like this:

{
  "data": {
    "id" : 2
  },
  "success": true
}

This endpoint adds an Education for a staff user.

HTTP Request

POST https://public-api.expertfile.com/v2/organization/:corporation/staff/:username/education/

URL Parameters

Parameter Description
corporation integer
The corporation id
username string
The username of the staff

Body Parameters

Parameter Required Description
institution required string
name of the instituion
degree required string
degree obtained.
major optional string
Level of study. Bachelors/Masters/Phd
description optional string
additional information for the degree
date optional integer
year of graduation. Enter '1998' if graduation year is 1998

Update an Education

curl "https://public-api.expertfile.com/v2/organization/:corporation/staff/:username/education/:id"
  -X PUT
  -H "Authorization: xxx-xxx-xxx"

if successful, The above command returns JSON structured like this:

{
  "data": {
    "id": 2,
    "updated": true
  },
  "success": true
}

This endpoint updates an Education for a staff user.

HTTP Request

PUT https://public-api.expertfile.com/v2/organization/:corporation/staff/:username/education/:id

URL Parameters

Parameter Description
corporation integer
The corporation id
username string
The username of the staff

Body Parameters

Parameter Required Description
institution optional string
name of the instituion
degree optional string
degree obtained.
major optional string
Level of study. Bachelors/Masters/Phd
description optional string
additional information for the degree
date optional integer
year of graduation. Enter '1998' if graduation year is 1998

Delete a Specific Education

curl "https://public-api.expertfile.com/v2/organization/:corporation/staff/:username/education/:id"
  -X DELETE
  -H "Authorization: xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": {
    "id": 2,
    "deleted": true
  },
  "success": true
}

This endpoint deletes a specific Education.

HTTP Request

DELETE https://public-api.expertfile.com/v2/organization/:corporation/staff/:username/accomplishment/:id

URL Parameters

Parameter Description
id integer
The ID of the Education to delete
corporation integer
The corporation id
username string
The username of the staff

#Languages

##Get All languages

curl "https://public-api.expertfile.com/v2/organization/:corporation/staff/:username/language/"
  -X GET
  -H "Authorization: Bearer xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": [
    {
      "id": 1,
      "name": "Language1"
    },
    {
      "id": 2,
      "name": "Language2"
    }
  ],
  "success": true
}

This endpoint retrieves all Languages.

HTTP Request

GET https://public-api.expertfile.com/v2/organization/:corporation/staff/:username/language/

Parameter Description
corporation integer
The corporation id
username string
The username of the staff to retrieve

Get a Specific Languages

curl "https://public-api.expertfile.com/v2/organization/:corporation/staff/:username/language/:id"
  -X GET
  -H "Authorization: Bearer xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": [
    {
      "id": 1,
      "name": "Language1"
    }
  ],
  "success": true
}

This endpoint retrieves a specific Language.

HTTP Request

GET https://public-api.expertfile.com/v2/organization/:corporation/staff/:username/language/:id

URL Parameters

Parameter Description
id integer
id of the language to retrieve.
corporation integer
The corporation id
username string
The username of the staff to retrieve

Add Language

curl "https://public-api.expertfile.com/v2/organization/:corporation/staff/:username/language/"
  -X POST
  -H "Authorization: xxx-xxx-xxx"

if successful, The above command returns JSON structured like this:

{
  "data": {
    "id" : 2
  },
  "success": true
}

This endpoint adds a Language for a staff user.

HTTP Request

POST https://public-api.expertfile.com/v2/organization/:corporation/staff/:username/language/

URL Parameters

Parameter Description
corporation integer
The corporation id
username string
The username of the staff

Body Parameters

Parameter Required Description
name required string
langauge name

##Update a Language

curl "https://public-api.expertfile.com/v2/organization/:corporation/staff/:username/language/:id"
  -X PUT
  -H "Authorization: xxx-xxx-xxx"

if successful, The above command returns JSON structured like this:

{
  "data": {
    "id" : 2,
    "updated": true
  },
  "success": true
}

This endpoint updates a Language for a staff user.

HTTP Request

PUT https://public-api.expertfile.com/v2/organization/:corporation/staff/:username/language/:id

URL Parameters

Parameter Description
corporation integer
The corporation id
username string
The username of the staff

Body Parameters

Parameter Required Description
name optional string
langauge name

Delete a Specific Language

curl "https://public-api.expertfile.com/v2/organization/:corporation/staff/:username/language/:id"
  -X DELETE
  -H "Authorization: xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": {
    "id": 2,
    "deleted" : true
  },
  "success": true
}

This endpoint deletes a specific Language.

HTTP Request

DELETE https://public-api.expertfile.com/v2/organization/:corporation/staff/:username/language/:id

URL Parameters

Parameter Description
id integer
ID of the research focus to delete
corporation integer
The corporation id
username integer
The username of the staff to retrieve

#Categories

##Get All Categories

curl "https://public-api.expertfile.com/v2/organization/:corporation/staff/:username/category/"
  -X GET
  -H "Authorization: Bearer xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": [
    {
      "id": 1,
      "name": "category 1"
    },
    {
      "id": 2,
      "name": "category 2"
    }
  ],
  "success": true
}

This endpoint retrieves all Categories for a staff user.

HTTP Request

GET https://public-api.expertfile.com/v2/organization/:corporation/staff/:username/category/

Parameter Description
corporation integer
The corporation id
username string
The username of the staff to retrieve

Get a Specific Category

curl "https://public-api.expertfile.com/v2/organization/:corporation/staff/:username/category/:id"
  -X GET
  -H "Authorization: Bearer xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": [
     {
      "id": 1,
      "name": "category 1"
     }
  ],
  "success": true
}

This endpoint retrieves a specific Category for a staff user.

HTTP Request

GET https://public-api.expertfile.com/v2/organization/:corporation/staff/:username/category/:id

URL Parameters

Parameter Description
id integer
id of the category to retrieve.
corporation integer
The corporation id
username string
The username of the staff to retrieve

Add Category

curl "https://public-api.expertfile.com/v2/organization/:corporation/staff/:username/category/"
  -X POST
  -H "Authorization: Bearer xxx-xxx-xxx"

if successful, The above command returns JSON structured like this:

{
  "data": {
    "id" : 2
  },
  "success": true
}

This endpoint adds a Category for a staff user.

HTTP Request

POST https://public-api.expertfile.com/v2/organization/:corporation/staff/:username/category/

URL Parameters

Parameter Description
corporation integer
The corporation id
username string
The username of the staff

Body Parameters

Parameter Required Description
name required string
category name

Delete a Specific Category

curl "https://public-api.expertfile.com/v2/organization/:corporation/staff/:username/category/:id"
  -X DELETE
  -H "Authorization: Bearer xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": {
    "id": 2,
    "deleted" : true
  },
  "success": true
}

This endpoint deletes a specific Category for a staff user.

HTTP Request

DELETE https://public-api.expertfile.com/v2/organization/:corporation/staff/:username/category/:id

URL Parameters

Parameter Description
id integer
id of the category to delete
corporation integer
The corporation id
username string
The username of the staff

#Tags

##Get All Tags

curl "https://public-api.expertfile.com/v2/organization/:corporation/staff/:username/tag/"
  -X GET
  -H "Authorization: Bearer xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": [
    {
      "id": 1,
      "name": "tag 1"
    },
    {
      "id": 2,
      "name": "tag 2"
    }
  ],
  "success": true
}

This endpoint retrieves all Tags for a staff user.

HTTP Request

GET https://public-api.expertfile.com/v2/organization/:corporation/staff/:username/tag/

Parameter Description
corporation integer
The corporation id
username string
The username of the staff to retrieve

Get a Specific Tag

curl "https://public-api.expertfile.com/v2/organization/:corporation/staff/:username/tag/:id"
  -X GET
  -H "Authorization: Bearer xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": [
     {
      "id": 1,
      "name": "tag 1"
     }
  ],
  "success": true
}

This endpoint retrieves a specific Tag for a staff user.

HTTP Request

GET https://public-api.expertfile.com/v2/organization/:corporation/staff/:username/tag/:id

URL Parameters

Parameter Description
id integer
id of the tag to retrieve.
corporation integer
The corporation id
username string
The username of the staff to retrieve

Add Tag

curl "https://public-api.expertfile.com/v2/organization/:corporation/staff/:username/tag/"
  -X POST
  -H "Authorization: Bearer xxx-xxx-xxx"

if successful, The above command returns JSON structured like this:

{
  "data": {
    "id" : 2
  },
  "success": true
}

This endpoint adds a Tag for a staff user.

HTTP Request

POST https://public-api.expertfile.com/v2/organization/:corporation/staff/:username/tag/

URL Parameters

Parameter Description
corporation integer
The corporation id
username string
The username of the staff

Body Parameters

Parameter Required Description
name required string
tag name

Delete a Specific Tag

curl "https://public-api.expertfile.com/v2/organization/:corporation/staff/:username/tag/:id"
  -X DELETE
  -H "Authorization: Bearer xxx-xxx-xxx"

The above command returns JSON structured like this:

{
  "data": {
    "id": 2,
    "deleted" : true
  },
  "success": true
}

This endpoint deletes a specific Tag for a staff user.

HTTP Request

DELETE https://public-api.expertfile.com/v2/organization/:corporation/staff/:username/tag/:id

URL Parameters

Parameter Description
id integer
id of the tag to delete
corporation integer
The corporation id
username string
The username of the staff

Inquiry

General

Will send a general inquiry to the expert, agent(depending on notification settings found in app) and mailing list recipients.

To send a general inquiry, use this code:

# With shell, you can just pass the correct header with each request
 curl "https://public-api.expertfile.com/v2/organization/:corporation/inquiry/general" 
 -X POST 
 -H "Authorization: Bearer xxx-xxx-xxx" 
 -d "message=<MESSAGE>&email=<EMAIL>&lastname=<LASTNAME>&firstname=<FIRSTNAME>&location_city=<CITY>&location_country=<COUNTRY_CODE>&location_state=<STATE_CODE>&username=<USERNAME>"

The above command returns JSON structured like this:


{
  "data" : {
    "id" : <INQUIRY_ID>
  } , 
  "success": true
}

HTTP Request

POST https://public-api.expertfile.com/v2/organization/:corporation/inquiry/general

Body Parameters

Parameter Required Description
firstname true string
Sender first name
lastname true string
Sender last name
email true string
Sender email
phone false string
Sender phone number
website false string
Sender website
organization false string
Sender organization
message true string
Sender message
location_city true string
Sender city
location_state true string
Sender state/province(if country is Canada or U.S.A valid state or province codes must be passed(See Helper->State/Province section for list).
location_country true string
Sender country(See Helper->Country/Province section for list)
username true string
Recipient username(may only send to experts belonging to organization)

Event

Will send a event inquiry to the expert, agent(depending on notification settings found in app) and mailing list recipients.

To send a event inquiry, use this code:

# With shell, you can just pass the correct header with each request
 curl "https://public-api.expertfile.com/v2/organization/:corporation/inquiry/event" 
 -X POST 
 -H "Authorization: Bearer xxx-xxx-xxx" 
 -d "message=<MESSAGE>&email=<EMAIL>&lastname=<LASTNAME>&firstname=<FIRSTNAME>&location_city=<CITY>&location_country=<COUNTRY_CODE>&location_state=<STATE_CODE>&username=<USERNAME>&event_name=<EVENT_NAME>&event_location=<EVENT_LOCATION>&event_date=<EVENT_DATE>&event_description=<EVENT_DESCRIPTION>"

The above command returns JSON structured like this:


{
  "data" : {
    "id" : <INQUIRY_ID>
  } , 
  "success": true
}

HTTP Request

POST https://public-api.expertfile.com/v2/organization/:corporation/inquiry/event

Body Parameters

Parameter Required Description
firstname true string
Sender first name
lastname true string
Sender last name
email true string
Sender email
phone false string
Sender phone number
website false string
Sender website
organization false string
Sender organization
message true string
Sender message
location_city true string
Sender city
location_state true string
Sender state/province(if country is Canada or U.S.A valid state or province codes must be passed(See Helper->State/Province section for list).
location_country true string
Sender country(See Helper->Country/Province section for list)
username true string
Recipient username(may only send to experts belonging to organization)
event_name true string
Event name
event_location true string
Event Location
event_date true string
your Event date(must be sent as UNIX timestamp)
event_description true string
Event Description

Media

Will send a media inquiry to the expert, agent(depending on notification settings found in app) and mailing list recipients.

To send a media inquiry, use this code:

# With shell, you can just pass the correct header with each request
 curl "https://public-api.expertfile.com/v2/organization/:corporation/inquiry/media" 
 -X POST 
 -H "Authorization: Bearer xxx-xxx-xxx" 
 -d "message=<MESSAGE>&email=<EMAIL>&lastname=<LASTNAME>&firstname=<FIRSTNAME>&location_city=<CITY>&location_country=<COUNTRY_CODE>&location_state=<STATE_CODE>&username=<USERNAME>&media_position=<MEDIA_POSITION>&media_type=<MEDIA_TYPE>&media_deadline=<MEDIA_DEADLINE>"

The above command returns JSON structured like this:


{
  "data" : {
    "id" : <INQUIRY_ID>
  } , 
  "success": true
}

HTTP Request

POST https://public-api.expertfile.com/v2/organization/:corporation/inquiry/media

Body Parameters

Parameter Required Description
firstname true string
Sender first name
lastname true string
Sender last name
email true string
Sender email
phone false string
Sender phone number
website false string
Sender website
organization false string
Sender organization
message true string
Sender message
location_city true string
Sender city
location_state true string
Sender state/province(if country is Canada or U.S.A valid state or province codes must be passed(See Helper->State/Province section for list).
location_country true string
Sender country(See Helper->Country/Province section for list)
username true string
Recipient username(may only send to experts belonging to organization)
media_position true string
Media Postion(valid input: 'reporter','editor','news_director','researcher', 'other')
media_type true string
Media Type(valid input: 'print','online','tv','radio')
media_deadline true string
Media deadline(must be sent as UNIX timestamp)

Partnership

Will send a partnership inquiry to the expert, agent(depending on notification settings found in app) and mailing list recipients.

To send a partnership inquiry, use this code:

# With shell, you can just pass the correct header with each request
curl "https://public-api.expertfile.com/v2/organization/:corporation/inquiry/partnership" 
-X POST 
-H "Authorization: Bearer xxx-xxx-xxx" 
-d "message=<MESSAGE>&email=<EMAIL>&lastname=<LASTNAME>&firstname=<FIRSTNAME>&location_city=<CITY>&location_country=<COUNTRY_CODE>&location_state=<STATE_CODE>&username=<USERNAME>&partner_organization_type=<TYPE>&partner_focus=<FOCUS>"

The above command returns JSON structured like this:


{
  "data" : {
    "id" : <INQUIRY_ID>
  } , 
  "success": true
}

HTTP Request

POST https://public-api.expertfile.com/v2/organization/:corporation/inquiry/partnership

Body Parameters

Parameter Required Description
firstname true string
Sender first name
lastname true string
Sender last name
email true string
Sender email
phone false string
Sender phone number
website false string
Sender website
organization false string
Sender organization
message true string
Sender message
location_city true string
Sender city
location_state true string
Sender state/province(if country is Canada or U.S.A valid state or province codes must be passed(See Helper->State/Province section for list).
location_country true string
Sender country(See Helper->Country/Province section for list)
username true string
Recipient username(may only send to experts belonging to organization)
partner_organization_type true string
Media Postion(valid input: 'corporate', 'government', 'ngo', 'not_for_profit', 'other')
partner_focus true string
Media Type(valid input: 'business_development', 'corporate', 'fundraising', 'licensing', 'research', 'sponsorship', 'technology', 'other')

Admission

Will send a admission inquiry to the expert, agent(depending on notification settings found in app) and mailing list recipients.

To send a partnership inquiry, use this code:

# With shell, you can just pass the correct header with each request
curl "https://public-api.expertfile.com/v2/organization/:corporation/inquiry/admission" 
-X POST 
-H "Authorization: Bearer xxx-xxx-xxx" 
-d "message=<MESSAGE>&email=<EMAIL>&lastname=<LASTNAME>&firstname=<FIRSTNAME>&location_city=<CITY>&location_country=<COUNTRY_CODE>&location_state=<STATE_CODE>&username=<USERNAME>&admission_type=<TYPE>&admission_program_name=<PROGRAM_NAME>&admission_faculty=<FACULTY>"

The above command returns JSON structured like this:


{
  "data" : {
    "id" : <INQUIRY_ID>
  } , 
  "success": true
}

HTTP Request

POST https://public-api.expertfile.com/v2/organization/:corporation/inquiry/admission

Body Parameters

Parameter Required Description
firstname true string
Sender first name
lastname true string
Sender last name
email true string
Sender email
phone false string
Sender phone number
website false string
Sender website
organization false string
Sender organization
message true string
Sender message
location_city true string
Sender city
location_state true string
Sender state/province(if country is Canada or U.S.A valid state or province codes must be passed(See Helper->State/Province section for list).
location_country true string
Sender country(See Helper->Country/Province section for list)
username true string
Recipient username(may only send to experts belonging to organization)
admission_type true string
Admission Type(valid input: 'undergraduate', 'graduate')
admission_program_name true string
Admission Program Name
admission_faculty true string
Admission Faculty

Research

Will send a research inquiry to the expert, agent(depending on notification settings found in app) and mailing list recipients.

To send a research inquiry, use this code:

# With shell, you can just pass the correct header with each request
curl "https://public-api.expertfile.com/v2/organization/:corporation/inquiry/research" 
-X POST 
-H "Authorization: Bearer xxx-xxx-xxx" 
-d "message=<MESSAGE>&email=<EMAIL>&lastname=<LASTNAME>&firstname=<FIRSTNAME>&location_city=<CITY>&location_country=<COUNTRY_CODE>&location_state=<STATE_CODE>&username=<USERNAME>&research_area=<AREA>&research_stage_in_process=<PROCESS>&research_deadline=<DEADLINE>"

The above command returns JSON structured like this:


{
  "data" : {
    "id" : <INQUIRY_ID>
  } , 
  "success": true
}

HTTP Request

POST https://public-api.expertfile.com/v2/organization/:corporation/inquiry/research

Body Parameters

Parameter Required Description
firstname true string
Sender first name
lastname true string
Sender last name
email true string
Sender email
phone false string
Sender phone number
website false string
Sender website
organization false string
Sender organization
message true string
Sender message
location_city true string
Sender city
location_state true string
Sender state/province(if country is Canada or U.S.A valid state or province codes must be passed(See Helper->State/Province section for list).
location_country true string
Sender country(See Helper->Country/Province section for list)
username true string
Recipient username(may only send to experts belonging to organization)
research_area true string
Research Area
research_stage_in_process true string
Research Stage(valid input: 'collaboration', 'funding', 'partnership', 'other')
research_deadline false string
Research Deadline

Business

Will send a business inquiry to the expert, agent(depending on notification settings found in app) and mailing list recipients.

To send a business inquiry, use this code:

# With shell, you can just pass the correct header with each request
curl "https://public-api.expertfile.com/v2/organization/:corporation/inquiry/business" 
-X POST 
-H "Authorization: Bearer xxx-xxx-xxx" 
-d "message=<MESSAGE>&email=<EMAIL>&lastname=<LASTNAME>&firstname=<FIRSTNAME>&location_city=<CITY>&location_country=<COUNTRY_CODE>&location_state=<STATE_CODE>&username=<USERNAME>&business_opportunity_type=<TYPE>"

The above command returns JSON structured like this:


{
  "data" : {
    "id" : <INQUIRY_ID>
  } , 
  "success": true
}

HTTP Request

POST https://public-api.expertfile.com/v2/organization/:corporation/inquiry/business

Body Parameters

Parameter Required Description
firstname true string
Sender first name
lastname true string
Sender last name
email true string
Sender email
phone false string
Sender phone number
website false string
Sender website
organization false string
Sender organization
message true string
Sender message
location_city true string
Sender city
location_state true string
Sender state/province(if country is Canada or U.S.A valid state or province codes must be passed(See Helper->State/Province section for list).
location_country true string
Sender country(See Helper->Country/Province section for list)
username true string
Recipient username(may only send to experts belonging to organization)
business_opportunity_type true string
Business Stage(valid input: 'consulting_engagement', 'new_ventures/partnerships', 'business_deals', 'corporate_training')

Donor

Will send a donor inquiry to the expert, agent(depending on notification settings found in app) and mailing list recipients.

To send a donor inquiry, use this code:

# With shell, you can just pass the correct header with each request
curl "https://public-api.expertfile.com/v2/organization/:corporation/inquiry/donor" 
-X POST 
-H "Authorization: Bearer xxx-xxx-xxx" 
-d "message=<MESSAGE>&email=<EMAIL>&lastname=<LASTNAME>&firstname=<FIRSTNAME>&location_city=<CITY>&location_country=<COUNTRY_CODE>&location_state=<STATE_CODE>&username=<USERNAME>&donor_type=<TYPE>&donor_focus=<FOCUS>"

The above command returns JSON structured like this:


{
  "data" : {
    "id" : <INQUIRY_ID>
  } , 
  "success": true
}

HTTP Request

POST https://public-api.expertfile.com/v2/organization/:corporation/inquiry/donor

Body Parameters

Parameter Required Description
firstname true string
Sender first name
lastname true string
Sender last name
email true string
Sender email
phone false string
Sender phone number
website false string
Sender website
organization false string
Sender organization
message true string
Sender message
location_city true string
Sender city
location_state true string
Sender state/province(if country is Canada or U.S.A valid state or province codes must be passed(See Helper->State/Province section for list).
location_country true string
Sender country(See Helper->Country/Province section for list)
username true string
Recipient username(may only send to experts belonging to organization)
donor_type true string
Donor Type(valid input: 'corporate','government','ngo','not_for_profit', 'other')
donor_focus true string
Donor Focus(valid input: 'one_time_gift','recurring_gift','endowments','bequests','other')

Expert Witness

Will send a expert witness inquiry to the expert, agent(depending on notification settings found in app) and mailing list recipients.

To send a donor inquiry, use this code:

# With shell, you can just pass the correct header with each request
curl "https://public-api.expertfile.com/v2/organization/:corporation/inquiry/expertwitness" 
-X POST 
-H "Authorization: Bearer xxx-xxx-xxx" 
-d "message=<MESSAGE>&email=<EMAIL>&lastname=<LASTNAME>&firstname=<FIRSTNAME>&location_city=<CITY>&location_country=<COUNTRY_CODE>&location_state=<STATE_CODE>&username=<USERNAME>&expertwitness_stage_in_process=<PROCESS>&expertwitness_organization_type=<TYPE>"

The above command returns JSON structured like this:


{
  "data" : {
    "id" : <INQUIRY_ID>
  } , 
  "success": true
}

HTTP Request

POST https://public-api.expertfile.com/v2/organization/:corporation/inquiry/expertwitness

Body Parameters

Parameter Required Description
firstname true string
Sender first name
lastname true string
Sender last name
email true string
Sender email
phone false string
Sender phone number
website false string
Sender website
organization false string
Sender organization
message true string
Sender message
location_city true string
Sender city
location_state true string
Sender state/province(if country is Canada or U.S.A valid state or province codes must be passed(See Helper->State/Province section for list).
location_country true string
Sender country(See Helper->Country/Province section for list)
username true string
Recipient username(may only send to experts belonging to organization)
expertwitness_stage_in_process true string
Donor Type(valid input: 'investigation', 'in_litigation', 'approaching_trial','other')
expertwitness_organization_type true string
Donor Focus(valid input: 'legal_firm', 'corporate_legal_department', 'insurance_provider', 'government_agency', 'legal_nurse_consultant', 'other')

Spotlights

Get All Spotlights

curl "https://public-api.expertfile.com/v2/spotlight/:corporation/search"
  -X GET
  -H "Authorization: Bearer xxx-xxx-xxx"

The above command returns JSON structured like this:

{
    "data": {
        "spotlights": [
            {
                "spotlight_title": "title",
                "tags": [],
                "tagged_experts": [],
                "created_date": unixtimestamp,
                "modified_date": unixtimestamp,
                "published_date": unixtimestamp,
                "corporation_id": corporation_id,
                "assets": [],
                "id": id,
                "published": 1,
                "year": "year",
                "year-month": "year-month"
            }
          }
        ],
        "aggregations": {
            "year": {},
            "tagged_experts": [],
            "tags": []
        },
        "total": int
    },
    "success": true
}

This endpoint retrieves all Spotlights.

HTTP Request

GET https://public-api.expertfile.com/v2/spotlight/:corporation/search

Url Parameters

Parameter Desription
corporation integer
The corporation id

Query Parameters

Parameter Default Description
q - string
search query.
status all string
This can be published, unpublished or all.
page_size 10 integer
no. of spotlights to return.
page_from 0 integer
tags all string
array of tags(i.e. ["tag1","tag2"])
tagged all string
array of tags(i.e. ["expert1","expert1"])
month all string
month
year all string
year

Get a Specific Spotlight

curl "https://public-api.expertfile.com/v2/spotlight/:corporation/:id"
  -X GET
  -H "Authorization: Bearer xxx-xxx-xxx"

The above command returns JSON structured like this:

{
    "data": {
        "spotlight": [
            {
                "id": id,
                "title": "title",
                "corporation_id": corporation_id,
                "featured_image": "image_url",
                "enabled": 1,
                "published": 1,
                "published_date": unixtimestamp,
                "created": unixtimestamp,
                "html": "",
                "reading_time": int,
                "tagged_experts": [],
        "tags": []
    },
    "success": true
}

This endpoint retrieves a specific Spotlight.

HTTP Request

GET https://public-api.expertfile.com/v2/spotlight/:corporation/:id

URL Parameters

Parameter Description
corporation integer
The corporation id
id string
The id of the spotlight to retrieve

Helper

Return Fields

These are the valid field names that may be used when sending the fields param to ExpertFile's API.

[
 "accomplishment",
 "accreditation",
 "address",
 "article",
 "avatar_large",
 "avatar_medium",
 "avatar_original",
 "avatar_small",
 "book",
 "building",
 "city",
 "company",
 "corporation_id",
 "corporation_logo",
 "corporation_name",
 "corporation_username",
 "country",
 "course",
 "department",
 "description",
 "email",
 "event_appearance",
 "firstname",
 "fullname",
 "industry",
 "jobtitle",
 "lastname",
 "media_appearance",
 "patent",
 "phone_number",
 "phone_number_extension",
 "postal",
 "research_focus",
 "research_grant",
 "room",
 "slideshare",
 "spotlight",
 "state",
 "tagline",
 "talk",
 "testimonial",
 "topic",
 "username",
 "vimeo",
 "youtube"
 ]

Country

These are the valid country codes and their corresponding names that may be used when sending location_country params to ExpertFile's API.


{
  US : "UNITED STATES",
  CA : "CANADA",
  AF : "AFGHANISTAN",
  AL : "ALBANIA",
  DZ : "ALGERIA",
  AS : "AMERICAN SAMOA",
  AD : "ANDORRA",
  AO : "ANGOLA",
  AI : "ANGUILLA",
  AQ : "ANTARCTICA",
  AG : "ANTIGUA AND BARBUDA",
  AR : "ARGENTINA",
  AM : "ARMENIA",
  AW : "ARUBA",
  AU : "AUSTRALIA",
  AT : "AUSTRIA",
  AZ : "AZERBAIJAN",
  BS : "BAHAMAS",
  BH : "BAHRAIN",
  BD : "BANGLADESH",
  BB : "BARBADOS",
  BY : "BELARUS",
  BE : "BELGIUM",
  BZ : "BELIZE",
  BJ : "BENIN",
  BM : "BERMUDA",
  BT : "BHUTAN",
  BO : "BOLIVIA",
  BA : "BOSNIA AND HERZEGOVINA",
  BW : "BOTSWANA",
  BV : "BOUVET ISLAND",
  BR : "BRAZIL",
  IO : "BRITISH INDIAN OCEAN TERRITORY",
  BN : "BRUNEI DARUSSALAM",
  BG : "BULGARIA",
  BF : "BURKINA FASO",
  BI : "BURUNDI",
  KH : "CAMBODIA",
  CM : "CAMEROON",
  CV : "CAPE VERDE",
  KY : "CAYMAN ISLANDS",
  CF : "CENTRAL AFRICAN REPUBLIC",
  TD : "CHAD",
  CL : "CHILE",
  CN : "CHINA",
  CX : "CHRISTMAS ISLAND",
  CC : "COCOS (KEELING) ISLANDS",
  CO : "COLOMBIA",
  KM : "COMOROS",
  CG : "CONGO",
  CD : "CONGO, THE DEMOCRATIC REPUBLIC OF THE",
  CK : "COOK ISLANDS",
  CR : "COSTA RICA",
  CI : "COTE D IVOIRE",
  HR : "CROATIA",
  CU : "CUBA",
  CY : "CYPRUS",
  CZ : "CZECH REPUBLIC",
  DK : "DENMARK",
  DJ : "DJIBOUTI",
  DM : "DOMINICA",
  DO : "DOMINICAN REPUBLIC",
  TP : "EAST TIMOR",
  EC : "ECUADOR",
  EG : "EGYPT",
  SV : "EL SALVADOR",
  GQ : "EQUATORIAL GUINEA",
  ER : "ERITREA",
  EE : "ESTONIA",
  ET : "ETHIOPIA",
  FK : "FALKLAND ISLANDS (MALVINAS)",
  FO : "FAROE ISLANDS",
  FJ : "FIJI",
  FI : "FINLAND",
  FR : "FRANCE",
  GF : "FRENCH GUIANA",
  PF : "FRENCH POLYNESIA",
  TF : "FRENCH SOUTHERN TERRITORIES",
  GA : "GABON",
  GM : "GAMBIA",
  GE : "GEORGIA",
  DE : "GERMANY",
  GH : "GHANA",
  GI : "GIBRALTAR",
  GR : "GREECE",
  GL : "GREENLAND",
  GD : "GRENADA",
  GP : "GUADELOUPE",
  GU : "GUAM",
  GT : "GUATEMALA",
  GN : "GUINEA",
  GW : "GUINEA-BISSAU",
  GY : "GUYANA",
  HT : "HAITI",
  HM : "HEARD ISLAND AND MCDONALD ISLANDS",
  VA : "HOLY SEE (VATICAN CITY STATE)",
  HN : "HONDURAS",
  HK : "HONG KONG",
  HU : "HUNGARY",
  IS : "ICELAND",
  IN : "INDIA",
  ID : "INDONESIA",
  IR : "IRAN, ISLAMIC REPUBLIC OF",
  IQ : "IRAQ",
  IE : "IRELAND",
  IL : "ISRAEL",
  IT : "ITALY",
  JM : "JAMAICA",
  JP : "JAPAN",
  JO : "JORDAN",
  KZ : "KAZAKSTAN",
  KE : "KENYA",
  KI : "KIRIBATI",
  KP : "KOREA DEMOCRATIC PEOPLES REPUBLIC OF",
  KR : "KOREA REPUBLIC OF",
  KW : "KUWAIT",
  KG : "KYRGYZSTAN",
  LA : "LAO PEOPLES DEMOCRATIC REPUBLIC",
  LV : "LATVIA",
  LB : "LEBANON",
  LS : "LESOTHO",
  LR : "LIBERIA",
  LY : "LIBYAN ARAB JAMAHIRIYA",
  LI : "LIECHTENSTEIN",
  LT : "LITHUANIA",
  LU : "LUXEMBOURG",
  MO : "MACAU",
  MK : "MACEDONIA, THE FORMER YUGOSLAV REPUBLIC OF",
  MG : "MADAGASCAR",
  MW : "MALAWI",
  MY : "MALAYSIA",
  MV : "MALDIVES",
  ML : "MALI",
  MT : "MALTA",
  MH : "MARSHALL ISLANDS",
  MQ : "MARTINIQUE",
  MR : "MAURITANIA",
  MU : "MAURITIUS",
  YT : "MAYOTTE",
  MX : "MEXICO",
  FM : "MICRONESIA, FEDERATED STATES OF",
  MD : "MOLDOVA, REPUBLIC OF",
  MC : "MONACO",
  MN : "MONGOLIA",
  MS : "MONTSERRAT",
  MA : "MOROCCO",
  MZ : "MOZAMBIQUE",
  MM : "MYANMAR",
  NA : "NAMIBIA",
  NR : "NAURU",
  NP : "NEPAL",
  NL : "NETHERLANDS",
  AN : "NETHERLANDS ANTILLES",
  NC : "NEW CALEDONIA",
  NZ : "NEW ZEALAND",
  NI : "NICARAGUA",
  NE : "NIGER",
  NG : "NIGERIA",
  NU : "NIUE",
  NK : "NORFOLK ISLAND",
  MP : "NORTHERN MARIANA ISLANDS",
  NO : "NORWAY",
  OM : "OMAN",
  PK : "PAKISTAN",
  PW : "PALAU",
  PS : "PALESTINIAN TERRITORY, OCCUPIED",
  PA : "PANAMA",
  PG : "PAPUA NEW GUINEA",
  PY : "PARAGUAY",
  PE : "PERU",
  PH : "PHILIPPINES",
  PN : "PITCAIRN",
  PL : "POLAND",
  PT : "PORTUGAL",
  PR : "PUERTO RICO",
  QA : "QATAR",
  RE : "REUNION",
  RO : "ROMANIA",
  RU : "RUSSIAN FEDERATION",
  RW : "RWANDA",
  SH : "SAINT HELENA",
  KN : "SAINT KITTS AND NEVIS",
  LC : "SAINT LUCIA",
  PM : "SAINT PIERRE AND MIQUELON",
  VC : "SAINT VINCENT AND THE GRENADINES",
  WS : "SAMOA",
  SM : "SAN MARINO",
  ST : "SAO TOME AND PRINCIPE",
  SA : "SAUDI ARABIA",
  SN : "SENEGAL",
  SC : "SEYCHELLES",
  SL : "SIERRA LEONE",
  SG : "SINGAPORE",
  SK : "SLOVAKIA",
  SI : "SLOVENIA",
  SB : "SOLOMON ISLANDS",
  SO : "SOMALIA",
  ZA : "SOUTH AFRICA",
  GS : "SOUTH GEORGIA AND THE SOUTH SANDWICH ISLANDS",
  ES : "SPAIN",
  LK : "SRI LANKA",
  SD : "SUDAN",
  SR : "SURINAME",
  SJ : "SVALBARD AND JAN MAYEN",
  SZ : "SWAZILAND",
  SE : "SWEDEN",
  CH : "SWITZERLAND",
  SY : "SYRIAN ARAB REPUBLIC",
  TW : "TAIWAN, PROVINCE OF CHINA",
  TJ : "TAJIKISTAN",
  TZ : "TANZANIA, UNITED REPUBLIC OF",
  TH : "THAILAND",
  TG : "TOGO",
  TK : "TOKELAU",
  TO : "TONGA",
  TT : "TRINIDAD AND TOBAGO",
  TN : "TUNISIA",
  TR : "TURKEY",
  TM : "TURKMENISTAN",
  TC : "TURKS AND CAICOS ISLANDS",
  TV : "TUVALU",
  UG : "UGANDA",
  UA : "UKRAINE",
  AE : "UNITED ARAB EMIRATES",
  GB : "UNITED KINGDOM",
  UM : "UNITED STATES MINOR OUTLYING ISLANDS",
  UY : "URUGUAY",
  UZ : "UZBEKISTAN",
  VU : "VANUATU",
  VE : "VENEZUELA",
  VN : "VIET NAM",
  VG : "VIRGIN ISLANDS, BRITISH",
  VI : "VIRGIN ISLANDS, U.S.",
  WF : "WALLIS AND FUTUNA",
  EH : "WESTERN SAHARA",
  YE : "YEMEN",
  YU : "YUGOSLAVIA",
  ZM : "ZAMBIA",
  ZW : "ZIMBABWE"
}

State/Province

These are the valid state/province codes that may be used when sending location_state param to ExpertFile's API and the location_country is set to CA/US.

["BC","ON","NF","NS","PE","NU","NB","QC","MB","SK","AB","NT","YT"]
["AL","AK","AZ","AR","CA","CO","CT","DE","DC","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"]

Errors

The Kittn API uses the following error codes:

Error Code Meaning
400 Bad Request -- The request could not be understood by the server due to malformed syntax.
401 Unauthorized -- Your API key is wrong.
403 Forbidden -- The kitten requested is hidden for administrators only.
404 Not Found -- The specified kitten could not be found.
405 Method Not Allowed -- You tried to access a kitten with an invalid method.
406 Not Acceptable -- You requested a format that isn't JSON.
410 Gone -- The kitten requested has been removed from our servers.
418 I'm a teapot.
429 Too Many Requests -- You're requesting too many kittens! Slow down!
500 Internal Server Error -- We had a problem with our server. Try again later.
503 Service Unavailable -- We're temporarily offline for maintenance. Please try again later.