Retrieve contact information

Introduction

This endpoint allows you to retrieve information about your External Contact's account.

Data Requirements

Provide the following data requirements when sending a GET request to the Contact Information endpoint.

Additional Header parameter:

Parameter Required? Description Type
Client-Id No Unique identifier of Child Account (required only for Partner). See Authentication Page to learn more. String

The body of the request should contain the following property:

Parameter Required? Description Type
handle Yes This is the @handle associated with a contact's account. For an internal contact it appears as @{handle}, for an external contact the format is ^{XXXXX} where X represents randomly generated alphanumeric strings. An example would be ^be39D. String

Note: The "Try it!" feature located on the right below the code box, does not support GET requests that contain a body. To test out this GET endpoint, please use a third-party application such as Postman.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
Headers
string
Responses

404

Server Error

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json