USusefathom
Sites

List sites

Changed on

Return a list of all sites this API key owns. Sites are sorted by created_at ascending to allow you to paginate with ease.

Permissions: Requires read access to all sites (all-sites-readonly) or full account access.

Returns: A list of site objects.

get/sites

Request

  • Base URL
    https://api.usefathom.com/v1
  • URL
    https://api.usefathom.com/v1/sites
  • Auth
    HTTP bearer

Query parameters

limitinteger
Example:10

A limit on the number of objects to be returned, between 1 and 100.

starting_afterstring

A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For example, if you make a list request and receive 10 objects ending with obj_foo, your subsequent call can include starting_after=obj_foo to fetch the next page.

ending_beforestring

A cursor for use in pagination, working in the opposite direction to starting_after. ending_before is an object ID that defines your place in the list.

Response

Successful response

Changes

  • 50679caad756Revision changes
    • info

      api operation id listSites was added

    • info

      api tag Sites added

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status