younifyd
Menu

Get layout by ID

Get layout by ID

GET/settings/layouts/{id}

Use it in a workflow

  1. Add a step and choose the Zoho CRM connector.
  2. Pick the Get layout by ID action (under Metadata).
  3. Fill in the fields below, then reference the result from later steps as {{getLayoutById.response.data}}.

Request

Path parameters

idstring (int64)required

Specify the unique identifier of the layout. Refer to the [Get Layouts](layouts.yaml#$.paths./settings/layouts.get) resource for valid values.

Query parameters

modulestringrequired

Specify the API name of the required module. Refer to the [Get Modules](modules.yaml#$.paths./settings/modules.get) resource for valid values.

modestring

Specify the layout mode to filter the response. Available modes vary by module type. Possible values: `all` - Request all available layout modes. `business_card` - Business card layout view. `quick_create` - Quick create form layout.

One ofallbusiness_cardquick_create

includestring

Specify additional data to include in the response beyond the default layout structure. Possible values: `total_profiles` — include the total count of profiles associated with each layout. `portal_user_types` — include portal user type associations for each layout.

One oftotal_profilesportal_user_types

include_inner_detailsstring

Specify additional inner details to include in the response for each field. Possible values: `fields.allowed_permissions_to_update` - Include the set of permissions eligible for update per field. `fields.portal_user_types` - Include portal user type permission entries per field.

include_element_typesstring

Specify the type of field component in the layout, distinguishing standard fields from mirror fields that derive their value from a lookup source. Possible values: `field` — a standard data field in the layout. `mirror_field` — a field that reflects a value from a related module lookup.

One offieldmirror_field

Response

Returns 200 with a oneOf. Read it in later steps with {{getLayoutById.response.data.<field>}}.

Need more? See the Zoho CRM guide for connection setup and behaviour shared by every action.