---
title: Retrieve beneficiary fields.
slug: fx-api/retrieve-beneficiary-fields
docTags: 
createdAt: 2025-05-30T02:39:22.451Z
---

{
  "id": "sLRvpIPZVdAPF7hIVeGz8",
  "type": "api-oas-v2",
  "data": {
    "method": "GET",
    "url": "https://sand-api.monoova.com/global/v1/beneficiaries/fields",
    "servers": [
      {
        "url": "https://sand-api.monoova.com/global/v1/beneficiaries/fields",
        "description": "Monoova Global server"
      }
    ],
    "name": "Retrieve beneficiary fields.",
    "description": "<p>Retrieves the fields that are enabled and required for creating a beneficiary based on the provided parameters. Alternatively when updating a beneficiary, the beneficiary_id can be provided to retrieve the fields for that specific beneficiary. Either beneficiary_id or country, currency, and remuneration type are required.</p>",
    "contentType": "application/json",
    "request": {
      "pathParameters": [],
      "headerParameters": [
        {
          "name": "accept",
          "type": "string",
          "kind": "optional",
          "description": "Generated from available response content types",
          "enum": [
            "application/json"
          ],
          "default": "application/json"
        }
      ],
      "queryParameters": [
        {
          "kind": "optional",
          "name": "beneficiary_id",
          "type": "integer",
          "description": ""
        },
        {
          "kind": "optional",
          "name": "required",
          "type": "boolean",
          "description": ""
        }
      ],
      "bodyDataParameters": [],
      "formDataParameters": [],
      "oAuthParameters": [],
      "cookieParameters": []
    },
    "responses": [
      {
        "statusCode": "200",
        "description": "A list of fields.",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "",
            "schema": [
              {
                "name": "fields",
                "kind": "optional",
                "type": "array",
                "description": "",
                "example": "",
                "itemType": "object",
                "customType": "object[]",
                "schema": [
                  {
                    "name": "name",
                    "kind": "optional",
                    "type": "string",
                    "description": ""
                  },
                  {
                    "name": "placeholder",
                    "kind": "optional",
                    "type": "string",
                    "description": ""
                  },
                  {
                    "name": "position",
                    "kind": "optional",
                    "type": "integer",
                    "description": ""
                  },
                  {
                    "name": "required",
                    "kind": "optional",
                    "type": "boolean",
                    "description": ""
                  },
                  {
                    "name": "editable",
                    "kind": "optional",
                    "type": "boolean",
                    "description": ""
                  },
                  {
                    "name": "model_attribute",
                    "kind": "optional",
                    "type": "string",
                    "description": ""
                  }
                ]
              }
            ],
            "isExpanded": true
          }
        ]
      }
    ],
    "hasXCodeSamples": false,
    "examples": {
      "languages": [
        {
          "id": "lWPiIuk6SJ9lzqH52f8gf",
          "language": "curl",
          "label": "cURL",
          "code": "curl --request GET \\\n     --url https://sand-api.monoova.com/global/v1/beneficiaries/fields \\\n     --header 'accept: application/json'"
        },
        {
          "id": "eXpU7OA47hLIvnSZfSbNa",
          "language": "javascript",
          "label": "javascript",
          "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n   method: 'GET',\n   headers: myHeaders,\n   redirect: 'follow'\n};\n\nfetch(\"https://sand-api.monoova.com/global/v1/beneficiaries/fields\", requestOptions)\n   .then(response => response.text())\n   .then(result => console.log(result))\n   .catch(error => console.log('error', error));"
        },
        {
          "id": "TdaJfJtA0FSEraO8yEp0V",
          "language": "ruby",
          "label": "Ruby",
          "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://sand-api.monoova.com/global/v1/beneficiaries/fields\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n"
        },
        {
          "id": "3poZiHXHAHngIimQHCwnz",
          "language": "python",
          "label": "Python",
          "code": "import requests\nimport json\n\nurl = \"https://sand-api.monoova.com/global/v1/beneficiaries/fields\"\n\npayload = {}\nheaders = {\n   'accept': 'application/json',\n   'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
        }
      ],
      "selectedLanguageId": "lWPiIuk6SJ9lzqH52f8gf"
    },
    "results": {
      "languages": [
        {
          "id": "wyqGNoSaW4umPMq1Rxv-n",
          "language": "200",
          "code": "// A list of fields.\n{\n  \"fields\": [\n    {\n      \"name\": \"\",\n      \"placeholder\": \"\",\n      \"position\": 0,\n      \"required\": false,\n      \"editable\": false,\n      \"model_attribute\": \"\"\n    }\n  ]\n}"
        }
      ],
      "selectedLanguageId": "wyqGNoSaW4umPMq1Rxv-n"
    }
  },
  "children": [
    {
      "text": ""
    }
  ]
}