civis.io.file_to_json

civis.io.file_to_json(file_id: int, client: APIClient | None = None, **json_kwargs)

Restore JSON stored in a Civis File

Parameters:

file_idint

ID of a JSON-formatted Civis File

clientcivis.APIClient, optional

If not provided, an civis.APIClient object will be created from the CIVIS_API_KEY.

**json_kwargs

Additional keyword arguments will be passed directly to json.load().

Returns:

The object extracted from the JSON-formatted file

See also

civis_to_file()

json.load()