Contents x
    /contact/get
    • 1 Minute to read
    • Print
    • Dark
      Light
    Contents

    /contact/get

    • 1 Minute to read
    • Print
    • Dark
      Light
    Article summary

    Post
    /contact/get

    Returns a contact object that matches the specified identifier.
    Request body examples:

    {
        "type":"EMAIL",
        "value":"test@test.com"
    }

    {
        "type":"MOBILE",
        "value":"48505606707"
    }

    Note: Do not confuse user/get, which is a GET call requiring a user id, with contact/get, which is a POST call requiring a post body containing the identifier to query (email, mobile).

    Body parameters
    object
    type
    string
    Valid values[ "APP_ALIAS", "EMAIL", "EXTERNAL", "ID", "MOBILE", "UNIFIED_IDENTIFIER" ]
    unifiedIdentifierName
    string
    value
    string
    Responses
    200
    Expand All
    object
    contactId
    integer (int64)
    emailAddress
    string
    mobileNumber
    string
    applicationAlias
    string
    identifier
    string
    attributes
    Array of object (Attribute)
    object
    name
    string
    value
    string
    unifiedIdentifiers
    Array of object (Attribute)
    object
    name
    string
    value
    string
    channelAddresses
    Array of object (Attribute)
    object
    name
    string
    value
    string
    400

    Bad request. Can have several meanings:

    • Error message “cannot deserialize value”: Missing or typo in request body JSON. Remember that EMAIL or MOBILE keywords are case-sensitive and MUST be written in uppercase.
    • Error in formatted JSON block: Check the “errorCode” and “message” keys for the error and details, for example:
      • {
          "errorActor": "CLIENT",
          "errorCode": "NO_SUCH_OBJECT",
          "message": "Contact with identifier=nobody.here@example.com does not exist.",
          "objectType": "Contact",
          "propertyName": "identifier",
          "propertyValue": "nobody.here@example.com"
      }

    403

    Incorrect system user login credentials. Check username password, and check that the corresponding system user account is Type “API” or “Hybrid”.

    Was this article helpful?
    What's Next