What are the options for the methods builder.get() and builder.getAll()?

korey · September 22, 2021, 9:55pm

The builder.get and builder.getAll methods can be passed options as the second argument. For example:

builder.getAll('model-name', { limit: 10 })

What are the possible options that can be passed? The best place to find that is in the source code type definition for GetContentOptions, which can be found on our Github:

github.com

BuilderIO/builder/blob/main/packages/core/src/builder.class.ts#L227

    
      
            /** @deprecated */
            browser?: string;
            /** @deprecated */
            cookie?: string;
            /** @deprecated */
            newVisitor?: boolean;
            /** @deprecated */
            operatingSystem?: string;
          }
          
          
export interface GetContentOptions {
            userAttributes?: UserAttributes;
            /**
             * Alias for userAttributes.urlPath except it can handle a full URL (optionally with host,
             * protocol, query, etc) and we will parse out the path.
             */
            url?: string;
            /**
             * @package
             */
            includeUrl?: boolean;

balleverte · November 15, 2022, 4:50am

@steve pointed out a really important option here:

builder.getAll('page', { options: { noTargeting: true }})

neri · October 5, 2023, 9:27am

It would be very helpful to have this information in a proper API documentation somewhere

manish-sharma · October 5, 2023, 9:44am

Hello @neri,

You can explore all the available options for our Content API in the documentation provided below:

neri · November 8, 2023, 11:49am

Thanks @manish-sharma for the link.

I don’t see the example (builder.getAll('page', { options: { noTargeting: true }})) in the Content API page.

Is there another docs page with that info?

Topic		Replies	Views
Why does builder.getAll not return all results? Technical Questions	1	2174	November 15, 2022
How to use builder.getAll() with web component Technical Questions	8	523	April 1, 2022
builder.getAll() issue in options {offset, limit} Bugs react	5	1090	March 27, 2023
SDKs fetching content change Announcements	1	436	August 14, 2024
builder.getAll(...) vs fetch? Technical Questions react , api , nextjs	1	70	August 6, 2024

What are the options for the methods builder.get() and builder.getAll()?

Related topics