FOfountain
Data Keys

List data keys

Changed on

List all data keys on the account. Supports pagination.

get/v2/data_keys

Request

  • Base URL
    https://api.fountain.com
  • URL
    https://api.fountain.com/v2/data_keys
  • Auth
    API key in header X-ACCESS-TOKEN

Query parameters

pageinteger

The page of results to retrieve.

per_pageinteger

The number of results to retrieve per page. The endpoint returns 20 results per page by default.

updated_atstring

A filter to limit which data_keys will be returned based on the last_updated_at data on the data_key.

key_type'file' | 'availability' | 'experience' | 'list' | 'date' | 'text' | 'boolean' | 'address' | 'address_history' | 'history_address' | 'history_employment' | 'employment' | 'employment_history' | 'license_data' | 'aliases' | 'country_code'

Filter based on the key_type of the data keys

storage'data' | 'avatar' | 'structured_data' | 'secure_data' | 'file'

Filter based on the storage type of the data keys. secure_data returns only secure keys, which require elevated permissions to view in the Hire UI.

in_useboolean

If true, will only return data_keys that are in use (i.e. data_fields_count >= 1)

Response

OK

Changes