---
updatedAt: 2026-02-24T11:18:45.000Z
agentTools:
  projectIndex: https://developer.medallia.com/medallia-apis/llms.txt
---

# /{customer-id}

Returns a customer's profile data for use in Medallia Conversations' reporting interfaces. All fields returned by the adapter are optional. The adapter returns whatever it can, and it may return an empty response.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Conversations API",
    "version": "1.0.0",
    "description": "Medallia Conversations enables communications with customers and employees through a conversational service such as SMS, Facebook Messenger, WhatsApp, and more.  A channel adapter connects Medallia Conversations with the end user device, handling the device-specific communications as needed.",
    "termsOfService": "https://medallia.com/about/legal/terms/api"
  },
  "servers": [
    {
      "url": "https://{conversations-api-gateway-hostname}",
      "variables": {
        "conversations-api-gateway-hostname": {
          "default": "conversations.sc4.medallia.com",
          "description": "The Medallia Experience Cloud hostname used to access Medallia Conversations' API gateway."
        }
      }
    },
    {
      "url": "https://{adapter-api-gateway-hostname}",
      "variables": {
        "adapter-api-gateway-hostname": {
          "default": "adapter-gateway.example.com",
          "description": "The endpoint used to make requests from Medallia Conversations to the channel adapter."
        }
      }
    }
  ],
  "paths": {
    "/{customer-id}": {
      "servers": [
        {
          "url": "https://{adapter-api-gateway-hostname}",
          "variables": {
            "adapter-api-gateway-hostname": {
              "default": "adapter-gateway.example.com",
              "description": "The endpoint used to make requests from Medallia Conversations to the channel adapter."
            }
          }
        }
      ],
      "get": {
        "tags": [
          "Channel Adapter Services"
        ],
        "description": "Returns a customer's profile data for use in Medallia Conversations' reporting interfaces. All fields returned by the adapter are optional. The adapter returns whatever it can, and it may return an empty response.",
        "parameters": [
          {
            "in": "path",
            "name": "customer-id",
            "description": "An identifier unique to the customer, such as phone number, email, or other channel-specific value. For phone numbers, the ID must be in E.164 format.",
            "schema": {
              "type": "string"
            },
            "required": true,
            "example": "jsmith@example.medallia.com"
          },
          {
            "in": "query",
            "name": "access_token",
            "description": "The access token is a shared token defined when creating the channel adapter in Medallia Conversations.  It is free-form text, but Medallia recommends using a cryptographically-secure token such as a UUID or other random nonce value.",
            "schema": {
              "type": "string"
            },
            "required": true,
            "example": "7f0e8b1f-81a1-41ec-8446-347df7318594"
          }
        ],
        "responses": {
          "200": {
            "description": "The customer's profile data. If the customer id provided is not found, an empty response should be returned.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerProfileData"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized."
          },
          "404": {
            "description": "A customer profile for the customer id provided was not found."
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "CustomerProfileData": {
        "type": "object",
        "properties": {
          "first_name": {
            "type": "string"
          },
          "last_name": {
            "type": "string"
          },
          "profile_pic": {
            "type": "string",
            "format": "uri",
            "description": "A publicly-accessible URL to the customer's avatar or profile picture."
          },
          "locale": {
            "type": "string",
            "description": "The ISO-639 or ISO-3166 country code."
          },
          "timezone": {
            "type": "integer",
            "format": "int64",
            "description": "Time zone offset, the number relative to GMT, (ex: -8)."
          },
          "phone_number": {
            "type": "string",
            "pattern": "^\\+[1-9]\\d{1,14}$",
            "description": "The customer's phone number, in E.164 format."
          }
        }
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```