Skip to main content
GET
/
api
/
rest
/
rules
/
{id}
Get One Rule
curl --request GET \
  --url https://api.upwell.com/api/rest/rules/{id}
{
  "rule": {
    "actionType": "CREATE_EXCEPTION",
    "actionValue": "<unknown>",
    "conditionExpression": "<string>",
    "createdAt": "<unknown>",
    "criteriaField": "<string>",
    "criteriaObject": "CUSTOMER",
    "criteriaOperator": "ARRAY_DOES_NOT_HAVE_OBJECT_WITH_PROPERTY",
    "criteriaValue": "<string>",
    "customerId": "<string>",
    "id": "<string>",
    "priority": 123,
    "type": "CARRIER_INVOICE_EXCEPTION",
    "updatedAt": "<unknown>",
    "validationExpression": "<string>"
  }
}

Headers

​
authorization
string

Your API key will be used for authentication of the request. Authorization: YOUR_API_KEY

Path Parameters

​
id
string
required

"id" is required (enter it either in parameters or request body)

Response

200 - application/json

Responses for GET /api/rest/rules/{id}

​
rule
Rules · object

Rules used for matching, document requirements, etc