API_Image.pngIf you have a recruiting, sales or marketing solution, and you'd like access to great social profiles of candidates and prospects, use our API to find them. The API will bring back the first 25 results for your query... but if you'd like to get more results, or a deeper integration, simply contact us and let us know. We're looking forward to working with you.

 

 

 

API Documentation:

GET Search.do

HOST https://enterprise.swooptalent.com

Parameter

Description

Example

apikey

Required.

 API Key provided to you by Swoop team. This key will be available to you once you sign-up with Swoop.

Please fill out the form on the rigth to request an API Key.

apikey=abcdefghijkl1234567890
accessToken

Required.

 Access Token provided to you by Swoop team. This token will be available to you once you sign-up with Swoop.

accessToken=abcdefghijkl1234567890
secretToken

Required.

Secret Token provided to you by Swoop team. This token will be available to you once you sign-up with Swoop.

secretToken=abcdefghijkl1234567890
location

Required unless zipcode or socialUrl or email is provided.

 Should be URL encoded.

For all locations within US, the format would {city name}, {state abbreviation} e.g. San%20Francisco,%20CA. If you want to search within a state then provide the full state name e.g. California. If you want to search within country then provide the full country name e.g. United States. For locations outside US the format is City Name, State Name e.g. Alberta, Canada
zipcode

Required unless location or socialUrl or email is provided.

This parameter is only supported for US e.g. 94010
keywords

Required unless expertise or title or company or phrase or socialUrl or email are provided.

 This field accepts multiple values; each value is separated by comma.

 Should be URL encoded.

keywords=java,j2ee
expertise

Required unless keywords or title or company or phrase or socialUrl or email are provided.

 This field accepts multiple values; each value is separated by comma.

 Should be URL encoded.

expertise=java,j2ee
title

Required unless keywords or expertise or company or phrase or socialUrl or email are provided.

 Should be URL encoded.

 This field does NOT accept multiple values.

title=software%20engineer
company

Required unless title or keywords or expertise or phrase or socialUrl or email are provided.

 Should be URL encoded.

 This field does NOT accept multiple values.

company=google
phrase

Required unless keywords or expertise or title or company or socialUrl or email are provided.

 Should be URL encoded.

 Complex Boolean phrases that can use AND, OR and NOT to combine keywords.

phrase=(java%20OR%20j2ee)%20AND%20(developer%20OR%20engineer)
socialUrl

Optional.

Should be URL encoded.

This field does NOT accept multiple values.

socialUrl=http%3A%2F%2Fexample.com
email

Optional.

 Should be URL encoded.

 This field does NOT accept multiple values.

email=hello@example.com
filterByEmail

Default is false.

Accepts true or false.

filterByEmail=true
excludeRecruiters

Default is true.

Accepts true or false.

excludeRecruiters=false
useSemantics

Default is true.

Accepts true or false.

useSemantics=false
responseType

If responseType is not provided then the default is json.

 Accepts json or xml.

responseType=xml
resultType

Default is summary.

Accepts summary or details.

resultType=summary
clientName

Optional.

Name of client on behalf of whom the API call is made.

Should be URL encoded.

clientName=SwoopTalent
distance

Default is 50.

Distance in miles for the radius around given location.

 Accepted values are 5, 10, 15, 20, 25, 50.

distance=50
maxResults

Maximum # of results to return. The default is 25.

Number of results to return in API response.

maxResults=10

Note

  • Keywords or Expertise or Title or Company or Phrase are required.
  • Location or Zipcode are required.
  • Search API results are limited to 25 profiles or maxResults (as configured for the API Partner).

Response

Response Field

Description

keywords

Keywords provided in request.

expertise

Expertise provided in request.

location

Location provided in request.

locationDistance

Location Distance provided in request.

title

Title provided in request.

company

Company provided in request.

phrase

Phrase provided in request.

zipcode

Zipcode provided in request.

excludeRecruiters

ExcludeRecruiters value provided in request.

useSemantics

UseSemantics value provided in request.

resultType

ResultType provided in request.

totalResults

Total search results for the query.

error

Error message. If the API Key is invalid or required parameters missing then Swoop will return an error message.

profiles

List of profiles returned for the search request.

profile.firstName

First Name.

profile.lastName

Last Name.

profile.title

Job Title.

profile.location

Location.

profile.expertise

Comma separated list of expertise.

profile.profileUrl

Profile URL of the person on Swoop.

profile.summary

Professional summary of the person.

profile.companies

Work experience of the person.

profile.education

Education history of the person.

profile.degrees

Education degrees of the person.

profile.certifications

Certifications of the person.

profile.languages

Languages of the person.

profile.publications

Publications of the person.

profile.awards

Honors & Awards of the person.

profile.memberships

Group Memberships of the person.

profile.profileSSOUrl

Single Sign-on URL to access full profile of the person on Swoop. The apiKey, accessToken, secretToken would have to be passed along with URL to view profile.

profile.emails

Available email addresses of the person.

profile.phoneNumbers

Available phone numbers of the person.

profile.externalProfiles

External Profile(s) of the person on other Social Platforms e.g. StackOverflow, Github, Google+...

 This response field contains 1 or more rows, each row providing more information about the profile on other Social Platforms e.g. a person might have a profile on StackOverflow and Google+. In this case the API will return 2 rows representing the Social Profile of the user.

 Values returned for each external profile

   externalProfileType - Name of Social Source e.g. StackOverflow, Github, Google+...

  externalProfileUrl - External Profile URL e.g. https://plus.google.com/b/109435030731971019402/+Swooptalent/

  externalProfileIconUrl - 32*32 icon to display against this profile

 This field is returned only if the resultType is "details".

Sample Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><search-result><keywords>java</keywords><location>San Francisco, CA</location><excludeRecruiters>true</location><useSemantics>true</useSemantics><totalResultsAvailable>1000000</totalResultsAvailable><profiles><profile><firstName>John</firstName><lastName>Doe</lastName><title>Sr. Software Engineer</title><location>San Francisco, CA</location><expertise>Java,Eclipse,Linux,Perl,Testing,Unix</expertise><profileUrl>https://enterprise.swooptalent.com/ExternalUserProfile.do?viewUserUUID=abcde&code=g9TPKOot0ucUwk4XQ%2BIPhg%3D%3D&partner=abcde</profileUrl><summary>Experienced web development engineer.</summary><companies>SwoopTalent</companies>...</profile><profile><firstName>Melanie</firstName><lastName>Watson</lastName><title>Software Engineer</title><location>Mountain View, CA</location><expertise>Java,Eclipse,Linux,Perl,Testing,Unix</expertise><profileUrl>https://enterprise.swooptalent.com/ExternalUserProfile.do?viewUserUUID=abcde&code=g9TPKOot0ucUwk4XQ%2BIPhg%3D%3D&partner=abcde</profileUrl><summary>Accomplished professional with over 5 years of software product development and engineering management experience.</summary><companies>SwoopTalent</companies>...</profile></profiles></search-result>

Examples

https://enterprise.swooptalent.com/Search.do?keywords=java,jquery&location=san%20francisco,ca&apiKey=xyz - This API call will return profiles who have java and jquery and are located in San Francisco, CA

https://enterprise.swooptalent.com/Search.do?title=software%20engineer&company=google&location=san%20francisco,ca&apiKey=xyz - This API call will return profiles of software engineers working at Google and are located in San Francisco, CA

https://enterprise.swooptalent.com/Search.do?phrase=(java)%20AND%20(developer%20OR%20engineer)&location=san%20francisco,ca&apiKey=xyz - This API call will return those profiles that have java and either are developer or engineer and are located in San Francisco, CA