News API - Get news

Important: This connector and its actions have been removed from Nintex Workflow and can now be found in Nintex Gallery.

Use the News API - Get news action A tool for building the processes, logic, and direction within workflows. Actions are the steps the workflow performs to complete a process. to search for news articles that match your search query.

Attribution Unless otherwise authorised, you shall agree to display an attribution to News API alongside any implementation or display of the News API Data to indicate that News API technology is being used. The attribution should preferrably be a hyperlink to https://newsapi.org with the text "Powered by News API".

For more information about the News API connector, go to News API.

Configure the News API - Get news action

  1. Add the action to the workflow and open the action configuration panel. For more information, see Add an action to the workflow.

  2. Select a Connection. If you do not have a connection, see Add a connection.
  1. Select the Language to search for news articles in.
  2. Add news query key words, date options, and paging options.
  3. Create or select a variable for the output.

News API - Get news action fields and settings

Section Field Description Variable types

(unlabeled)

Connection Credentials and other settings that enables workflows to communicate with external systems, services, or applications. It's required to pass data between the workflow and the indicated service, which could be a cloud service, business application, or content store.

The News API connection used to retrieve the news articles.

To refresh the available connections, click .

(n/a)

Search filters

Language

The language you want to search for news in.

If you use a variable, use the 2-letter ISO-639-1 code of the language you want to get headlines for. For a list of the supported country codes see News API - Search everything.

Text, Decimal, Integer, Boolean, DateTime, Collection

  Search query

Keywords or phrases to search for in the article title and body.

Advanced search is supported here:

  • Surround phrases with quotes (") for exact match.

  • Prepend words or phrases that must appear with a + symbol. e.g.: +bitcoin

  • Prepend words that must not appear with a - symbol. e.g.: -bitcoin

  • Alternatively you can use the AND / OR / NOT keywords, and optionally group these with parenthesis. Eg: crypto AND (ethereum OR litecoin) NOT bitcoin.

Text, Decimal, Integer, Boolean, DateTime, Collection
  From date A date and optional time for the oldest article allowed. This should be in ISO 8601 format (e.g. 2021-03-26 or 2021-03-26T12:07:30) Text, Integer, DateTime
  To date A date and optional time for the newest article allowed. This should be in ISO 8601 format (e.g. 2021-03-26 or 2021-03-26T12:07:30) Text, Integer, DateTime
Paging Items per page The number of articles to retrieve per page. Used with Page number for paging. Integer
  Page The page number of articles to retrieve. Used with Articles per page for paging. Integer
Output News results

Stores the result of the action as an object with the following variables:

  • Status: (Text) If the request was successful or not. Options: OK, or error.

  • Total results: (Integer) The total number of results available for your request.

  • Articles: (Collection) The results of the request.

    • Source: (Object) The identifier id and a display name for the source this article came from.

      • ID: (Text) The unique identifier of the news source.

      • Name: (Text) The display name of the news source.

    • Author: (Text) The author of the article.

    • Title: (Text) The headline or title of the article.

    • Description: (Text) A description or snippet from the article.

    • URL: (Text) The direct URL to the article.

    • Image URL: (Text) The URL to a relevant image for the article.

    • Published at: (DateTime) The date and time that the article was published, in UTC (+000).

    • Content: (Text) The unformatted content of the article, where available. This is truncated to 200 chars.

Object