Pagination
All top-level API resources allow you to fetch records in bulk via our “list” methods. These list methods share a common pagination structure.
Fathom utilizes cursor-based pagination and, as you can tell, we’ve taken use inspiration from the incredible Stripe API documentation. So this will be familiar to a lot of you. You can paginate using either starting_after
or ending_before
.
- When you use
starting_after
, we will sort records in chronological order, which will allow you to page from the start of time up until the current day. - And when you use
ending_before
, we will sort records in reverse chronological order, meaning we’ll effectively work in reverse chronological order from the object ID you give us.
Query String Parameters
A limit on the number of objects to be returned, between 1 and 100.
A cursor for pagination/navigation. starting_after
is an object ID. For example, if you requested 10 site objects, and the last item in the list was ABCDEF, you would send your next request with starting_after=ABCDEF
.
A cursor for pagination/navigation. ending_before
is an object ID. For example, if you requested 10 site objects, and the first item in the list was ABCDEF, you would send your next request with ending_before=ABCDEF
.