Content Management API > Site

Retrieve the site

Query parameters

include string

Comma-separated list of relationship paths. A relationship path is a dot-separated list of relationship names. Allowed relationship paths: item_types, item_types.fields, item_types.fieldsets, item_types.singleton_item, account, owner.

Example:

"item_types,item_types.fields"

fields object

Sparse fieldsets: for each entity type, the attributes and the relationships to return, separated by commas. Each entity declares its attributes and its relationships in its own schema.

site string

Attributes and relationships to return for each site that this endpoint returns.

Example:

"name,domain,google_maps_api_token,owner"

item_type string

Attributes and relationships to return for each item_type that this endpoint returns.

Example:

"name,api_key,collection_appearance,singleton_item"

field string

Attributes and relationships to return for each field that this endpoint returns.

Example:

"label,field_type,localized,item_type"

fieldset string

Attributes and relationships to return for each fieldset that this endpoint returns.

Example:

"title,hint,collapsible,item_type"

item string

Attributes and relationships to return for each item that this endpoint returns.

Example:

"title,content,category,item_type"

account string

Attributes and relationships to return for each account that this endpoint returns.

Example:

"email,first_name,last_name"

organization string

Attributes and relationships to return for each organization that this endpoint returns.

Example:

"name"

Returns

Returns a resource object of type site

Examples

1
import { buildClient } from "@datocms/cma-client-node";
2

3
async function run() {
4
  const client = buildClient({ apiToken: process.env.DATOCMS_API_TOKEN });
5

6
  const site = await client.site.find();
7

8
  // Check the 'Returned output' tab for the result ☝️
9
  console.log(site);
10
}
11

12
run();

1
{
2
  id: "155",
3
  domain: "admin.my-awesome-website.com",
4
  favicon: "123",
5
  global_seo: {},
6
  google_maps_api_token: "xxxxxxxxxxxxx",
7
  imgix_host: "www.datocms-assets.com",
8
  internal_domain: "my-website.admin.datocms.com",
9
  last_data_change_at: "2017-03-30T09:29:14.872Z",
10
  locales: ["en"],
11
  name: "My Awesome Website",
12
  no_index: true,
13
  require_2fa: false,
14
  theme: { type: "monochromatic", hue: 16, logo: "123" },
15
  timezone: "Europe/London",
16
  ip_tracking_enabled: true,
17
  force_use_of_sandbox_environments: true,
18
  assets_cdn_default_settings: { image: {}, video: {} },
19
  meta: {
20
    created_at: "2020-04-21T07:57:11.124Z",
21
    improved_timezone_management: true,
22
    improved_hex_management: true,
23
    improved_gql_multilocale_fields: true,
24
    improved_gql_visibility_control: true,
25
    improved_boolean_fields: true,
26
    draft_mode_default: true,
27
    improved_validation_at_publishing: true,
28
    improved_exposure_of_inline_blocks_in_cda: true,
29
    improved_items_listing: true,
30
    milliseconds_in_datetime: true,
31
    non_localized_focal_points: true,
32
    allow_custom_theme: true,
33
  },
34
  item_types: [{ type: "item_type", id: "DxMaW10UQiCmZcuuA-IkkA" }],
35
  owner: { type: "account", id: "312" },
36
}