GET
/
admin
/
transaction-groups
cURL
curl '{backend_url}/admin/transaction-groups' \
-H 'Authorization: Bearer {access_token}'
{
  "limit": 123,
  "offset": 123,
  "count": 123,
  "transaction_groups": [
    {
      "id": "<string>",
      "code": "<string>",
      "credits": 123,
      "debits": 123,
      "balance": 123,
      "account": {},
      "metadata": {}
    }
  ],
  "estimate_count": 123
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
id

Filter by the transaction group's ID.

​
code

Filter by the transaction group's code.

​
created_at
object

Filter by a transaction group's creation date.

​
updated_at
object

Filter by a transaction group's update date.

​
limit
number

Limit the number of items returned in the list.

​
offset
number

The number of items to skip when retrieving a list.

​
order
string

The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with -.

​
fields
string

Comma-separated fields that should be included in the returned data. If a field is prefixed with + it will be added to the default fields, using - will remove it from the default fields. Without prefix it will replace the entire default fields.

​
$and
$and · object[]

Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.

​
$or
$or · object[]

Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.

Response

OK

The paginated list of transaction groups.

​
limit
number
required

The maximum number of transaction groups to return.

​
offset
number
required

The number of transaction groups to skip before retrieving the results.

​
count
number
required

The total number of transaction groups available.

​
transaction_groups
object[]
required

The list of transaction groups.

​
estimate_count
number

The transaction group's estimate count.