Skip to main content
GET
/
resolver
/
api
/
v1
/
organizations
/
{organization_id}
/
resolution-rules
List resolution rules
curl --request GET \
  --url https://www.closient.com/resolver/api/v1/organizations/{organization_id}/resolution-rules \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {
      "id": "<string>",
      "scope_type": "ORGANIZATION",
      "order_index": 123,
      "enabled": true,
      "destination_type": "HOSTED_PAGE",
      "on_custom_url_dead": "SKIP_RULE",
      "created": "2023-11-07T05:31:56Z",
      "modified": "2023-11-07T05:31:56Z",
      "metadata": {},
      "scope_id": "<string>",
      "organization_id": "<string>",
      "product_id": "<string>",
      "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": [
        0
      ],
      "time_of_day_start": "<string>",
      "time_of_day_end": "<string>",
      "timezone": "<string>",
      "link_type": "<string>",
      "location_countries": [
        "<string>"
      ],
      "location_regions": [
        "<string>"
      ],
      "location_cities": [
        "<string>"
      ],
      "custom_url": "<string>"
    }
  ],
  "pagination": {
    "page": 2,
    "page_size": 2,
    "total_count": 1,
    "total_pages": 2,
    "has_next": true,
    "has_previous": true
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.closient.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
organization_id
string<shortuuid>
required

UUID of the organization whose rules to list. Caller must have VIEW permission.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$

Query Parameters

​
scope_type
enum<string> | null

Optional filter on rule scope. ORGANIZATION returns only org-wide rules; PRODUCT returns only per-product rules; etc. Omit to return rules at every scope.

Available options:
ORGANIZATION,
BRAND,
PRODUCT,
BATCH,
SERIAL
​
enabled
boolean | null

Optional filter on the enabled flag. true returns only currently-active rules; false returns only disabled-but-retained rules; omit to return both.

​
page
integer
default:1

Page number (1-indexed).

Required range: x >= 1
​
page_size
integer
default:25

Number of items per page (max 100).

Required range: 1 <= x <= 100

Response

200 - application/json

OK

​
data
ResolutionRuleOut · object[]
required

Items on the current page, each conforming to the endpoint's item schema. Empty when the result set is empty or page is past the end.

​
pagination
PaginationMeta · object
required

Pagination envelope describing position within the full result set.

Example:
{
  "has_next": true,
  "has_previous": false,
  "page": 1,
  "page_size": 25,
  "total_count": 342,
  "total_pages": 14
}