---
updatedAt: 2026-08-04T14:08:40.000Z
agentTools:
  projectIndex: https://docs.mesh.complyadvantage.com/llms.txt
---

# List custom fields for the account

Returns a paginated list of transaction custom fields configured for the account.

# OpenAPI definition

```json
{
  "components": {
    "schemas": {
      "activity_CustomField": {
        "properties": {
          "data_type": {
            "$ref": "#/components/schemas/activity_CustomFieldDataTypeV3"
          },
          "description": {
            "type": "string"
          },
          "display_name": {
            "type": "string"
          },
          "identifier": {
            "format": "uuid",
            "type": "string"
          },
          "key": {
            "type": "string"
          }
        },
        "required": [
          "data_type",
          "description",
          "display_name",
          "identifier",
          "key"
        ],
        "type": "object"
      },
      "activity_CustomFieldDataTypeV3": {
        "description": "The type of data stored in a custom field.",
        "enum": [
          "TEXT",
          "DECIMAL"
        ],
        "type": "string"
      },
      "activity_PaginatedResponseCustomField": {
        "properties": {
          "custom_fields": {
            "items": {
              "$ref": "#/components/schemas/activity_CustomField"
            },
            "type": "array"
          },
          "first": {
            "description": "The URL path to the first page.",
            "example": "/v1/resource?page_number=1",
            "type": "string"
          },
          "next": {
            "description": "The URL path to the next page.",
            "example": "/v1/resource?page_number=4",
            "nullable": true,
            "type": "string"
          },
          "prev": {
            "description": "The URL path to the previous page.",
            "example": "/v1/resource?page_number=2",
            "nullable": true,
            "type": "string"
          },
          "self": {
            "description": "The URL path to the current page.",
            "example": "/v1/resource?page_number=3",
            "type": "string"
          },
          "total_count": {
            "description": "Total number of items.",
            "example": 60,
            "format": "int64",
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "first",
          "self",
          "custom_fields"
        ],
        "type": "object"
      },
      "activity_ProblemDetailErrorResponse": {
        "additionalProperties": true,
        "properties": {
          "detail": {
            "nullable": true,
            "type": "string"
          },
          "identifier": {
            "format": "uuid",
            "type": "string"
          },
          "instance": {
            "format": "uri",
            "nullable": true,
            "type": "string"
          },
          "status": {
            "format": "int32",
            "nullable": true,
            "type": "integer"
          },
          "timestamp": {
            "format": "date-time",
            "type": "string"
          },
          "title": {
            "nullable": true,
            "type": "string"
          },
          "type": {
            "format": "uri",
            "nullable": true,
            "type": "string"
          }
        },
        "required": [
          "identifier",
          "timestamp"
        ],
        "type": "object"
      }
    },
    "securitySchemes": {
      "BearerAuth": {
        "description": "HTTP Bearer Token Authentication",
        "scheme": "bearer",
        "type": "http"
      }
    }
  },
  "info": {
    "title": "Mesh API",
    "version": "v2.0"
  },
  "openapi": "3.0.3",
  "paths": {
    "/v3/transactions/custom-fields": {
      "get": {
        "description": "Returns a paginated list of transaction custom fields configured for the account.",
        "operationId": "activityStoreListCustomFields",
        "parameters": [
          {
            "description": "One-based page index (1..N)",
            "example": 1,
            "in": "query",
            "name": "page_number",
            "required": false,
            "schema": {
              "default": 1,
              "minimum": 1,
              "type": "integer"
            }
          },
          {
            "description": "The size of the page to be returned",
            "example": 20,
            "in": "query",
            "name": "page_size",
            "required": false,
            "schema": {
              "default": 50,
              "minimum": 1,
              "type": "integer"
            }
          },
          {
            "description": "Sorting criteria in the format of: `[-]property` (`-` descending modifier).\n\n* Default sort order is ascending (without `-`).\n\n* Multiple sort criteria are supported.",
            "example": [
              "-timestamp"
            ],
            "in": "query",
            "name": "sort",
            "required": false,
            "schema": {
              "default": [],
              "items": {
                "type": "string"
              },
              "type": "array"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/activity_PaginatedResponseCustomField"
                }
              }
            },
            "description": "Paginated list of custom fields for the account"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/activity_ProblemDetailErrorResponse"
                }
              }
            },
            "description": "Validation error"
          },
          "500": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/activity_ProblemDetailErrorResponse"
                }
              }
            },
            "description": "Internal Server Error"
          }
        },
        "summary": "List custom fields for the account",
        "tags": [
          "Transactions"
        ]
      }
    }
  },
  "security": [
    {
      "BearerAuth": []
    }
  ],
  "servers": [
    {
      "description": "ComplyAdvantage Mesh API",
      "url": "https://api.mesh.complyadvantage.com"
    }
  ],
  "tags": [
    {
      "name": "Transactions"
    }
  ]
}
```