younifyd
Menu

Retrieve Setting

This API helps you to view a specific setting.

GET/settings/{groupId}/{id}

Use it in a workflow

  1. Add a step and choose the WooCommerce connector.
  2. Pick the Retrieve Setting action (under Settings).
  3. Fill in the fields below, then reference the result from later steps as {{retrieveSetting.response.data}}.

Request

Path parameters

groupIdstringrequired

ID of settings group

idstringrequired

ID of setting to return

Response

Returns 200 with an object. Read it in later steps with {{retrieveSetting.response.data.<field>}}.

idstring

A unique identifier for the setting.

labelstring

A human readable label for the setting used in interfaces.

descriptionstring

A human readable description for the setting used in interfaces.

valuestring

Setting value.

defaultstring

Default value for the setting.

tipstring

Additional help text shown to the user about the setting.

typestring

Type of setting.

optionsobject

An object of option properties.

json
{
  "id": "string",
  "label": "string",
  "description": "string",
  "value": "string",
  "default": "string",
  "tip": "string",
  "type": "string",
  "options": {}
}

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