List merchant identifier (MID) exemptions - Marqeta Docs

GET//

Retrieve a list of all merchant (MID) exemptions.

URL query parameters

Fields	Description
card_product string Optional	Unique identifier of the card product whose associated MID exemptions you want to retrieve. Enter the string “null” to list MID exemptions that are not associated with a card product. Allowable Values: Existing `card_product` token, or “null”
user string Optional	Unique identifier of the user whose associated MID exemptions you want to retrieve. Enter the string “null” to list MID exemptions that are not associated with a user. Allowable Values: Existing user token, or “null”
active string Optional	Filters the returned MID exemptions by active state. Allowable Values: `true`, `false`, `all` Default value: `true`
count integer Optional	The number of resources to retrieve. Allowable Values: 1-10 Default value: 5
start_index integer Optional	The sort order index of the first resource in the returned array. Allowable Values: Any integer Default value: 0
fields string Optional	Comma-delimited list of fields to return (`field_1,field_2`, and so on). Leave blank to return all fields. Allowable Values: Comma-delimited list of fields, or blank
sort_by string Optional	Field on which to sort. Use any field in the resource model, or one of the system fields `lastModifiedTime` or `createdTime`. Prefix the field name with a hyphen (`-`) to sort in descending order. Omit the hyphen to sort in ascending order. Allowable Values: `createdTime`, `lastModifiedTime`, or any field in the resource model Default value: `-lastModifiedTime`

Response body

Fields	Description
count integer Conditionally returned	Number of resources retrieved. This field is returned if there are resources in your returned array. Allowable Values: 1-10
data array of objects Conditionally returned	Array of objects in a returned resource. Objects are returned as appropriate to your query. Allowable Values: Valid data array of one or more authorization control objects
data[].active boolean Conditionally returned	Indicates whether the merchant identifier authorization control exception is active. This field is returned if it exists in the resource. Allowable Values: `true`, `false`
data[].association object Conditionally returned	Defines the group of users to which the authorization control applies. This object is required if the `merchant_scope` object is not included in your request. Your request can include both the `association` and `merchant_scope` objects. If you include this object in your request, you must populate one or more of its fields. If no fields are populated, the authorization control applies to all users. Allowable Values: `card_product_token`, `user_token`
data[].association.card_product_token string Conditionally returned	Unique identifier of a card product. Specify a card product token in the `card_product_token` field to apply the authorization control to all users holding active cards associated with the card product. Pass either `card_product_token` or `user_token`, not both. Allowable Values: 1–36 chars
data[].association.user_token string Conditionally returned	Unique identifier of a user. Specify a user token in the `user_token` field to apply the authorization control to a single user. Pass either `card_product_token` or `user_token`, not both. Allowable Values: 1–36 chars
data[].created datetime Conditionally returned	Date and time when the resource was created, in UTC. This field is returned if it exists in the resource. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ
data[].end_time datetime Conditionally returned	Date and time when the exception ends, in UTC. This field is returned if it exists in the resource. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ
data[].last_updated datetime Conditionally returned	Date and time when the resource was last updated, in UTC. This field is returned if it exists in the resource. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ
data[].merchant_group_token string Conditionally returned	Unique identifier of the merchant group to be exempted. This field is returned if it exists in the resource. Allowable Values: 1–36 chars
data[].mid string Conditionally returned	Merchant to be exempted. This field is returned if it exists in the resource. Allowable Values: 1–36 chars
data[].name string Returned	Name of the merchant identifier authorization control exemption. Allowable Values: 255 char max
data[].start_time datetime Conditionally returned	Date and time when the exception starts, in UTC. This field is returned if it exists in the resource. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ
data[].token string Conditionally returned	Unique identifier of the merchant identifier authorization control exemption. This field is always returned. Allowable Values: Existing merchant identifier authorization control exemption token
end_index integer Conditionally returned	Sort order index of the last resource in the returned array. Allowable Values: Any integer
is_more boolean Conditionally returned	A value of `true` indicates that more unreturned resources exist. A value of `false` indicates that no more unreturned resources exist. This field is returned if there are resources in your returned array. Allowable Values: `true`, `false`
start_index integer Conditionally returned	Sort order index of the first resource in the returned array. Allowable Values: Any integer

Sample response body

JSON

{
  "count": 2,
  "start_index": 0,
  "end_index": 1,
  "is_more": false,
  "data": [
    {
      "token": "my_exempt_authcontrol",
      "name": "My Exempt Auth Control",
      "active": true,
      "mid": "984226812886",
      "created_time": "2022-07-03T13:22:07Z",
      "last_modified_time": "2022-07-03T17:22:07Z"
    },
    {
      "token": "my_exempt_authcontrol_2",
      "name": "My Exempt Auth Control 2",
      "active": true,
      "association": {
        "card_product_token": "my_card_product"
      },
      "mid": "1234567891",
      "created_time": "2022-07-03T17:22:07Z",
      "last_modified_time": "2022-07-03T17:22:07Z"
    }
  ]
}