GET
/
sites
List sites
curl --request GET \
  --url https://api.usefathom.com/v1/sites \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "url": "/v1/sites",
  "has_more": true,
  "data": [
    {
      "id": "CDBUGS",
      "object": "site",
      "name": "Bugs Bunny Portfolio",
      "sharing": "none",
      "created_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Retrieve information about the account that owns the API key.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

limit
integer
default:10

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

Required range: 1 <= x <= 100
starting_after
string

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.

ending_before
string

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.

Response

200 - application/json

List of sites

The response is of type object.