---
updatedAt: 2026-08-06T09:23:27.000Z
agentTools:
  projectIndex: https://developers.alcmeon.com/llms.txt
---

# Get fields for a social media user

Return user custom fields for a social media user.
Limitation: This feature is not available yet for Apple Messages. If you are considering using it, please contact our support team at support@alcmeon.com


# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "servers": [
    {
      "url": "https://api.alcmeon.com/",
      "description": "Production api server"
    }
  ],
  "info": {
    "title": "Custom Fields",
    "version": "1.0"
  },
  "x-readme": {
    "explorer-enabled": false
  },
  "security": [
    {
      "basic_auth": []
    },
    {
      "bearer_token": []
    }
  ],
  "components": {
    "securitySchemes": {
      "basic_auth": {
        "description": "Basic authentication using your environment Instance ID as username and Application Secret as password.\n",
        "type": "http",
        "scheme": "basic"
      },
      "bearer_token": {
        "description": "OAuth 2.0 Bearer token authentication.  Obtain a token by calling the /v1/oauth2/token endpoint with your credentials. The token is valid for one hour.\n",
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      }
    },
    "schemas": {
      "PrimitiveFieldValues": {
        "oneOf": [
          {
            "type": "integer",
            "description": "When the field is of type integer"
          },
          {
            "type": "number",
            "description": "When the field is of type float"
          },
          {
            "type": "string",
            "description": "When the field is of type string"
          },
          {
            "type": "string",
            "format": "uri",
            "description": "When the field is of type url"
          },
          {
            "type": "string",
            "format": "email",
            "description": "When the field is of type email"
          },
          {
            "type": "string",
            "format": "date-time",
            "description": "When the field is of type datetime"
          },
          {
            "type": "string",
            "format": "date",
            "description": "When the field is of type date"
          },
          {
            "type": "boolean",
            "description": "When the field is of type boolean"
          },
          {
            "type": "string",
            "format": "uuid",
            "description": "When the field is of type enum"
          },
          {
            "$ref": "#/components/schemas/MultiPickListFieldValue"
          },
          {
            "$ref": "#/components/schemas/PhoneFieldValue"
          }
        ]
      },
      "PhoneFieldValue": {
        "description": "When the field is of type Phone",
        "type": "object",
        "properties": {
          "country_prefix": {
            "type": "string"
          },
          "number": {
            "type": "string"
          }
        }
      },
      "MultiPickListFieldValue": {
        "description": "When the field is of type multi-picklist",
        "type": "array",
        "items": {
          "type": "string",
          "format": "uuid"
        }
      },
      "FieldValues": {
        "description": "A list of field/value pairs",
        "type": "array",
        "items": {
          "type": "object",
          "description": "A value for a specific field",
          "properties": {
            "field_id": {
              "type": "integer"
            },
            "field_value": {
              "$ref": "#/components/schemas/PrimitiveFieldValues"
            }
          }
        }
      },
      "ResponseError": {
        "type": "object",
        "properties": {
          "error": {
            "type": "string",
            "description": "A short string explaining the reason of the error."
          },
          "details": {
            "type": "string",
            "description": "A short string which describes what is wrong. Provide this string to  support@alcmeon.com if you wish to obtain more details about the problem.\n"
          }
        }
      },
      "RateLimitResponseError": {
        "type": "object",
        "properties": {
          "error": {
            "type": "string",
            "description": "Rate limit reached"
          },
          "details": {
            "type": "string",
            "description": "A string showing the time when the rate limit will be reset. Example: {'rate_limited_until': '2024-01-22T13:05:41Z'}\n"
          }
        }
      }
    }
  },
  "paths": {
    "/custom-field/accounts/{social_media_account_id}/users/{social_media_user_id}": {
      "parameters": [
        {
          "in": "path",
          "name": "social_media_account_id",
          "description": "An id which uniquely identifies a social media account.\n",
          "required": true,
          "schema": {
            "type": "integer"
          }
        },
        {
          "in": "path",
          "name": "social_media_user_id",
          "description": "The id uniquely identifying the user within the social media account. On Whatsapp, this is the user's phone number, in international format, without a leading +. For example a french phone number in this format will look like this 33672422826  (33 is the international prefix). The same format applies for Kakaotalk.\n",
          "required": true,
          "schema": {
            "type": "string"
          }
        }
      ],
      "get": {
        "tags": [
          "User"
        ],
        "summary": "Get fields for a social media user",
        "description": "Return user custom fields for a social media user.\nLimitation: This feature is not available yet for Apple Messages. If you are considering using it, please contact our support team at support@alcmeon.com\n",
        "responses": {
          "200": {
            "description": "Returned upon succes",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FieldValues"
                }
              }
            }
          },
          "404": {
            "description": "Returned if the social media user is not found for this social media account.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ResponseError"
                }
              }
            }
          },
          "429": {
            "description": "Rate limit reached. Default limit is set to 15 requests per minute.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RateLimitResponseError"
                }
              }
            }
          }
        }
      }
    }
  }
}
```