/
Retrieve tags rules list

Retrieve tags rules list

Request

Retrieves a list of tags rules.

Security
SecretApiKey or JWT
Query
limitinteger, [ 0 .. 1000 ]

Limit the number of collection items to be returned. Use 0 to return an empty collection and still receive the count of matching items in Pagination-Total.

offsetinteger, [ 0 .. 1000 ]

Specifies the starting point within the collection of items to be returned.

sortArray of strings

Sorts and orders the collection of items. To sort in descending order, prefix with -. Multiple fields can be sorted by separating each with ,.

filterstring

Criteria for filtering collection items. This field requires a special format. Use , to specify multiple allowed values. Use ; to specify multiple fields.

For more information, see Search filters.

qstring

Use this field to perform a partial search of text fields.

curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/tags-rules?limit=0&offset=0&sort=string&filter=string&q=string' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

List of tags rules retrieved.

Headers
Pagination-Totalinteger

Total number of items that match the request. The value is independent of limit, including when limit is 0.

Example:332
Pagination-Limitinteger

Maximum number of items per page.

Example:100
Pagination-Offsetinteger

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

Example:2
Bodyapplication/json
Array [
idstring, <= 50 charactersread-only

ID of the rule.

Example:"tag_rule_0YVCEE5APAD7V84MK3P9CCJVYY"
namestringrequired

Name of the rule.

eventTypestring(GlobalEventType)required

Type of event.

Enum:"aml-list-possibly-matched""application-instance-disabled""application-instance-enabled""autodeposit-lookup-performed""balance-transaction-settled""coupon-application-removed""coupon-applied""coupon-expiration-modified""coupon-expired""coupon-issued"
filterstring or null

Filter that determines whether to tag or untag. This field requires a special format. Use , for multiple allowed values. Use ; for multiple fields.

For more information, see Using filters.

addTagsArray of strings, [ 0 .. 1000 ] itemsrequired

List of tags to add to the customer.

removeTagsArray of strings, [ 0 .. 1000 ] itemsrequired

List of tags to remove for the customer.

statusstring

Status of the rule.

Default:"active"
Enum:"active""inactive"
createdTimestring, (date-time)(CreatedTime)read-only

Date and time when the resource is created. This value is set automatically when the resource is created.

updatedTimestring, (date-time)(UpdatedTime)read-only

Date and time when the resource is updated. This value is set automatically when the resource is updated.

]
Response
[
  {
    "id": "tag_rule_0YVCEE5APAD7V84MK3P9CCJVYY",
    "name": "string",
    "eventType": "aml-list-possibly-matched",
    "filter": "string",
    "addTags": [ … ],
    "removeTags": [ … ],
    "status": "active",
    "createdTime": "2019-08-24T14:15:22Z",
    "updatedTime": "2019-08-24T14:15:22Z",
    "_links": [ … ]
  }
]