NAV Navbar image
logo image
cURL

Introduction

Welcome to the Oracle DataFox API. The Oracle DataFox API is a RESTful API. Communication happens over standard HTTPS, and responses are returned in JSON. You can use the API to:

Get Started

  1. To get started with the API authentication, sign in to your account and select the Settings wheel in the lower left corner, then click Integrations in the middle of the page. Integrations option
  2. Scroll toward the bottom of the page until you see OAuth2 Clients. Insert a name in the Name field and paste https://localhost in the Redirect URL field. Then, select Generate New Client. If you don’t see this option, contact support. Generate New Client button
  3. After generating, you see the long alphanumeric Client ID and select show secret to view the Client Secret. Show secret option
  4. You can exchange the Client ID and Client Secret to generate an access code valid for four hours. If you only want to use the API for personal use, the easiest way to get an access token is to use the Client Credentials grant type to request an access token for the user associated with the client you are using.

Authentication

The Oracle DataFox API uses a standard OAuth 2.0 flow to authorize and authenticate API clients and users. See IETF RFC 6749 and especially the diagram of the Abstract Protocol Flow for a good reference on OAuth 2.0.

If you are using the DataFox API, you should already have an OAuth 2.0 client ID and client secret and you should have registered your redirect URI with DataFox.

The OAuth 2.0 flow for Oracle DataFox looks like the following:

  1. Request an authorization code by asking Oracle DataFox to prompt the user.
  2. If authorized, retrieve an authorization code from the user.
  3. Exchange the authorization code for an access token and refresh token from Oracle.
  4. Use the access token to make authenticated requests on behalf of the user.
  5. When the access token expires, request a new access token from Oracle using the provided refresh token.

Requesting an Authorization Code

Prompt a user to authorize your app by sending them to the authorization url.

https://app.datafox.com/oauth2/authorize?response_type=code&client_id=CLIENT_ID&redirect_uri=REDIRECT_URI&scope=SCOPES

where SCOPES is a comma-separated list of scopes requested. At the moment, ‘full’ is the only scope accepted in the Oracle DataFox API.

Exchanging the Authorization Code for an Access Token

When the user accepts your application, they will be sent to your specified redirect URI with the authorization code as a query parameter:

REDIRECT_URI?code=AUTHORIZATION_CODE

Extract the authorization code from the query parameter to exchange for an access token.

To get an access token for the user, send the authorization code to DataFox.

curl --request POST \
  --basic --user CLIENT_ID:CLIENT_SECRET \
  --data code=AUTHORIZATION_CODE \
  --data grant_type=authorization_code \
  --data redirect_uri=REDIRECT_URI \
  --data scope=full \
  https://api.datafox.com/2.0/oauth2/token

JSON Response:

{
  "access_token": "7s27S0DuEbH4H5TkE7t9TXAzHl1y9qsC",
  "refresh_token": "7Hk9pluHuBM6tTI5kM4QYp22D8HyShZH",
  "expires_in": 3599 
}

Authentication via Client Credentials

If you only want to use the API for personal use, the easiest way to get an access token would be to use the Client Credentials grant type to request an access token for the user associated to the client you are using.

curl --request POST \
  --basic --user CLIENT_ID:CLIENT_SECRET \
  --data grant_type=client_credentials \
  --data scope=full \
  https://api.datafox.com/2.0/oauth2/token

JSON Response:

{
  "access_token": "LLe2BJxAvYU2ZH0ZCGT69dcEhasN81SI",
  "refresh_token": "QaNtutL9JBopX7rrFYCQLfnH6xv3H1o6",
  "expires_in": 3599
}

Refreshing the Access Token

When an access token has expired, request a new one using the refresh token provided earlier.

curl --request POST \
  --basic --user CLIENT_ID:CLIENT_SECRET \
  --data refresh_token=REFRESH_TOKEN \
  --data grant_type=refresh_token \
  https://api.datafox.com/2.0/oauth2/token

JSON Response:

{
  "access_token": "LLe2BJxAvYU2ZH0ZCGT69dcEhasN81SI",
  "refresh_token": "QaNtutL9JBopX7rrFYCQLfnH6xv3H1o6",
  "expires_in": 3599
}

Authenticated Requests

For all subsequent requests, pass the access token in the Authorization header with value Bearer ACCESS_TOKEN.

curl --request GET \
  --header "Authorization: Bearer ACCESS_TOKEN" \
  https://api.datafox.com/2.0/endpoint

Rate Limit

The default rate limit is set at 10 calls/second (increases available) to ensure service quality. Contact your customer success representative to discuss changes to your rate limit.

Types

The API responses are all JSON, but it is helpful to specify some of the types of values that are given in responses.

Types of fields in responses
Type Explanation
String String
Integer Integer
Float Float
Long Long
Boolean Boolean (true or false)
ID String matching [a-f0-9]{24}
Date Date formatted in ISO 8601 notation (e.g. "2015-03-14T16:26:53.589Z")

Object Types

Company

Basic

{
  "id": "51c6b9a5a9812aa90b123980",
  "object_type": "company",
  "name": "DataFox",
  "slug": "datafox",
  "url": "datafox.com",
  "location": "San Francisco, CA",
  "icon_url": "//datafox-data.s3.amazonaws.com/favicons/51c6b9a5a9812aa90b123980.ico"
}
Fields returned for a company object
Field Type Explanation
id ID ID of the company
object_type String "company"
name String company name
slug String company slug
url String company’s main URL
location String company’s main location – usually city, state (in US) or city, country (outside of US)
icon_url String URL to company favicon

Full

{
  "id": "51c6b9a5a9812aa90b123980",
  "slug": "datafox",
  "name": "DataFox",
  "object_type": "company",
  "icon_url": "//datafox-data.s3.amazonaws.com/favicons/51c6b9a5a9812aa90b123980.ico",
  "url": "datafox.com",
  "status": "Private",
  "ceo_name": "Bastiaan Janmaat",
  "location": "San Francisco, CA",
  "street1": "324 5th Street",
  "street2": null,
  "city": "San Francisco",
  "state": "CA",
  "country": "US",
  "zipcode": "94107",
  "top_keywords": [
    "enterprise software",
    "business intelligence",
    "market research",
    "angels",
    "finance"
  ],
  "revenue_estimate": null,
  "number_of_employees": 23,
  "angellist_slug": "datafox",
  "crunchbase_permalink": "datafox",
  "linkedin_id": 3231060,
  "twitter_handle": "datafoxco",
  "blog_url": "http://datafox.com/blog",
  "description": "DataFox is the premier lead intelligence platform for sales & research\nprofessionals. The platform applies data science to automate the tedious labor\nof discovering new prospects, gathering business intelligence, and identifying\ntimely sales triggers. Backed by Goldman Sachs, Green Visor, and Google\nVentures, DataFox has forward-thinking customers including Box, Looker, NetApp,\nand General Electric.",
  "industry_code": "industry_055",
  "industry_name": "Information Technology",
  "subindustry_code": "subindustry_382",
  "subindustry_name": "Enterprise Software"
}

In addition to the basic company fields, the full company will also have

Fields returned for a full company object
Field Type Explanation
url String company’s main URL
description String long description for the company
status String company status
ceo_name String name of the company’s CEO
location String company’s main location – usually city, state (in US) or city, country (outside of US)
street1 String main location – first part of street
street2 String main location – second part of street
city String main location – city
state String main location – state
country String main location – country
zipcode String main location – zipcode
top_keywords [String] array of the company’s top keywords
industry_name String company’s industry name
industry_code String company’s industry code
subindustry_name String company’s subindustry name
subindustry_code String company’s subindustry code
revenue_estimate Integer estimate of company’s annual revenue
number_of_employees Integer estimate of the number of employees at the company
angellist_slug String company’s angellist slug
crunchbase_permalink String company’s crunchbase slug
linkedin_id Integer company’s linkedin id number
twitter_handle String company’s twitter handle
blog_url String company’s blog url

MatchCompany

{
  "confidence": "0.99999999",
  "company": {
    "id": "51c6b9a5a9812aa90b123980",
    "object_type": "company",
    "name": "DataFox",
    "slug": "datafox",
    "url": "datafox.com",
    "location": "San Francisco, CA",
    "icon_url": "//datafox-data.s3.amazonaws.com/favicons/51c6b9a5a9812aa90b123980.ico"
  }
}
Fields returned for a match company object
Field Type Explanation
confidence Float Confidence of the match (between 0 and 1)
company Company (basic) Basic version of company object

Funding Round

{
  "id": "563befdd6a187ef3120000b4",
  "object_type": "funding_round",
  "round_code": "seed",
  "raised_amount": 5000000,
  "currency_code": null,
  "date": "2015-07-22T00:00:00.000Z",
  "company": {
    "id": "51c6b9a5a9812aa90b123980",
    "slug": "datafox",
    "name": "DataFox",
    "object_type": "company",
    "location" : "San Francisco, CA",
    "icon_url": "//datafox-data.s3.amazonaws.com/favicons/51c6b9a5a9812aa90b123980.ico"
  },
  "investments": [
    {
      "id": "563befdd6a187ef3120000c4",
      "company": {
        "id": "53af404abf9923352a0226c6",
        "slug": "goldman-sachs",
        "name": "Goldman Sachs",
        "object_type": "company",
        "location" : "New York, NY",
        "icon_url": "//datafox-data.s3.amazonaws.com/favicons/53af404abf9923352a0226c6.ico"
      },
      "object_type": "investment",
      "money_invested_amount": null,
      "currency_code": "USD"
    },
    {
      "id": "563befdd6a187ef3120000c3",
      "company": {
        "id": "53b34972e43739f942015df7",
        "slug": "green-visor-capital",
        "name": "Green Visor Capital",
        "object_type": "company",
        "location" : "San Francisco, CA",
        "icon_url": null
      },
      "object_type": "investment",
      "money_invested_amount": null,
      "currency_code": "USD"
    },
    {
      "id": "563befdd6a187ef3120000c2",
      "company": {
        "id": "5130f07a8989846a36025dbe",
        "slug": "startx",
        "name": "StartX",
        "object_type": "company",
        "location" : "Palo Alto, CA",
        "icon_url": "//datafox-favicons.s3.amazonaws.com/favicons/5130f07a8989846a36025dbe.ico"
      },
      "object_type": "investment",
      "money_invested_amount": null,
      "currency_code": "USD"
    }
  ]
}
Fields returned for a company funding object
Field Type Explanation
id ID ID of funding round
object_type String "funding_round"
round_code String round code (enumerated type)
raised_amount Long amount raised in round
currency_code String currency of raise
date Date date of round
investments [Investment] investors in the round
company Company (basic) company receiving funding round

Investment

{
  "id": "563befdd6a187ef3120000c4",
  "company": {
    "id": "53af404abf9923352a0226c6",
    "slug": "goldman-sachs",
    "name": "Goldman Sachs",
    "object_type": "company",
    "location": "New York, NY",
    "icon_url": "//datafox-data.s3.amazonaws.com/favicons/53af404abf9923352a0226c6.ico"
  },
  "object_type": "investment",
  "money_invested_amount": null,
  "currency_code": "USD"
}

Fields returned for a investment object
Field Type Explanation
id ID ID of investment
object_type String "investment"
money_invested_amount Integer amount invested
currency_code String currency of raise
company Company (basic) company making the investment

User

{
  "id": "ccb2d9e21b41b0ffe0193dbd",
  "object_type": "user",
  "slug": "data-fox",
  "first_name": "Data",
  "last_name": "Fox",
  "team_id": "3e3e613c30ebc7f60e3a8d72"
}
Fields returned for a user object
Field Type Explanation
id ID ID of user
object_type String "user"
slug String user slug
first_name String fist name of user
last_name String last name of user
team_id ID ID of the user’s team

Acquisition

{
  "id": "5371b2e3519c2a1c07027111",
  "object_type": "acquisition",
  "acquirer": {
    "id": "5130f01b8989846a36011118",
    "slug": "instagram",
    "name": "Instagram",
    "object_type": "company",
    "location": "Menlo Park, CA",
    "icon_url": "//datafox-favicons.s3.amazonaws.com/favicons/5130f01b8989846a36011118.ico"
  },
  "target": {
    "id": "5219e03807cca8d333187df0",
    "slug": "luma-io",
    "name": "Luma.io",
    "object_type": "company",
    "location" : "Palo Alto, CA",
    "icon_url": "//datafox-favicons.s3.amazonaws.com/favicons/5219e03807cca8d333187df0.ico"
  },
  "price": null,
  "currency_code": "USD",
  "date": "2013-08-23T00:00:00.000Z"
}

Fields returned for an acquisition object
Field Type Explanation
id ID ID of acquisition
object_type String "acquisition"
price Long cost of acquisition
currency_code String currency of acquisition deal
date Date date of acquisition
acquirer Company (basic) buyer
target Company (basic) company that was acquired

IPO

{
  "id": "552fdfe0382e2b8b47000abe",
  "object_type": "ipo",
  "company": {
    "id": "5130efc78989846a36000ad8",
    "slug": "etsy",
    "name": "Etsy",
    "object_type": "company",
    "location" : "New York, NY",
    "icon_url": "//datafox-favicons.s3.amazonaws.com/favicons/5130efc78989846a36000ad8.ico"
  },
  "money_raised": null,
  "currency_code": null,
  "date": "2015-04-01T00:00:00.000Z"
}
Fields returned for an ipo object
Field Type Explanation
id ID ID of ipo
object_type String "ipo"
money_raised Long money raised
currency_code String currency of ipo
date Date date of acquisition
company Company (basic) company that was acquired

Similar Company

{
  "confidence": 0.6520620424036144,
  "company": {
    "id": "5130efc28989846a36000146",
    "slug": "pandora",
    "name": "Pandora Media",
    "object_type": "company",
    "location" : "Oakland, CA",
    "icon_url": "//datafox-favicons.s3.amazonaws.com/favicons/5130efc28989846a36000146.ico"
  }
}
Fields returned for a similar company object
Field Type Explanation
confidence Float measure of confidence in relatedness
company Company (basic) basic version of company object

Signal

{
  "id": "5949deddc5de6bd638cac218",
  "object_type": "signal",
  "company": {
    "id": "54536becdef752c62e0005a5",
    "slug": "fourkites",
    "name": "FourKites",
    "url": "www.fourkites.com",
    "location": "Chicago, IL",
    "object_type": "company",
    "icon_url": "//datafox-data.s3-us-west-1.amazonaws.com/favicons/54536becdef752c62e0005a5.ico"
  },
  "tag": "private-funding",
  "date": "2016-10-12T00:00:00.000Z",
  "sources": [
    {
      "id": "56b4e26d9c230b753403566a",
      "object_type": "funding_round",
      "round_code": "A",
      "raised_amount": 13000000,
      "currency_code": "USD",
      "date": "2016-10-12T00:00:00.000Z",
      "company": {
        "id": "54536becdef752c62e0005a5",
        "slug": "fourkites",
        "name": "FourKites",
        "url": "www.fourkites.com",
        "location": "Chicago, IL",
        "object_type": "company",
        "icon_url": "//datafox-data.s3-us-west-1.amazonaws.com/favicons/54536becdef752c62e0005a5.ico"
      },
      "investments": [
        {
          "id": "59b3404e2bec96905f7f262e",
          "company": {
            "id": "558001e7753c9b6d18000170",
            "slug": "otter",
            "name": "Otter",
            "url": "otter.sg",
            "location": "Singapore, Singapore",
            "object_type": "company",
            "icon_url": "//datafox-data.s3.amazonaws.com/favicons/558001e7753c9b6d18000170.ico"
          },
          "object_type": "investment",
          "money_invested_amount": null,
          "currency_code": "USD"
        },
        {
          "id": "59b3404e2bec96905f7f262d",
          "company": {
            "id": "51a1f5c7d6a57a57610f17f2",
            "slug": "hyde-park-angels",
            "name": "Hyde Park Angels",
            "url": "hydeparkangels.com",
            "location": "Chicago, IL",
            "object_type": "company",
            "icon_url": "//datafox-data.s3.amazonaws.com/favicons/51a1f5c7d6a57a57610f17f2.ico"
          },
          "object_type": "investment",
          "money_invested_amount": null,
          "currency_code": "USD"
        },
        {
          "id": "59b3404e2bec96905f7f262c",
          "company": {
            "id": "53af4e40bf9923352a047902",
            "slug": "hyde-park-venture-partners",
            "name": "Hyde Park Venture Partners",
            "url": "hydeparkvp.com",
            "location": "Chicago, IL",
            "object_type": "company",
            "icon_url": "//datafox-data.s3.amazonaws.com/favicons/53af4e40bf9923352a047902.ico"
          },
          "object_type": "investment",
          "money_invested_amount": null,
          "currency_code": "USD"
        },
        {
          "id": "59b3404e2bec96905f7f262b",
          "company": {
            "id": "51c6bacaa9812aa90b1283f3",
            "slug": "bain-capital-ventures",
            "name": "Bain Capital Ventures",
            "url": "www.baincapitalventures.com",
            "location": "Boston, MA",
            "object_type": "company",
            "icon_url": "//datafox-data.s3.amazonaws.com/favicons/51c6bacaa9812aa90b1283f3.ico"
          },
          "object_type": "investment",
          "money_invested_amount": null,
          "currency_code": "USD"
        }
      ]
    },
    {
      "id": "57fefbb861f1b5391a01121a",
      "object_type": "tweet",
      "tweet_id": "786175917488009216",
      "tweet_user_id": "2484331177",
      "created_at": "2016-10-12T12:05:19.000Z",
      "company_tags": [
        {
          "object_type": "company_tag",
          "company": "54536becdef752c62e0005a5",
          "tag": "private-funding"
        }
      ]
    },
    {
      "id": "57ff6c40ed8fc9ba381a0583",
      "object_type": "tweet",
      "tweet_id": "786305936226852864",
      "tweet_user_id": "323853589",
      "created_at": "2016-10-12T20:41:58.000Z",
      "company_tags": [
        {
          "object_type": "company_tag",
          "company": "54536becdef752c62e0005a5",
          "tag": "private-funding"
        }
      ]
    },
    {
      "id": "57ffbe17644d14cb49423859",
      "object_type": "tweet",
      "tweet_id": "786224937107324928",
      "tweet_user_id": "1432373952",
      "created_at": "2016-10-12T15:20:07.000Z",
      "company_tags": [
        {
          "object_type": "company_tag",
          "company": "54536becdef752c62e0005a5",
          "tag": "private-funding"
        }
      ]
    },
    {
      "id": "580242824a75ab424a80f48b",
      "object_type": "snippet",
      "text": "Relief for shippers has finally come in the form of FourKites, a breakthrough platform for real-time shipment visibility, which today announced that it has raised $13 million in Series A funding led by Bain Capital Ventures.",
      "company_tags": [
        {
          "object_type": "company_tag",
          "company": "54536becdef752c62e0005a5",
          "tag": "private-funding"
        },
        {
          "object_type": "company_tag",
          "company": "51c6bacaa9812aa90b1283f3",
          "tag": "investment"
        }
      ],
      "article": {
        "id": "57fe1a2179c645291f8735b3",
        "object_type": "news",
        "title": "FourKites Raises $13 Million to Enable \"Smart Trucking\" via Real-Time Logistics Connectivity for $700 Billion Transportation Industry",
        "url": "http://www.marketwired.com/mw/release.do?id=2165776&sourceType=3",
        "published": "2016-10-12T11:00:00.000Z",
        "source": "Marketwired - Breaking News Releases"
      }
    }
  ]
}
Fields returned for a signal object
Field Type Explanation
id ID ID of signal object
object_type String "signal"
company Company (Basic) company signal belongs to
tag Signal Tag signal tag
date Date date of the signal
sources [Source] array of sources

Source is polymorphic and can be one of the following object types: News, Snippet (full), Acquisition, Funding Round, IPO, Conference, and Tweet.

Signal Tag

A signal tag is a string that is part of the following enumeration:

List of Tags

joint-venture, market-share-growth, new-geography, new-initiative, new-patent, new-product, new-strategy, office-space-expansion, partnership, product-launch, regulatory, sales-growth, user-growth, customer-win, analyst-expectations, debt-financing, dividends, earnings, revenue, form-5500, investment, ipo-trading, ipo-s1, ipo-speculation, acquisition-acquirer, merger, ownership-change, private-funding, restructuring, form-10k, form-d, stock-performance, valuation, acquisition-acquiree, executive-publication, executive-quote, headcount-growth, job-posting, leadership-change, award, industry-list, industry-news, accelerator-participation, conference-exhibitor, marketing-activity, podcast, conference-presenter, conference-sponsorship, conference-attendee, video-presentation, corporate-purchase, name-change, outsourcing, real-estate-sale, relocation, reorganization, bankruptcy, competitive-challenge, customer-dissatisfaction, financial-challenge, industry-challenge, key-departure, layoff, legal-issue, regulatory-issue, security-challenge, turbulence, mention

Deprecated Tags

key-hire (now appearing as leadership-change), key-promotion (now appearing as leadership-change)

News

Full

{
  "id": "56ac79e90c746a1f4a384034",
  "object_type": "news",
  "title": "Kanye West posts two nearly-new songs on Soundcloud",
  "url": "http://www.theguardian.com/music/2015/oct/19/kanye-west-new-songs-soundcloud",
  "published": "2015-10-19T22:25:59.000Z",
  "source": "Guardian Unlimited Business",
  "mentions": [
    {
      "id": "5130efd28989846a360027c6",
      "slug": "soundcloud",
      "name": "SoundCloud",
      "object_type": "company",
      "location" : "Berlin, Germany",
      "icon_url": "//datafox-favicons.s3.amazonaws.com/favicons/5130efd28989846a360027c6.ico"
    }
  ],
  "snippets": [
    {
      "id": "56ac79e90c746a1f4a384037",
      "object_type": "snippet",
      "text": "Less than a month ago West told Vanity Fair that he was nowhere near to having his forthcoming album Swish, the follow-up to 2013's Yeezus, ready, but the two tracks emerged on a new Soundcloud account on Monday.",
      "company_tags": [
        {
          "object_type": "company_tag",
          "company": "5130efd28989846a360027c6",
          "tag": "new-strategy"
        }
      ]
    },
    {
      "id": "56ac79e90c746a1f4a384035",
      "object_type": "snippet",
      "text": "Whether fans will be able to glean anything about a new direction from a remix and a cover, but West embracing Soundcloud and launching surprise releases is an exciting prospect from an artist whose focus has been elsewhere recently.",
      "company_tags": [
        {
          "object_type": "company_tag",
          "company": "5130efd28989846a360027c6",
          "tag": "partnership"
        }
      ]
    }
  ]
}
Fields returned for a full news object
Field Type Explanation
id ID ID of news item
object_type String "news"
title Integer title of article
url String original url of the article
published Date date the article was published
source String name of publication
mentions [Company (basic)] companies mentioned in the article
snippets [Snippet (basic)] highlighted parts of the article

Basic

{
  "id": "56ac79e90c746a1f4a384034",
  "object_type": "news",
  "title": "Kanye West posts two nearly-new songs on Soundcloud",
  "url": "http://www.theguardian.com/music/2015/oct/19/kanye-west-new-songs-soundcloud",
  "published": "2015-10-19T22:25:59.000Z",
  "source": "Guardian Unlimited Business"
}
Fields returned for a basic news object
Field Type Explanation
id ID ID of news item
object_type String "news"
title Integer title of article
url String original url of the article
published Date date the article was published
source String name of publication

Snippet

Full

{
  "id": "580242824a75ab424a80f48b",
  "object_type": "snippet",
  "text": "Relief for shippers has finally come in the form of FourKites, a breakthrough platform for real-time shipment visibility, which today announced that it has raised $13 million in Series A funding led by Bain Capital Ventures.",
  "company_tags": [
    {
      "object_type": "company_tag",
      "company": "54536becdef752c62e0005a5",
      "tag": "private-funding"
    },
    {
      "object_type": "company_tag",
      "company": "51c6bacaa9812aa90b1283f3",
      "tag": "investment"
    }
  ],
  "article": {
    "id": "57fe1a2179c645291f8735b3",
    "object_type": "news",
    "title": "FourKites Raises $13 Million to Enable \"Smart Trucking\" via Real-Time Logistics Connectivity for $700 Billion Transportation Industry",
    "url": "http://www.marketwired.com/mw/release.do?id=2165776&sourceType=3",
    "published": "2016-10-12T11:00:00.000Z",
    "source": "Marketwired - Breaking News Releases"
  }
}
Fields returned for a full snippet object
Field Type Explanation
id ID ID of the snippet
object_type String "snippet"
text String highlighted part of an article
company_tags [Company Tag] pairs of companies and tags
article News (basic) the source article for the snippet

Basic

{
  "id": "56fe32e87a4bd1a1065ad24d",
  "object_type": "snippet",
  "text": "SoundCloud has launched a new $9.99-a-month subscription service this week, as it looks to take advantage of the growing number of people subscribing to music streaming services.",
  "company_tags": [
    {
      "object_type": "company_tag",
      "company": "5130efd28989846a360027c6",
      "tag": "new-product"
    }
  ]
}
Fields returned for a basic snippet object
Field Type Explanation
id ID ID of the snippet
object_type String "snippet"
text String highlighted part of an article
tags [Signal Tag] represent the type of signal
company_tags [Company Tag] pairs of companies and tags

Company Tag

{
  "object_type": "company_tag",
  "company": "54536becdef752c62e0005a5",
  "tag": "private-funding"
}
Fields returned for a company tag object
Field Type Explanation
object_type String "company_tag"
company ID company ID
tag Signal Tag represent the type of signal

Tweet

{
  "id": "57ffbe17644d14cb49423859",
  "object_type": "tweet",
  "tweet_id": "786224937107324928",
  "tweet_user_id": "1432373952",
  "created_at": "2016-10-12T15:20:07.000Z",
  "company_tags": [
    {
      "object_type": "company_tag",
      "company": "54536becdef752c62e0005a5",
      "tag": "private-funding"
    }
  ]
}
Fields returned for a tweet object
Field Type Explanation
id ID ID of tweet object
object_type String "tweet"
tweet_id String twitter id of tweet
tweet_user_id String id of user of tweet
created_at Date date tweet was made
company_tags [Company Tag] pairs of companies and tags

Conference

{
  "id": "582f7500a03b29c76b2d9a0a",
  "object_type": "conference",
  "name": "SXSW 2017",
  "slug": "sxsw-2017",
  "start_date": "2017-03-10T00:00:00.000Z",
  "end_date": "2017-03-19T00:00:00.000Z",
  "description": "The South by Southwest® (SXSW®) Conference & Festivals celebrate the convergence of the interactive, film, and music industries. Fostering creative and professional growth alike, SXSW® is the premier destination for discovery.",
  "short_description": "The South by Southwest® (SXSW®) Conference & Festivals celebrate the convergence of the interactive, film, and music industries. Fostering creative and professional growth alike, SXSW® is the premier destination for discovery.",
  "sector": "Media & Entertainment",
  "url": "www.sxsw.com/",
  "registration_url": "cart.sxsw.com/?_ga=1.79086484.186073030.1479435740",
  "screenshot_url": "//datafox-data.s3-us-west-1.amazonaws.com/images/conference_582f7500a03b29c76b2d9a0a",
  "city": "Austin",
  "state": "TX",
  "street1": null,
  "street2": null,
  "zipcode": null,
  "country": "US",
  "participant_lists": [
    {
      "id": "58342e9348be2f9a570d7df8",
      "participation_type": "Speakers"
    },
    {
      "id": "58342e9948be2f9a570d86e3",
      "participation_type": "Sponsors"
    },
    {
      "id": "58342e9948be2f9a570d8711",
      "participation_type": "Partners"
    },
    {
      "id": "58aafd884cdd4bfc2fe14a04",
      "participation_type": "Exhibitors"
    },
    {
      "id": "58aafd894cdd4bfc2fe14b3a",
      "participation_type": "Participants"
    }
  ]
}
Fields returned for a conference object
Field Type Explanation
id ID ID of conference object
object_type String "conference"
name String name of the conference
slug String conference slug
start_date Date date the conference starts
end_date Date date the conference ends
description String description of the conference
short_description String short description of the conference
sector String sector the conference belongs to
url String conference’s main URL
registration_url String conference’s registration URL
screenshot_url String URL to conference website screenshot
city String city the conference takes place in
state String state the conference takes place in
street1 String street address for conference
street2 String street address for conference
zipcode String zipcode for conference
country String country the conference takes place in
participant_lists [Participant List] array of participant lists

Participant List

{
  "id": "58342e9348be2f9a570d7df8",
  "object_type": "participant_list",
  "participation_type": "Speakers"
}
Fields returned for a participant list object
Field Type Explanation
id ID ID of conference object
object_type String "participant_list"
participation_type String the type of participant list

List

{
  "id": "0ba3a0ffd1b6dfea8d71ad40",
  "object_type": "list",
  "name": "Unicorns",
  "slug": "unicorns",
  "owner": {
    "id": "ccb2d9e21b41b0ffe0193dbd",
    "object_type": "user",
    "slug": "data-fox",
    "first_name": "Datåa",
    "last_name": "Fox",
    "team_id": "3e3e613c30ebc7f60e3a8d72"
  },
  "created_at": "2015-03-14T16:26:53.589Z",
  "modified_at": "2015-10-11T13:15:13.819Z",
  "is_public": false,
  "num_followers": 1,
  "num_companies": 42,
  "num_collaborators": 3,
  "acting_user_is_following": true,
  "acting_user_is_collaborator": true,
  "acting_user_is_owner": true,
  "is_shared_with_team": false
}
Fields returned for a list object
Field Type Explanation
id ID ID of list
object_type String "list"
name String name of list
slug String slug for list
owner User owner of list
created_at Date date list was created
modified_at Date date list was last modified
is_public Boolean whether the list is public
num_followers Integer number of users following the list
num_companies Integer number of companies in the list
num_collaborators Integer number of collaborators on the list
acting_user_is_following Boolean whether the current user is following the list
acting_user_is_collaborator Boolean whether the current user is a collaborator on the list
acting_user_is_owner Boolean whether the current user is the owner of the list
is_shared_with_team Boolean whether the list is shared within the owner’s team

Dynamic List

{
  "id": "599f1891460cc86b9ae5e88d",
  "object_type": "dynamic_list",
  "name": "Target Cybersecurity Bay Area Opportunities",
  "owner": {
    "id": "ccb2d9e21b41b0ffe0193dbd",
    "object_type": "user",
    "slug": "data-fox",
    "first_name": "Data",
    "last_name": "Fox",
    "team_id": "3e3e613c30ebc7f60e3a8d72"
  },
  "created_at": "2016-04-12T00:05:44.022Z",
  "modified_at": "2016-10-17T21:46:04.105Z"
}
Fields returned for a dynamic list object
Field Type Explanation
id ID ID of dynamic list
object_type String "dynamic_list"
name String name of dynamic list
owner User owner of list
created_at Date date dynamic list was created
modified_at Date date dynamic list itself was last modified, not the date companies were last to the list

Dynamic List Company

{
  "object_type": "dynamic_list_company",
  "dynamic_list_id": "599f1891460cc86b9ae5e88d",
  "company": {
    "id": "51c6b9a5a9812aa90b123980",
    "object_type": "company",
    "name": "DataFox",
    "slug": "datafox",
    "url": "datafox.com",
    "location": "San Francisco, CA",
    "icon_url": "//datafox-data.s3.amazonaws.com/favicons/51c6b9a5a9812aa90b123980.ico"
  },
  "date_added": "2017-08-24T08:11:04.469Z"
}
Fields returned for a dynamic list company object
Field Type Explanation
object_type String "dynamic_list"
dynamic_list_id ID ID of dynamic list company is in
company Company (basic) company in dynamic list
date_added Date date company was added to dynamic list

Error

{
  "object_type": "error",
  "status_code": 400,
  "error_code": "bad_request",
  "request_id": "5ad15d06-0eed-4861-9690-bee87f4d4efd",
  "details": []
}
Fields returned for an error object
Field Type Explanation
object_type String "error"
status_code Integer status code for error
error_code String error code for error
request_id String unique identifier for request - helpful for support
details [Object] array of details, each element of which has the key text

Account Score

{
  "id": "5c9317768e2dc51d0479d590",
  "object_type": "account_score",
  "score": 220,
  "tier": "Tier 2",
  "last_updated_date": "2019-09-04T06:59:33.293Z",
  "last_modified_date": "2019-03-21T04:47:50.956Z",
  "account_scoring_criteria": [
    {
      "criterion": {
        "id": "5c92fd9c8e2dc51d04798a76",
        "object_type": "account_scoring_criterion",
        "name": "Headcount: 50 - 2k",
        "weight": 50
      }
    },
    {
      "criterion": {
        "id": "5c92fd9c8e2dc51d04798a77",
        "object_type": "account_scoring_criterion",
        "name": "Keyword: b2b, saas, software, manufacturing",
        "weight": 50
      }
    },
    {
      "criterion": {
        "id": "5c930cc68e2dc51d04798a78",
        "object_type": "account_scoring_criterion",
        "name": "Industry Categories: Information Technology",
        "weight": 50
      }
    },
    {
      "criterion": {
        "id": "5c9313908e2dc51d04798a7c",
        "object_type": "account_scoring_criterion",
        "name": "Technographics: HubSpot OR Marketo OR Eloqua",
        "weight": 50
      }
    },
    {
      "criterion": {
        "id": "5c9316578e2dc51d04798a7f",
        "object_type": "account_scoring_criterion",
        "name": "Conference: SaaStr Annual 2018",
        "weight": 20
      }
    }
  ]
}
Fields returned for an account scoring object
Field Type Explanation
id ID ID of account score
object_type String "account_score"
score Float account score of this company
tier String tier this company’s account score falls under.
Note: The response does not include this field if the score is below the tier threshold.
last_updated_date Date date that this company’s account score was last calculated.
Note: The score may not have changed since the last calculation.
last_modified_date Date date that this company’s account score was last changed.
account_scoring_criteria [Account Scoring Criterion] array of Account Scoring criteria

Account Scoring Criterion

{
  "id": "5c90320acb144c8b782c492e",
  "object_type": "account_scoring_criterion",
  "name": "Industry Categories: Information Technology",
  "weight": "20"
}
Fields returned for an account scoring criterion object
Field Type Explanation
id ID ID of account scoring criterion
object_type String "account_scoring_criterion"
name String Name of custom Account Scoring criterion matched by this company
weight Float Value assigned to this matched Account Scoring criterion

Companies

Retrieve

This endpoint allows you to get basic information on a particular company.

curl --request GET \
  --header "Authorization: Bearer ACCESS_TOKEN" \
  https://api.datafox.com/2.0/companies/51c6b9a5a9812aa90b123980

JSON Response:

{
  "object_type": "company",
  "id": "51c6b9a5a9812aa90b123980",
  "slug": "datafox",
  "name": "DataFox",
  "url": "www.datafox.com",
  "location": "San Francisco, CA",
  "icon_url": "//datafox-data.s3.amazonaws.com/favicons/51c6b9a5a9812aa90b123980.ico",
  "last_modified_date": "2019-10-20T17:18:22.954Z"
}

HTTP Endpoint

https://api.datafox.com/2.0/companies/:id

Response

Company

List

This endpoint allows you to get companies based upon IDs, name, URL, list, or date updated.

curl --request GET \
  --header "Authorization: Bearer ACCESS_TOKEN" \
  https://api.datafox.com/2.0/companies\?url\=datafox.co

JSON Response:

{
  "total_count": 1,
  "entries": [
    {
      "object_type": "company",
      "id": "51c6b9a5a9812aa90b123980",
      "slug": "datafox",
      "name": "DataFox",
      "url": "www.datafox.com",
      "location": "San Francisco, CA",
      "icon_url": "//datafox-data.s3.amazonaws.com/favicons/51c6b9a5a9812aa90b123980.ico",
      "last_modified_date": "2019-10-20T17:18:22.954Z"
    }
  ]
}

HTTP Endpoint

https://api.datafox.com/2.0/companies

Query Parameters

Query parameters for the list companies endpoint
Parameter Type Default Description
ids String Comma-separated list of company ids (maximum is 100)
url String The URL to search on
name String The name of the company
last_modified_date_after Date The date the company was last modified (after or equal).
last_modified_date_before Date Combine with last_modified_date_after to filter between a range.
fields String Comma-separated list of fields to format [Company] entries with
offset Integer 0 Number of results to skip
limit Integer 10 Number of results to show (maximum is 100)

Response

Fields returned by the list companies endpoint
Field Type
total_count Integer
entries [Company] (basic or with selected fields)

Details

This endpoint allows you to get more detailed information on a particular company.

curl --request GET \
  --header "Authorization: Bearer ACCESS_TOKEN" \
  https://api.datafox.com/2.0/companies/51c6b9a5a9812aa90b123980/details

JSON Response:

{
  "object_type": "company",
  "id": "51c6b9a5a9812aa90b123980",
  "slug": "datafox",
  "name": "DataFox",
  "url": "www.datafox.com",
  "location": "San Francisco, CA",
  "icon_url": "//datafox-data.s3.amazonaws.com/favicons/51c6b9a5a9812aa90b123980.ico",
  "last_modified_date": "2019-10-20T17:18:22.954Z",
  "status": "private",
  "ceo_name": "Bastiaan Janmaat",
  "description": "DataFox is a company intelligence platform that helps sales, marketing, andinvesting teams find and prioritize target companies to source moreopportunities. DataFox's team of 100+ human analysts verify AI-sourced insightson millions of businesses to provide robust Company Data, Growth Signals, andAccount Scoring. Headquartered in San Francisco, CA, DataFox is backed byGoldman Sachs, Green Visor, Google Ventures, and Slack, and used by high-growthstartups and Fortune 500 companies alike; examples include UPS, Accel Partners,Bain & Company, Twilio, Zendesk, and Outreach.",
  "street1": "475 Sansome St",
  "street2": "12th fl",
  "city": "San Francisco",
  "state": "CA",
  "country": "US",
  "zipcode": "94111",
  "top_keywords": [
    "software and technical consulting",
    "software",
    "crm orchestration",
    "company intelligence",
    "marketing teams"
  ],
  "revenue_estimate": 9500000,
  "number_of_employees": 48,
  "angellist_slug": "datafox",
  "crunchbase_permalink": "datafox",
  "linkedin_id": 3231060,
  "twitter_handle": "datafoxco",
  "blog_url": "http://datafox.com/blog",
  "industry_code": "industry_055",
  "industry_name": "Information Technology",
  "subindustry_code": "subindustry_373",
  "subindustry_name": "Financial Software"
}

HTTP Endpoint

https://api.datafox.com/2.0/companies/:id/details

Response

Company (full)

Account Score

This endpoint allows you to get the Account Score for any company enabling you to prioritize your accounts. You must set up your Account Scoring criteria in the DataFox application. This may require an account upgrade for this feature.

  curl --request GET \
    --header "Authorization: Bearer ACCESS_TOKEN" \
    https://api.datafox.com/2.0/companies/51c6b9a5a9812aa90b123980/account-score

JSON Response:

{
  "id": "5c9317768e2dc51d0479d590",
  "object_type": "account_score",
  "score": 220,
  "tier": "Tier 2",
  "last_updated_date": "2019-10-25T07:39:33.988Z",
  "last_modified_date": "2019-03-21T04:47:50.956Z",
  "account_scoring_criteria": [
    {
      "criterion": {
        "id": "5c92fd9c8e2dc51d04798a76",
        "object_type": "account_scoring_criterion",
        "name": "Headcount: 50 - 2k",
        "weight": 50
      }
    },
    {
      "criterion": {
        "id": "5c92fd9c8e2dc51d04798a77",
        "object_type": "account_scoring_criterion",
        "name": "Keyword: b2b, saas, software, manufacturing",
        "weight": 50
      }
    },
    {
      "criterion": {
        "id": "5c930cc68e2dc51d04798a78",
        "object_type": "account_scoring_criterion",
        "name": "Industry Categories: Information Technology",
        "weight": 50
      }
    },
    {
      "criterion": {
        "id": "5c9313908e2dc51d04798a7c",
        "object_type": "account_scoring_criterion",
        "name": "Technographics: HubSpot OR Marketo OR Eloqua",
        "weight": 50
      }
    },
    {
      "criterion": {
        "id": "5c9316578e2dc51d04798a7f",
        "object_type": "account_scoring_criterion",
        "name": "Conference: SaaStr Annual 2018",
        "weight": 20
      }
    }
  ]
}

HTTP Endpoint

https://api.datafox.com/2.0/companies/:id/account-score

Response

Account Score

Matching

Company Match

This endpoint allows you to match to a DataFox company from the company information that you have. It supports querying by name or URL and also allows refining by location parameters.

curl --request GET \
  --header "Authorization: Bearer ACCESS_TOKEN" \
  https://api.datafox.com/2.0/match/companies\?name\=DataFox

JSON Response:

{
  "matches": [
    {
      "confidence": 0.9525741268224334,
      "company": {
        "object_type": "company",
        "id": "51c6b9a5a9812aa90b123980",
        "slug": "datafox",
        "name": "DataFox",
        "url": "www.datafox.com",
        "location": "San Francisco, CA",
        "icon_url": "//datafox-data.s3.amazonaws.com/favicons/51c6b9a5a9812aa90b123980.ico",
        "last_modified_date": "2019-10-20T17:18:22.954Z"
      }
    }
  ]
}

HTTP Endpoint

https://api.datafox.com/2.0/match/companies

Query Parameters

Query parameters for the company match endpoint
Parameter Type Default Description
name String The name to match against
url String The URL to match against
street1 String Street part of address
street2 String Second street part of address
city String City of company
state String State of company
country String Country of company
zipcode String Zipcode of company
limit Integer 1 Number of match results to show (maximum is 10)

Response

Fields returned by the company match endpoint
Field Type
matches [MatchCompany]

Bulk Company Match

This endpoint allows you to match multiple companies to DataFox companies in one request. The query must be provided in the body of the request.

curl --request POST \
  --header "Authorization: Bearer ACCESS_TOKEN" \
  https://api.datafox.com/2.0/match/companies \
  --header "Content-Type: application/json" \
  --data '{"limit": 2, "queries": [{"name": "DataFox"}, {"url": "pagerduty.com"}]}' \

JSON Response:

{
  "results": [
    {
      "matches": [
        {
          "confidence": 0.9525741268224334,
          "company": {
            "object_type": "company",
            "id": "51c6b9a5a9812aa90b123980",
            "slug": "datafox",
            "name": "DataFox",
            "url": "www.datafox.com",
            "location": "San Francisco, CA",
            "icon_url": "//datafox-data.s3.amazonaws.com/favicons/51c6b9a5a9812aa90b123980.ico",
            "last_modified_date": "2019-10-20T17:18:22.954Z"
          }
        },
        {
          "confidence": 0.5498339973124778,
          "company": {
            "object_type": "company",
            "id": "58bdb116d547dd447ac8aeac",
            "slug": "datafox-srl",
            "name": "DataFox srl",
            "url": "www.datafox.it",
            "location": "Prato, Italy",
            "icon_url": "//datafox-data.s3-us-west-1.amazonaws.com/favicons/58bdb116d547dd447ac8aeac.ico",
            "last_modified_date": "2019-09-16T02:17:40.371Z"
          }
        }
      ]
    },
    {
      "matches": [
        {
          "confidence": 0.9241418199787566,
          "company": {
            "object_type": "company",
            "id": "5130f00a8989846a3600d870",
            "slug": "pagerduty",
            "name": "PagerDuty",
            "url": "pagerduty.com",
            "location": "San Francisco, CA",
            "icon_url": "//datafox-data.s3.amazonaws.com/favicons/5130f00a8989846a3600d870.ico",
            "last_modified_date": "2019-10-19T12:16:29.838Z"
          }
        }
      ]
    }
  ]
}

HTTP Endpoint

https://api.datafox.com/2.0/match/companies

Query Structure

{"limit": limit, "queries": [Match Query]}

where the limit, as above, is the number of desired match results to show. It defaults to 1 and has a maximum of 10.

Match Query Parameters

These are the same parameters as the query parameters for the single matching endpoint.

Query parameters for the bulk company match endpoint
Parameter Type Default Description
name String The name to match against
url String The URL to match against
street1 String Street part of address
street2 String Second street part of address
city String City of company
state String State of company
country String Country of company
zipcode String Zipcode of company

Response Structure

{"results": [{"matches": [MatchCompany]}]}

People Match to Companies

This endpoint allows you to match a person (e.g. lead) to one or more DataFox companies based on the person’s contact and company information that you have. It supports querying by email, company name, and company URL.

curl --request GET \
  --header "Authorization: Bearer ACCESS_TOKEN" \
  https://api.datafox.com/2.0/match/people-to-companies\?email\=someone@datafox.com\&company_name=datafox\&company_url=datafox.com

JSON Response:

{
  "matches": [
    {
      "confidence": 0.99,
      "company": {
        "object_type": "company",
        "id": "51c6b9a5a9812aa90b123980",
        "slug": "datafox",
        "name": "DataFox",
        "url": "www.datafox.com",
        "location": "San Francisco, CA",
        "icon_url": "//datafox-data.s3.amazonaws.com/favicons/51c6b9a5a9812aa90b123980.ico",
        "last_modified_date": "2019-10-20T17:18:22.954Z"
      }
    }
  ]
}

HTTP Endpoint

https://api.datafox.com/2.0/match/people-to-companies

Query Parameters

Query parameters for the people match endpoint
Parameter Type Default Description
email String Person’s email to match against
company_name String The company name to match against
company_url String The company URL to match against
limit Integer 1 Number of match results to show (maximum is 10)

Response

Fields returned by the people match endpoint
Field Type
matches [MatchCompany]

Bulk People Match to Companies

This endpoint allows you to match multiple people to DataFox companies in one request. The queries must be provided in the body of the request.

curl --request POST \
  --header "Authorization: Bearer ACCESS_TOKEN" \
  https://api.datafox.com/2.0/match/people-to-companies \
  --header "Content-Type: application/json" \
  --data '{"limit": 2, "queries": [{"company_name": "DataFox"}, {"company_url": "pagerduty.com"}]}' \

JSON Response:

{
  "results": [
    {
      "matches": [
        {
          "confidence": 0.9525741268224334,
          "company": {
            "object_type": "company",
            "id": "51c6b9a5a9812aa90b123980",
            "slug": "datafox",
            "name": "DataFox",
            "url": "www.datafox.com",
            "location": "San Francisco, CA",
            "icon_url": "//datafox-data.s3.amazonaws.com/favicons/51c6b9a5a9812aa90b123980.ico",
            "last_modified_date": "2019-10-20T17:18:22.954Z"
          }
        },
        {
          "confidence": 0.5498339973124778,
          "company": {
            "object_type": "company",
            "id": "58bdb116d547dd447ac8aeac",
            "slug": "datafox-srl",
            "name": "DataFox srl",
            "url": "www.datafox.it",
            "location": "Prato, Italy",
            "icon_url": "//datafox-data.s3-us-west-1.amazonaws.com/favicons/58bdb116d547dd447ac8aeac.ico",
            "last_modified_date": "2019-09-16T02:17:40.371Z"
          }
        }
      ]
    },
    {
      "matches": [
        {
          "confidence": 0.9241418199787566,
          "company": {
            "object_type": "company",
            "id": "5130f00a8989846a3600d870",
            "slug": "pagerduty",
            "name": "PagerDuty",
            "url": "pagerduty.com",
            "location": "San Francisco, CA",
            "icon_url": "//datafox-data.s3.amazonaws.com/favicons/5130f00a8989846a3600d870.ico",
            "last_modified_date": "2019-10-19T12:16:29.838Z"
          }
        }
      ]
    }
  ]
}

HTTP Endpoint

https://api.datafox.com/2.0/match/people-to-companies

Query Structure

{"limit": limit, "queries": [Person Match Query]}

where the limit, as above, is the number of desired match results to show. It defaults to 1 and has a maximum of 10.

Person Match Query Parameters

These are the same parameters as the query parameters for the single matching endpoint.

Query parameters for the bulk people match endpoint
Parameter Type Default Description
email String Person’s email to match against
company_name String The company name to match against
company_url String The company URL to match against
limit Integer 1 Number of match results to show (maximum is 10)

Response Structure

{"results": [{"matches": [MatchCompany]}]}

Similar Companies

List

This endpoint allows you to get related companies for a particular company.

curl --request GET \
  --header "Authorization: Bearer ACCESS_TOKEN" \
  "https://api.datafox.com/2.0/similar-companies?company=51c6b9a5a9812aa90b123980"

JSON Response:

{
  "total_count": 10,
  "entries": [
    {
      "confidence": 0.6236919012750993,
      "company": {
        "object_type": "company",
        "id": "51c6b7b2a9812aa90b11d27d",
        "slug": "mattermark",
        "name": "Mattermark",
        "url": "mattermark.com",
        "location": "San Francisco, CA",
        "icon_url": "//datafox-data.s3-us-west-1.amazonaws.com/favicons/51c6b7b2a9812aa90b11d27d.ico",
        "last_modified_date": "2019-10-19T21:15:28.037Z"
      }
    },
    {
      "confidence": 0.567223359738654,
      "company": {
        "object_type": "company",
        "id": "51f4e687f7cd59a178137c26",
        "slug": "cb-insights",
        "name": "CB Insights",
        "url": "cbinsights.com",
        "location": "New York, NY",
        "icon_url": "//datafox-favicons.s3.amazonaws.com/favicons/51f4e687f7cd59a178137c26.ico",
        "last_modified_date": "2019-10-19T22:03:35.758Z"
      }
    },
    {
      "confidence": 0.39830639008691293,
      "company": {
        "object_type": "company",
        "id": "5130f0398989846a3601723a",
        "slug": "quid",
        "name": "Quid",
        "url": "quid.com",
        "location": "San Francisco, CA",
        "icon_url": "//datafox-data.s3.amazonaws.com/favicons/5130f0398989846a3601723a.ico",
        "last_modified_date": "2019-10-19T20:34:58.065Z"
      }
    },
    {
      "confidence": 0.28497809180013517,
      "company": {
        "object_type": "company",
        "id": "5130efd48989846a36002fac",
        "slug": "bloomberg",
        "name": "Bloomberg",
        "url": "bloomberg.com",
        "location": "New York, NY",
        "icon_url": "//datafox-data.s3.amazonaws.com/favicons/5130efd48989846a36002fac.ico",
        "last_modified_date": "2019-10-20T09:05:28.632Z"
      }
    },
    {
      "confidence": 0.28349046704482783,
      "company": {
        "object_type": "company",
        "id": "5130efcd8989846a360019e2",
        "slug": "s-p-capital-iq-1",
        "name": "S&P Capital IQ",
        "url": "www.capitaliq.com",
        "location": "New York, NY",
        "icon_url": "//datafox-favicons.s3.amazonaws.com/favicons/5130efcd8989846a360019e2.ico",
        "last_modified_date": "2019-10-21T00:32:02.633Z"
      }
    },
    {
      "confidence": 0.23209253570798125,
      "company": {
        "object_type": "company",
        "id": "5130efd88989846a36003bc6",
        "slug": "thomson-reuters",
        "name": "Thomson Reuters",
        "url": "www.thomsonreuters.com",
        "location": "Toronto, Canada",
        "icon_url": "//datafox-data.s3.amazonaws.com/favicons/5130efd88989846a36003bc6.ico",
        "last_modified_date": "2019-10-20T09:48:08.619Z"
      }
    },
    {
      "confidence": 0.22717607351164207,
      "company": {
        "object_type": "company",
        "id": "5130f0c58989846a360371ec",
        "slug": "crunchbase",
        "name": "CrunchBase",
        "url": "crunchbase.com",
        "location": "San Francisco, CA",
        "icon_url": "//datafox-favicons.s3.amazonaws.com/favicons/5130f0c58989846a360371ec.ico",
        "last_modified_date": "2019-10-19T22:09:28.872Z"
      }
    },
    {
      "confidence": 0.1858391147025258,
      "company": {
        "object_type": "company",
        "id": "5130efc28989846a3600008e",
        "slug": "google-llc",
        "name": "Google",
        "url": "google.com",
        "location": "Mountain View, CA",
        "icon_url": "//datafox-data.s3-us-west-1.amazonaws.com/favicons/5130efc28989846a3600008e.ico",
        "last_modified_date": "2019-10-18T12:54:40.197Z"
      }
    },
    {
      "confidence": 0.17458838333287233,
      "company": {
        "object_type": "company",
        "id": "5130f0468989846a3601a382",
        "slug": "factset-research-systems-inc",
        "name": "FactSet Research Systems Inc.",
        "url": "factset.com",
        "location": "Norwalk, CT",
        "icon_url": "//datafox-favicons.s3.amazonaws.com/favicons/5130f0468989846a3601a382.ico",
        "last_modified_date": "2019-10-17T05:45:12.203Z"
      }
    },
    {
      "confidence": 0.17219753264822416,
      "company": {
        "object_type": "company",
        "id": "5130f02c8989846a3601483a",
        "slug": "duedil",
        "name": "DueDil",
        "url": "duedil.com",
        "location": "London, United Kingdom",
        "icon_url": "//datafox-data.s3.amazonaws.com/favicons/5130f02c8989846a3601483a.ico",
        "last_modified_date": "2019-10-20T21:04:16.920Z"
      }
    }
  ]
}

HTTP Endpoint

https://api.datafox.com/2.0/similar-companies

Query Parameters

Query parameters for the retrieve similar companies endpoint
Parameter Type Default Description
company ID Which company to query for similar companies

Response

Field Type
total_count Integer
entries [SimilarCompany]

Signals

Access Oracle DataFox company signals across categories such as growth, finance, and more. A given signal consists of a DataFox company, a signal tag, the signal date, and the backing sources. See the available Signal Tags for a full list of possible tags. There can be multiple sources for a given signal, spanning multiple object types. For more information on the types of signals, see Signal Types

Retrieve

This endpoint allows you to get information on a particular signal.

curl --request GET \
  --header "Authorization: Bearer ACCESS_TOKEN" \
  "https://api.datafox.com/2.0/signals/5994f2526403c15c74bc2725"

JSON Response:

{
  "id": "5994f2526403c15c74bc2725",
  "object_type": "signal",
  "company": {
    "object_type": "company",
    "id": "51c6b9a5a9812aa90b123980",
    "slug": "datafox",
    "name": "DataFox",
    "url": "www.datafox.com",
    "location": "San Francisco, CA",
    "icon_url": "//datafox-data.s3.amazonaws.com/favicons/51c6b9a5a9812aa90b123980.ico",
    "last_modified_date": "2019-10-20T17:18:22.954Z"
  },
  "tag": "marketing-activity",
  "date": "2017-08-17T00:04:47.000Z",
  "sources": [
    {
      "id": "5994f24e4b1e59d92e666617",
      "object_type": "snippet",
      "text": "DataFox today announced it has launched DataFox Company Intelligence & CRM Orchestration on the Salesforce AppExchange, empowering businesses to connect with their customers, partners and employees in entirely new ways.",
      "company_tags": [
        {
          "object_type": "company_tag",
          "company": "51c6b9a5a9812aa90b123980",
          "tag": "marketing-activity"
        },
        {
          "object_type": "company_tag",
          "company": "58f414e63b65109960b6ef81",
          "tag": "marketing-activity"
        }
      ],
      "article": {
        "id": "5994dee6b9543b5c7928c9dd",
        "object_type": "news",
        "title": "DataFox Announces DataFox Company Intelligence & CRM Orchestration on the Salesforce AppExchange, the World's Leading Enterprise Apps Marketplace",
        "url": "http://www.pressreleaserocket.net/datafox-announces-datafox-company-intelligence-crm-orchestration-on-the-salesforce-appexchange-the-worlds-leading-enterprise-apps-marketplace-2/585576/",
        "published": "2017-08-17T00:04:47.000Z",
        "source": "Press Release Rocket"
      }
    }
  ]
}

HTTP Endpoint

https://api.datafox.com/2.0/signals/:id

Response

Signal

List

This endpoint allows you to get signals for companies.

curl --request GET \
  --header "Authorization: Bearer ACCESS_TOKEN" \
  "https://api.datafox.com/2.0/signals?companies=51c6b9a5a9812aa90b123980&limit=1&after=2017-08-17&sort=asc"

JSON Response:

{
  "total_count": 95,
  "entries": [
    {
      "id": "5cd3490588cc86824aa4a42f",
      "object_type": "signal",
      "company": {
        "object_type": "company",
        "id": "51c6b9a5a9812aa90b123980",
        "slug": "datafox",
        "name": "DataFox",
        "url": "www.datafox.com",
        "location": "San Francisco, CA",
        "icon_url": "//datafox-data.s3.amazonaws.com/favicons/51c6b9a5a9812aa90b123980.ico",
        "last_modified_date": "2019-10-20T17:18:22.954Z"
      },
      "tag": "mention",
      "date": "2019-05-08T21:13:10.000Z",
      "sources": [
        {
          "id": "5cd348e9abf4f2d1471b3d4b",
          "object_type": "news",
          "title": "Oracle : AI-Driven Insights Can Produce the Best Business Data",
          "url": "http://www.marketscreener.com/ORACLE-CORPORATION-13620698/news/Oracle-AI-Driven-Insights-Can-Produce-the-Best-Business-Data-28562642/?utm_medium=RSS&utm_content=20190508",
          "published": "2019-05-08T21:13:10.000Z",
          "source": "4-Traders - news",
          "mentions": [
            {
              "object_type": "company",
              "id": "5130efc98989846a3600107a",
              "slug": "oracle",
              "name": "Oracle",
              "url": "oracle.com",
              "location": "Redwood City, CA",
              "icon_url": "//datafox-favicons.s3.amazonaws.com/favicons/5130efc98989846a3600107a.ico",
              "last_modified_date": "2019-10-18T20:13:50.825Z"
            },
            {
              "object_type": "company",
              "id": "51c6b9a5a9812aa90b123980",
              "slug": "datafox",
              "name": "DataFox",
              "url": "www.datafox.com",
              "location": "San Francisco, CA",
              "icon_url": "//datafox-data.s3.amazonaws.com/favicons/51c6b9a5a9812aa90b123980.ico",
              "last_modified_date": "2019-10-20T17:18:22.954Z"
            }
          ],
          "snippets": [

          ]
        }
      ]
    }
  ]
}

HTTP Endpoint

https://api.datafox.com/2.0/signals

Query Parameters

Query parameters for the list signals endpoint
Parameter Type Default Description
companies String Comma-separated list of company ids (maximum is 10)
tags String all tags Comma-separated list of Signal Tags
offset Integer 0 Number of signals to skip
limit Integer 10 Number of signals to receive
after Date Date threshold to limit signal recency
before Date Date threshold to limit signal recency
sort_direction String desc Sort direction (“asc” or “desc”)

Response

Field Type
total_count Integer
entries [Signal]

Conferences

Retrieve

This endpoint allows you to get information on a particular conference.

curl --request GET \
  --header "Authorization: Bearer ACCESS_TOKEN" \
  https://api.datafox.com/2.0/conferences/582f7500a03b29c76b2d9a0a

JSON Response:

{
  "id": "582f7500a03b29c76b2d9a0a",
  "object_type": "conference",
  "name": "South by Southwest (SXSW) 2017",
  "slug": "sxsw-2017",
  "start_date": "2017-03-10T00:00:00.000Z",
  "end_date": "2017-03-19T00:00:00.000Z",
  "description": "The South by Southwest® (SXSW®) Conference & Festivals celebrate the convergence of the interactive, film, and music industries. Fostering creative and professional growth alike, SXSW® is the premier destination for discovery.",
  "short_description": "The South by Southwest® (SXSW®) Conference & Festivals celebrate the convergence of the interactive, film, and music industries. Fostering creative and professional growth alike, SXSW® is the premier destination for discovery.",
  "sector": "Media & Entertainment",
  "url": "www.sxsw.com/",
  "registration_url": "cart.sxsw.com/?_ga=1.79086484.186073030.1479435740",
  "screenshot_url": "//datafox-data.s3-us-west-1.amazonaws.com/images/conference_582f7500a03b29c76b2d9a0a",
  "city": "Austin",
  "state": "TX",
  "street1": null,
  "street2": null,
  "zipcode": null,
  "country": "US",
  "participant_lists": [
    {
      "id": "58342e9348be2f9a570d7df8",
      "object_type": "participant_list",
      "participation_type": "Speakers"
    },
    {
      "id": "58342e9948be2f9a570d86e3",
      "object_type": "participant_list",
      "participation_type": "Sponsors"
    },
    {
      "id": "58342e9948be2f9a570d8711",
      "object_type": "participant_list",
      "participation_type": "Partners"
    },
    {
      "id": "58aafd884cdd4bfc2fe14a04",
      "object_type": "participant_list",
      "participation_type": "Exhibitors"
    },
    {
      "id": "58aafd894cdd4bfc2fe14b3a",
      "object_type": "participant_list",
      "participation_type": "Participants"
    }
  ]
}

HTTP Endpoint

https://api.datafox.com/2.0/conferences/:id

Response

Conference

List

This endpoint allows you to get conferences by ids, name, and/or date.

curl --request GET \
  --header "Authorization: Bearer ACCESS_TOKEN" \
  https://api.datafox.com/2.0/conferences\?name\=SXSW\&starts_after=2017-01-01\&ends_before=2018-01-01

JSON Response:

{
  "total_count": 1,
  "entries": [
    {
      "id": "582f7500a03b29c76b2d9a0a",
      "object_type": "conference",
      "name": "South by Southwest (SXSW) 2017",
      "slug": "sxsw-2017",
      "start_date": "2017-03-10T00:00:00.000Z",
      "end_date": "2017-03-19T00:00:00.000Z",
      "description": "The South by Southwest® (SXSW®) Conference & Festivals celebrate the convergence of the interactive, film, and music industries. Fostering creative and professional growth alike, SXSW® is the premier destination for discovery.",
      "short_description": "The South by Southwest® (SXSW®) Conference & Festivals celebrate the convergence of the interactive, film, and music industries. Fostering creative and professional growth alike, SXSW® is the premier destination for discovery.",
      "sector": "Media & Entertainment",
      "url": "www.sxsw.com/",
      "registration_url": "cart.sxsw.com/?_ga=1.79086484.186073030.1479435740",
      "screenshot_url": "//datafox-data.s3-us-west-1.amazonaws.com/images/conference_582f7500a03b29c76b2d9a0a",
      "city": "Austin",
      "state": "TX",
      "street1": null,
      "street2": null,
      "zipcode": null,
      "country": "US",
      "participant_lists": [
        {
          "id": "58342e9348be2f9a570d7df8",
          "object_type": "participant_list",
          "participation_type": "Speakers"
        },
        {
          "id": "58342e9948be2f9a570d86e3",
          "object_type": "participant_list",
          "participation_type": "Sponsors"
        },
        {
          "id": "58342e9948be2f9a570d8711",
          "object_type": "participant_list",
          "participation_type": "Partners"
        },
        {
          "id": "58aafd884cdd4bfc2fe14a04",
          "object_type": "participant_list",
          "participation_type": "Exhibitors"
        },
        {
          "id": "58aafd894cdd4bfc2fe14b3a",
          "object_type": "participant_list",
          "participation_type": "Participants"
        }
      ]
    }
  ]
}

HTTP Endpoint

https://api.datafox.com/2.0/conferences

Query Parameters

Query parameters for the list conferences endpoint
Parameter Type Default Description
ids String Comma-separated list of conference ids (maximum is 100)
name String The name of the conference
company ID Search conferences attended by this company
starts_after Date Date threshold for the conference to start after
ends_before Date Date threshold for the conference to end before
offset Integer 0 Number of results to skip
limit Integer 10 Number of results to show (maximum is 100)

Response

Fields returned by the list conferences endpoint
Field Type
total_count Integer
entries [Conference]

Participant Lists

This endpoint allows you to retrieve the companies in a given participant list for a conference.

curl --request GET \
  --header "Authorization: Bearer ACCESS_TOKEN" \
  https://api.datafox.com/2.0/conferences/582f7500a03b29c76b2d9a0a/participant-lists/58aafd884cdd4bfc2fe14a04\?offset=0\&limit=1

JSON Response:

{
  "total_count": 308,
  "entries": [
    {
      "object_type": "company",
      "id": "5130efc38989846a360001a8",
      "slug": "scripps-networks-interactive",
      "name": "Scripps Networks Interactive",
      "url": "scrippsnetworksinteractive.com",
      "location": "Knoxville, TN",
      "icon_url": "//datafox-favicons.s3.amazonaws.com/favicons/5130efc38989846a360001a8.ico",
      "last_modified_date": "2019-10-17T15:57:02.541Z"
    }
  ]
}

HTTP Endpoint

https://api.datafox.com/2.0/conferences/:conference_id/participant-lists/:participant-list-id

Query Parameters

Query parameters for the list participants endpoint
Parameter Type Default Description
offset Integer 0 Number of results to skip
limit Integer 10 Number of results to show (maximum is 100)

Response

Fields returned by the list participants endpoint
Field Type
total_count Integer
entries [Company] (basic)

Lists

Create

curl --request POST \
  --header "Authorization: Bearer ACCESS_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{"name": "My New List"}' \
  https://api.datafox.com/2.0/lists

JSON Response:

{
  "id": "561d4b599ae49efd0500002d",
  "object_type": "list",
  "name": "My Example List",
  "slug": "my-example-list",
  "owner": {
    "id": "ccb2d9e21b41b0ffe0193dbd",
    "object_type": "user",
    "slug": "data-fox",
    "first_name": "Data",
    "last_name": "Fox",
    "team_id": "3e3e613c30ebc7f60e3a8d72"
  },
  "created_at": "2015-03-14T16:26:53.589Z",
  "modified_at": "2015-03-14T16:26:53.589Z",
  "is_public": false,
  "num_followers": 1,
  "num_companies": 0,
  "num_collaborators": 0,
  "acting_user_is_following": true,
  "acting_user_is_collaborator": false,
  "acting_user_is_owner": true,
  "is_shared_with_team": false
}

HTTP Endpoint

https://api.datafox.com/2.0/lists

Response

List

Retrieve

curl --request GET \
  --header "Authorization: Bearer ACCESS_TOKEN" \
  https://api.datafox.com/2.0/lists/561d4b599ae49efd0500002d

JSON Response:

{
  "id": "561d4b599ae49efd0500002d",
  "object_type": "list",
  "name": "My Example List",
  "slug": "my-example-list",
  "owner": {
    "id": "ccb2d9e21b41b0ffe0193dbd",
    "object_type": "user",
    "slug": "data-fox",
    "first_name": "Data",
    "last_name": "Fox",
    "team_id": "3e3e613c30ebc7f60e3a8d72"
  },
  "created_at": "2015-03-14T16:26:53.589Z",
  "modified_at": "2015-03-14T16:26:53.589Z",
  "is_public": false,
  "num_followers": 1,
  "num_companies": 0,
  "num_collaborators": 0,
  "acting_user_is_following": true,
  "acting_user_is_collaborator": false,
  "acting_user_is_owner": true,
  "is_shared_with_team": false
}

HTTP Endpoint

https://api.datafox.com/2.0/lists/:id

Response

List

Update

curl --request PUT \
  --header "Authorization: Bearer ACCESS_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{"is_public": true}' \
  https://api.datafox.com/2.0/lists/561d4b599ae49efd0500002d

JSON Response:

{
  "id": "561d4b599ae49efd0500002d",
  "object_type": "list",
  "name": "My Example List",
  "slug": "my-example-list",
  "owner": {
    "id": "ccb2d9e21b41b0ffe0193dbd",
    "object_type": "user",
    "slug": "data-fox",
    "first_name": "Data",
    "last_name": "Fox",
    "team_id": "3e3e613c30ebc7f60e3a8d72"
  },
  "created_at": "2015-03-14T16:26:53.589Z",
  "modified_at": "2015-03-14T16:36:53.589Z",
  "is_public": true,
  "num_followers": 1,
  "num_companies": 0,
  "num_collaborators": 0,
  "acting_user_is_following": true,
  "acting_user_is_collaborator": false,
  "acting_user_is_owner": true,
  "is_shared_with_team": false
}

HTTP Endpoint

https://api.datafox.com/2.0/lists/:id

Response

List

Delete

curl --request DELETE \
  --header "Authorization: Bearer ACCESS_TOKEN" \
  https://api.datafox.com/2.0/lists/561d4b599ae49efd0500002d

JSON Response:

{
  "id": "561d4b599ae49efd0500002d",
  "deleted": true
}

HTTP Endpoint

https://api.datafox.com/2.0/lists/:id

Response

Fields returned by the delete list endpoint
Field Type
id ID
deleted Boolean

List

curl --request GET \
  --header "Authorization: Bearer ACCESS_TOKEN" \
  https://api.datafox.com/2.0/lists

JSON Response:

{
  "count": 2,
  "entries": [
    {
      "id": "561d4b599ae49efd0500002d",
      "object_type": "list",
      "name": "My Example List",
      "slug": "my-example-list",
      "owner": {
        "id": "ccb2d9e21b41b0ffe0193dbd",
        "object_type": "user",
        "slug": "data-fox",
        "first_name": "Data",
        "last_name": "Fox",
        "team_id": "3e3e613c30ebc7f60e3a8d72"
      },
      "created_at": "2015-03-14T16:26:53.589Z",
      "modified_at": "2015-03-14T16:36:53.589Z",
      "is_public": false,
      "num_followers": 1,
      "num_companies": 0,
      "num_collaborators": 0,
      "acting_user_is_following": true,
      "acting_user_is_collaborator": false,
      "acting_user_is_owner": true,
      "is_shared_with_team": false
    }, {
      "id": "751d639483d98a6fe2e682ca",
      "object_type": "list",
      "name": "Another Example List",
      "slug": "another-example-list",
      "owner": {
        "id": "d2603610a584c5d5ed375ed9",
        "object_type": "user",
        "slug": "foxy-data",
        "first_name": "Foxy",
        "last_name": "Data",
        "team_id": "993030d175609a0e7e5fc7c9"
      },
      "created_at": "2013-02-13T20:40:16.944Z",
      "modified_at": "2015-10-10T07:12:45.811Z",
      "is_public": false,
      "num_followers": 2,
      "num_companies": 42,
      "num_collaborators": 0,
      "acting_user_is_following": false,
      "acting_user_is_collaborator": true,
      "acting_user_is_owner": false,
      "is_shared_with_team": false
    }
  ]
}

HTTP Endpoint

https://api.datafox.com/2.0/lists

Query Parameters

Query parameters for the lists endpoint
Parameter Type Default Description
sort String created_at What to sort on (“created_at” or “updated_at”)
sort_direction String desc Sort direction (“asc” or “desc”)

Response

Fields returned by the list lists endpoint
Field Type
count Integer
entries [List]

Add Companies

curl --request POST \
  --header "Authorization: Bearer ACCESS_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{"companies": ["51c6b9a5a9812aa90b123980"]}' \
  https://api.datafox.com/2.0/lists/561d4b599ae49efd0500002d/companies

JSON Response:

{
  "id": "561d4b599ae49efd0500002d",
  "object_type": "list",
  "name": "My Example List",
  "slug": "my-example-list",
  "owner": {
    "id": "ccb2d9e21b41b0ffe0193dbd",
    "object_type": "user",
    "slug": "data-fox",
    "first_name": "Data",
    "last_name": "Fox",
    "team_id": "3e3e613c30ebc7f60e3a8d72"
  },
  "created_at": "2015-03-14T16:26:53.589Z",
  "modified_at": "2015-03-14T16:46:53.589Z",
  "is_public": true,
  "num_followers": 1,
  "num_companies": 1,
  "num_collaborators": 0,
  "acting_user_is_following": true,
  "acting_user_is_collaborator": false,
  "acting_user_is_owner": true,
  "is_shared_with_team": false
}

HTTP Endpoint

https://api.datafox.com/2.0/lists/:id/companies

Form Values

Form values to provide to the add companies to list endpoint
Parameter Type Description
companies [String] Array of company ids to add to list

Remove Companies

curl --request DELETE \
  --header "Authorization: Bearer ACCESS_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{"companies": ["51c6b9a5a9812aa90b123980"]}' \
  https://api.datafox.com/2.0/lists/561d4b599ae49efd0500002d/companies

JSON Response:

{
  "id": "561d4b599ae49efd0500002d",
  "object_type": "list",
  "name": "My Example List",
  "slug": "my-example-list",
  "owner": {
    "id": "ccb2d9e21b41b0ffe0193dbd",
    "object_type": "user",
    "slug": "data-fox",
    "first_name": "Data",
    "last_name": "Fox",
    "team_id": "3e3e613c30ebc7f60e3a8d72"
  },
  "created_at": "2015-03-14T16:26:53.589Z",
  "modified_at": "2015-03-14T16:46:53.589Z",
  "is_public": true,
  "num_followers": 1,
  "num_companies": 0,
  "num_collaborators": 0,
  "acting_user_is_following": true,
  "acting_user_is_collaborator": false,
  "acting_user_is_owner": true,
  "is_shared_with_team": false
}

HTTP Endpoint

https://api.datafox.com/2.0/lists/:id/companies

Form Values

Form values to provide to the remove companies from list endpoint
Parameter Type Description
companies [String] Array of company ids to remove from the list

Dynamic Lists

Retrieve

Retrieves a specific dynamic list.

curl --request GET \
  --header "Authorization: Bearer ACCESS_TOKEN" \
  https://api.datafox.com/2.0/dynamic-lists/599f1891460cc86b9ae5e88d

JSON Response:

{
  "id": "599f1891460cc86b9ae5e88d",
  "object_type": "dynamic_list",
  "name": "Target Cybersecurity Bay Area Opportunities",
  "owner": {
    "id": "ccb2d9e21b41b0ffe0193dbd",
    "object_type": "user",
    "slug": "data-fox",
    "first_name": "Data",
    "last_name": "Fox",
    "team_id": "3e3e613c30ebc7f60e3a8d72"
  },
  "created_at": "2016-04-12T00:05:44.022Z",
  "modified_at": "2016-10-17T21:46:04.105Z"
}

HTTP Endpoint

https://api.datafox.com/2.0/dynamic-lists/:id

Response

Dynamic List

List

Lists the dynamic lists available to the authenticated user.

curl --request GET \
  --header "Authorization: Bearer ACCESS_TOKEN" \
  https://api.datafox.com/2.0/dynamic-lists?limit=1

JSON Response:

{
  "total_count": 2,
  "entries": [
    {
      "id": "599f1891460cc86b9ae5e88d",
      "object_type": "dynamic_list",
      "name": "Target Cybersecurity Bay Area Opportunities",
      "owner": {
        "id": "ccb2d9e21b41b0ffe0193dbd",
        "object_type": "user",
        "slug": "data-fox",
        "first_name": "Data",
        "last_name": "Fox",
        "team_id": "3e3e613c30ebc7f60e3a8d72"
      },
      "created_at": "2016-04-12T00:05:44.022Z",
      "modified_at": "2016-10-17T21:46:04.105Z"
    }
  ]
}

HTTP Endpoint

https://api.datafox.com/2.0/dynamic-lists

Query Parameters

Query parameters for the list dynamic list endpoint
Parameter Type Default Description
ids String 0 Comma-separated list of dynamic list ids (maximum is 100)
offset Integer 0 Number of results to skip
limit Integer 10 Number of results to show (maximum is 100)

Response

Field Type
total_count Integer
entries [Dynamic List]

List Companies

curl --request GET \
  --header "Authorization: Bearer ACCESS_TOKEN" \
  https://api.datafox.com/2.0/dynamic-lists/599f1891460cc86b9ae5e88d/companies?limit=1

JSON Response:

{
  "total_count": 8632,
  "entries": [
    {
      "object_type": "dynamic_list_company",
      "dynamic_list_id": "599f1891460cc86b9ae5e88d",
      "company": {
        "id": "51c6b9a5a9812aa90b123980",
        "object_type": "company",
        "name": "DataFox",
        "slug": "datafox",
        "url": "datafox.com",
        "location": "San Francisco, CA",
        "icon_url": "//datafox-data.s3.amazonaws.com/favicons/51c6b9a5a9812aa90b123980.ico"
      },
      "date_added": "2017-08-24T08:11:04.469Z"
    }
  ]
}

HTTP Endpoint

https://api.datafox.com/2.0/dynamic-lists/:id/companies

Query Parameters

Query parameters for the list dynamic list companies endpoint
Parameter Type Default Description
added_after Date Filters results by companies added after a certain date
added_before Date Filters results by companies added before a certain date
offset Integer 0 Number of results to skip
limit Integer 10 Number of results to show (maximum is 100)

Response

Fields returned by the list dynamic list companies endpoint
Field Type
total_count Integer
entries [Dynamic List Company]

Users

Create

This endpoint will create users in the same team as the authenticated user. It can only be performed by an authenticated user with administrator role.

curl --request POST \
  --header "Authorization: Bearer ACCESS_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{"first_name": "John", "last_name": "Doe", email: "john.doe@example.com"}' \
  https://api.datafox.com/2.0/users

JSON Response:

{
  "id": "561d4b599ae49efd0500002d",
  "object_type": "user",
  "first_name": "John",
  "last_name": "Doe",
  "slug": "john-doe-5",
  "team_id": "ccb2d9e21b41b0ffe0193dbd"
}

HTTP Endpoint

https://api.datafox.com/2.0/users

Form Values

Form values to provide to the create user endpoint
Parameter Type Description
first_name [String] First name of user
last_name [String] Last name of user
email [String] Unique email of user

Response

User

Retrieve

curl --request GET \
  --header "Authorization: Bearer ACCESS_TOKEN" \
  https://api.datafox.com/2.0/users/561d4b599ae49efd0500002d

JSON Response:

{
  "id": "561d4b599ae49efd0500002d",
  "object_type": "user",
  "first_name": "John",
  "last_name": "Doe",
  "slug": "john-doe-5",
  "team_id": "ccb2d9e21b41b0ffe0193dbd"
}

HTTP Endpoint

https://api.datafox.com/2.0/users/:id

Response

User

Update

This endpoint will update a user. It can only be performed by an authenticated user with administrator role or to update the currently authenticated user’s information.

curl --request PATCH \
  --header "Authorization: Bearer ACCESS_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{"first_name": "Jill"}' \
  https://api.datafox.com/2.0/users/561d4b599ae49efd0500002d

JSON Response:

{
  "id": "561d4b599ae49efd0500002d",
  "object_type": "user",
  "first_name": "Jill",
  "last_name": "Doe",
  "slug": "john-doe-5",
  "team_id": "ccb2d9e21b41b0ffe0193dbd"
}

HTTP Endpoint

https://api.datafox.com/2.0/users/:id

Form Values

Parameter Type Description
first_name [String] First name of user
last_name [String] Last name of user
email [String] Unique email of user

Response

User

Delete

This endpoint will delete a user. It can only be performed by authenticated user with administrator role. Cannot be used to delete the currently authenticated user.

curl --request DELETE \
  --header "Authorization: Bearer ACCESS_TOKEN" \
  https://api.datafox.com/2.0/users/561d4b599ae49efd0500002d

JSON Response:

{
  "id": "561d4b599ae49efd0500002d",
  "deleted": true
}

HTTP Endpoint

https://api.datafox.com/2.0/users/:id

Response

Fields returned by the delete user endpoint
Field Type
id ID
deleted Boolean

List

This endpoint lists all users in the same team as the authenticated user.

curl --request GET \
  --header "Authorization: Bearer ACCESS_TOKEN" \
  https://api.datafox.com/2.0/users

JSON Response:

{
  "count": 2,
  "entries": [
    {
      "id": "561d4b599ae49efd0500002d",
      "object_type": "user",
      "first_name": "Jill",
      "last_name": "Doe",
      "slug": "john-doe-5",
      "team_id": "ccb2d9e21b41b0ffe0193dbd"
    }, {
      "id": "acb2d9e21b41b0ffe0193dac",
      "object_type": "user",
      "first_name": "Sally",
      "last_name": "Dot",
      "slug": "sally-dot-1",
      "team_id": "ccb2d9e21b41b0ffe0193dbd"
    }
  ]
}

HTTP Endpoint

https://api.datafox.com/2.0/users

Response

Fields returned by the list users endpoint
Field Type
count Integer
entries [List]

Errors

Errors will be returned following the Error Object Type as described above. All error responses will use appropriate HTTP status codes (matching the error object’s status_code field).

The following is a list of the status codes and error codes sent by the API:

Errors returned by endpoints
Status Code Error Code
400 "bad_request"
401 "unauthorized"
403 "forbidden"
404 "not_found"
405 "method_not_allowed"
409 "conflict"
429 "too_many_requests"
500 "internal_server_error"

Change History

Review what’s new in this document.

October 2019

The following table lists changes introduced in this version of the document.

Change Type Description
Object Types Deleted Attribute Removed Technology from the API.
Companies Deleted Endpoints Removed Technologies, Preferred Technologies, and HG Data Technologies endpoints from the API.

September 2019

The following table lists changes introduced in this version of the document.

Change Type Description
Users New Endpoints Added Create, Update, List, and Delete endpoints to Users API response. Use these endpoints to manage your users if you have set up single sign-on to access Oracle DataFox.
Account Score Update to Endpoint Added last_modified_date to the Account Score endpoint.

August 2019

The following table lists changes introduced in this version of the document.

Change Type Description
Similar Companies Update to Attribute Added a disclaimer to the Similar Companies endpoint. You may now require an upgrade to use this endpoint.

July 2019

The following table lists changes introduced in this version of the document.

Change Type Description
Companies/Account Score New Attribute Added last_updated_date to Account Score API response.