Show examples in:
    Retrieve the site

    Query parameters

    include  string  Optional

    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.

    Returns

    Returns a site resource object.

    Examples

    Example code:
    import { buildClient } from '@datocms/cma-client-node';
    async function run() {
    const client = buildClient({ apiToken: '<YOUR_API_TOKEN>' });
    const site = await client.site.find({
    include: 'item_types,item_types.fields'
    });
    console.log(site);
    }
    run();
    Returned output:
    {
    id: '155',
    name: 'My Awesome Website',
    domain: 'admin.my-awesome-website.com',
    google_maps_api_token: 'xxxxxxxxxxxxx',
    imgix_host: 'www.datocms-assets.com',
    internal_domain: 'my-website.admin.datocms.com',
    locales: [
    'en'
    ],
    timezone: 'Europe/London',
    no_index: true,
    favicon: '123',
    last_data_change_at: '2017-03-30T09:29:14.872Z',
    require_2fa: false,
    ip_tracking_enabled: true,
    theme: {
    primary_color: {
    red: 128,
    green: 128,
    blue: 128,
    alpha: 128
    },
    light_color: {
    red: 128,
    green: 128,
    blue: 128,
    alpha: 128
    },
    accent_color: {
    red: 128,
    green: 128,
    blue: 128,
    alpha: 128
    },
    dark_color: {
    red: 128,
    green: 128,
    blue: 128,
    alpha: 128
    },
    logo: '123'
    },
    global_seo: {
    site_name: 'My Awesome Website',
    fallback_seo: {
    title: 'Default meta title',
    description: 'Default meta description',
    image: '123',
    twitter_card: 'summary_large_image'
    },
    title_suffix: ' - My Awesome Website',
    facebook_page_url: 'http://facebook.com/awesomewebsite',
    twitter_account: '@awesomewebsite'
    },
    meta: {
    improved_timezone_management: true
    },
    account: {
    type: 'account',
    id: '312'
    },
    item_types: [
    {
    type: 'item_type',
    id: '44'
    }
    ]
    }