Finding an API

To find an API for your application integration, you can search our catalogue of available APIs as follows:

1. Select the Find an API tab within the top navigation menu of the Find and Use an API Home page. This will show you to the search page.
2. Type a word or phrase for the API you wish to find into the Search box. The search function allows you to search for APIs by name, description and tags. You will have the options to apply filtering and pagination before or after your search.

The relevant result along with the API version is returned from any matches within the FaUAPI Consumption Portal API catalogue. Filtering and pagination can then be applied to your search result.

You can clear your search using the Clear search link below the Search button.

Applying Filtering

You can apply filtering to your API search by Backend application type or Data exposure classification.

Backend application type

Filtering by backend application types can be applied to your search based on the following:

• HTTP - Hypertext Transfer Protocol Secure (HTTPS) allows you to securely exchange data between our web service and your web browser application.
• SOAP - Simple Object Access Protocol (SOAP) allows you to share information encoded in Extensible Markup Language (XML) between our service and your client application.
• GraphQL - Allows you to query our service precisely and flexibly through a single API endpoint. Hence, your client application can request and only receive the specific data it needs.

Data Exposure

Filtering by data exposure classifications can be applied to your search based on the following:

• Public - APIs classified as public can be viewed and subscribed to by all users.

• Across government services - These APIs can be viewed by all users, however can only be subscribed to by users across government services as indicated by their registered GOV.UK One Login email address. For example, youremail@gov.uk.

• Across department services - These APIs can be viewed by all users, however can only be subscribed to by users within specific department services such as the DfE (Department For Education) and as indicated by their registered GOV.UK One Login email address. For example, email@education.gov.uk.

• Across service boundaries - These APIs can be viewed by all users, however can only be subscribed to by users within specific service boundary as indicated by their registered GOV.UK One Login email address. For example, digital@gov.uk.

Applying Pagination

You can change the number of results to be returned per page using the Display results dropdown box option.