get https://api.accountabilityone.com/v1/CustomDataTypes
Retrieve Custom Data Types
This API endpoint enables you to retrieve a list of custom data types based on various query parameters. It serves as a valuable tool for efficiently accessing specific custom data types that match the provided filters.
To retrieve custom data types, make a request to this endpoint with the necessary query parameters. You can filter the results by IDs, search strings, transaction types, limit the number of records, and specify an offset for pagination.
Query Parameters
| Parameters | Type | Description |
|---|---|---|
| Ids | Array of int32s | List of custom data type IDs to retrieve. |
| SearchString | string | Allows searching for custom data types whose names contain the specified string. |
| TransactionType | int32 | Select only custom data types that belong to this transaction type. |
| Limit | int32 | Specify how many records to be included in the list. Default is 100. Max is 100. |
| Offset | int32 | Specify how many records to skip. |
Example Request
GET <https://{baseUrl}/v1/CustomDataTypes?ids=1,2,3&SearchString=example&TransactionType=sale&Limit=50&Offset=10>
Permission
| Transaction Type | Access Level |
|---|---|
| Custom Data | Full Access, Read Only |