Skip to main content
GET
/
v1
/
validation-rules
/
{validationRuleId}
/
assignments
List Validation Rule Assignments
curl --request GET \
  --url https://{cluster}.voucherify.io/v1/validation-rules/{validationRuleId}/assignments \
  --header 'Authorization: Bearer <token>' \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>'
{
  "object": "list",
  "data_ref": "data",
  "data": [
    {
      "id": "asgm_74F7QZoYbUoljwQO",
      "rule_id": "val_4j7DCRm2IS59",
      "related_object_id": "v_MBOEmHelKwvykVZ8JcT4TE5Kla5IMJyc",
      "related_object_type": "voucher",
      "created_at": "2022-02-17T09:05:34.642Z",
      "object": "validation_rules_assignment"
    },
    {
      "id": "asgm_zzLBm8mIzGQStXl9",
      "rule_id": "val_4j7DCRm2IS59",
      "related_object_id": "v_JtWunK6jUo7X2qOFj0SyRHq4p9tgENlT",
      "related_object_type": "voucher",
      "created_at": "2022-02-17T08:18:15.085Z",
      "object": "validation_rules_assignment"
    },
    {
      "id": "asgm_JztMAws0e0Qx2Xy6",
      "rule_id": "val_4j7DCRm2IS59",
      "related_object_id": "camp_kjja4moiVB7hQKPGOT61026Z",
      "related_object_type": "campaign",
      "created_at": "2022-02-15T13:26:34.807Z",
      "object": "validation_rules_assignment"
    }
  ],
  "total": 3
}

Authorizations

​
X-App-Id
string
header
required
​
X-App-Token
string
header
required
​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
validationRuleId
string
required

Unique validation rule ID.

Example:

"val_TU4de3EP4dlL"

Query Parameters

​
limit
integer

Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items.

Required range: 1 <= x <= 100
​
page
integer

Which page of results to return. The lowest value is 1.

Required range: 1 <= x <= 100
​
order
enum<string>

This is a property that controls the sorting direction of the results. Sort the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order.

Available options:
created_at,
-created_at

Response

200 - application/json

Returns a dictionary of validation rule assignments. If the validation rule ID provided in the path parameter cannot be found, the endpoint will return an empty data array and a total of 0.

Response body for GET v1/validation-rules-assignments and GET v1/validation-rules/{validationRuleId}/assignments. Validation Rule Assignments List

​
object
string
default:list
required

The type of the object represented by JSON. This object stores information about validation rule assignments.

​
data_ref
string
default:data
required

Identifies the name of the JSON property that contains the array of validation rule assignments.

​
data
Validation Rule Assignment · object[]
required

A dictionary that contains an array of validation rule assignments.

​
total
integer
required

Total number of validation rule assignments.

⌘I