This quickstart walks you through your first reads: you check your API key, list your sites, read products, and call an endpoint directly. Before you begin, install epx and create an API key with the product.product_read_unpublished scope.
1

Set your API key

To keep the key between sessions, store it in a profile instead.
2

Check the key

The output shows your tenant, the token’s lifetime, and the scopes granted. If the key lacks the scope, epx says so and exits with code 3.
3

List your sites

Reads print a table by default. Add -o json to print the whole response, every value as Emporix sends it.
4

Read products

--limit 5 prints at most five products, and epx stops reading pages as soon as it can. Tables show English text by default; pass --language to pick another translation:
5

Filter and sort

--query takes an Emporix q filter and --sort an Emporix sort order, both passed as given.
6

Call any endpoint

epx api get sends a GET request to any Emporix API path and prints the JSON response. epx replaces {tenant} with your tenant; quote the path so your shell leaves the braces alone.

​
Next steps

Format output

Tables, CSV, JSON, YAML, and JSON Lines.

List, filter, and sort

Which lists take which flags, and how paging works.

Change data

Send your first write with a dry run.

CLI reference

Every command, its flags, and its scopes.