Skip to main content
GET
/
allowlists
/
{id}
Get Allowlist Item
curl --request GET \
  --url https://api.loopreturns.com/api/v1/allowlists/{id} \
  --header 'X-Authorization: <api-key>'
{
  "id": 123,
  "type": "order",
  "value": "<string>",
  "secondary_value": "<string>",
  "created_at": "<string>"
}

Authorizations

​
X-Authorization
string
header
required

Path Parameters

​
id
integer
required

The unique identifier associated with the allowlist entry.

Response

Success

​
id
integer

The unique identifier associated with the allowlist entry.

​
type
enum<string>

The type of value allowed by this allowlist entry. order is the order number of the allowed order and email is the customer's email address.

Available options:
order,
email
​
value
string

The allowed value. Returns made using this value will override any other return ineligibility.

​
secondary_value
string

This value is not used.

​
created_at
string

The date and time at which the entry was created, using the ISO 8601 date format.