Skip to main content
GET
/
resolver
/
api
/
v1
/
resolution-rules
/
{rule_public_id}
Get resolution rule
curl --request GET \
  --url https://www.closient.com/resolver/api/v1/resolution-rules/{rule_public_id} \
  --header 'X-API-Key: <api-key>'
{
  "public_id": "<string>",
  "scope_type": "<string>",
  "order_index": 123,
  "enabled": true,
  "destination_type": "<string>",
  "on_custom_url_dead": "<string>",
  "created": "2023-11-07T05:31:56Z",
  "modified": "2023-11-07T05:31:56Z",
  "scope_id": "<string>",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "absolute_start_at": "2023-11-07T05:31:56Z",
  "absolute_end_at": "2023-11-07T05:31:56Z",
  "annual_start_mmdd": "<string>",
  "annual_end_mmdd": "<string>",
  "days_of_week": [
    123
  ],
  "time_of_day_start": "<string>",
  "time_of_day_end": "<string>",
  "timezone": "<string>",
  "link_type": "<string>",
  "custom_url": "<string>"
}

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
rule_public_id
string
required

URL-safe public_id identifier of the resolution rule.

Response

OK

​
public_id
string
required

Unique rule identifier (URL-safe).

​
scope_type
string
required

Scope: 'global', 'gtin', or 'brand'.

​
order_index
integer
required

Priority order (lower = higher priority).

​
enabled
boolean
required

Whether the rule is currently active.

​
destination_type
string
required

Where to resolve: 'closient_page' or 'custom_url'.

​
on_custom_url_dead
string
required

Fallback policy: 'skip_rule' or 'fallback_closient'.

​
created
string<date-time>
required
​
modified
string<date-time>
required
​
scope_id
string | null

Scope identifier (GTIN or brand public_id).

​
organization_id
string<uuid> | null
​
product_id
string<uuid> | null
​
absolute_start_at
string<date-time> | null
​
absolute_end_at
string<date-time> | null
​
annual_start_mmdd
string | null
​
annual_end_mmdd
string | null
​
days_of_week
integer[] | null
​
time_of_day_start
string<time> | null
​
time_of_day_end
string<time> | null
​
timezone
string | null
​
link_type
string | null
​
custom_url
string | null

Custom redirect URL (required when destination_type is custom_url).