List transactions by tag

Use this endpoint to get a list of all transactions associated with a particular tag according to the tag's unique GUID. This lists all transactions that have been assigned to a particular tag using the create tagging endpoint.

Enhanced transaction data may be requested using the includes parameter. To use this optional parameter, the value should include the optional metadata requested such as repeating_transactions, merchants, classifications, geolocations. For more information, see the Optional Enhancement Query Parameter guide.

GET

/users/{user_identifier}/tags/{tag_guid}/transactions

Path Parameters

Field	Required	Type
user_identifier Use either the user id you defined or the MX-defined user guid. See MX-Defined GUIDs vs IDs Defined by You​.	Required	String
tag_guid The unique id for a tag.	Required	String

Query Parameters

Field	Required	Type
page Results are paginated. Specify current page.	Optional	Integer
records_per_page This specifies the number of records to be returned on each page. Defaults to 25. The valid range is from 10 to 1000. If the value exceeds 1000, the default value of 25 will be used instead.	Optional	Integer
from_date Filter transactions from this date. This only supports unix timestamp format. Defaults to 120 days ago if not provided.	Optional	String
to_date Filter transactions to this date (at midnight). This only supports unix timestamp format. Defaults to 5 days forward from the day the request is made to capture pending transactions.	Optional	String
from_created_at Filter transactions from the date the transaction was created. This only supports unix timestamp format.	Optional	String
to_created_at Filter transaction to the date in which the transaction was created. This only supports unix timestamp format.	Optional	String
from_updated_at Filter transactions from the date in which the transaction was updated. This only supports unix timestamp format.	Optional	String
to_updated_at Filter transactions to the date in which the transaction was updated. This only supports unix timestamp format.	Optional	String
includes Options for enhanced transactions. This query parameter is optional. Possible additional metadata: repeating_transactions, merchants, classifications, geolocations. The query value is format sensitive. To retrieve all available enhancements, append: ?includes=repeating_transactions,merchants,classifications,geolocations. The query options may be combined to specific enhancements. For example, to request Repeating Transactions and Geolocation data, use: ?includes=repeating_transactions,geolocations. Repeating Transactions: Identifies transactions with predictable recurrence patterns (e.g., Bill, Income, Subscription). Merchants: Enriches transactions with merchant name. Classifications: Provides more insight into the type of money movement that is occurring on the transaction, whether it be retail or investments. Geolocation: Provides geographic metadata.	Optional	String

Header Parameters

Field	Required	Type
Accept-Version MX Platform API version.	Required	String

Loading...