Search
Like '/companies/', a search can be performed on directorships by making a GET request to the '/directorships/' endpoint:
1
https://api2.redflagalert.net/v4/directorships/
Copied!
Returned resources will follow the JSON API format and will contain URLs in their 'links' section to the company they are linked to.
To filter directorship search results, append the criteria as request parameters in any order.

Search Parameters

The following fields can currently be searched on:
Field Name
Notes
title
The directors title
first_name
The directors first name
surname
The directors surname
name
The combination of first_name and surname, for example ‘Peter Smith’
town
The directors town of residence
county
The directors county of residence
nationality
The nationality of the director
postcode
The postcode of the directors residence
occupation
The occupation of the director
appointment_type
The type of the appointment
The searches can be combined. For example, to find directorships held by British nationals with the surname Morgan, the query would be:
1
https://api2.redflagalert.net/v4/directorships/?nationality=British&surname=Morgan
Copied!
When performing name searches, the 'name' field searches on full names. For example, the following query will only return directorships held by people called Peter Smith:
1
https://api2.redflagalert.net/v4/directorships/?first_name=Peter&surname=Smith
Copied!
While the following search will return all directorships held by people whose name is either similar to 'Peter' or 'Smith', with the most relevant results returned first:
1
https://api2.redflagalert.net/v4/directorships/?name=Peter%20Smith
Copied!
This means that 'Peter Smith' will rank highest, then 'Peter Smith Jones' then lastly, entries like 'James Smith’.
If an unrecognised field name is included in search parameters, it will be ignored.
To also receive the companies the directorships are linked to, append the 'company' string in the 'include=' GET parameter:
1
https://api2.redflagalert.net/v4/directorships/?include=company
Copied!
The response will be a compound document (see http://jsonapi.org/format/#document-compound- documents for format) containing the original search results along with the companies. All results are paginated.
1
https://api2.redflagalert.net/v4/directorships/?include=company
Copied!
Last modified 2yr ago
Copy link
Contents