v1

latestOpenAPI 3.0.02026-07-24212113249.1 KB

Profiles

Retrieve an account profile

get/profiles/{account}

Path parameters

accountstring required

Account ID

Headers

organizationstring required

The URL of the end-user web application

Response

Successful resopnse

idstring

Profile ID

addressstring

Address

phonestring

Phone number

accountstring

Account ID

avatarstring

Avatar ID

created_atstring

Date and time the profile was created

Example response

{
  "id": "646f8e4619b10e18eb768ea8",
  "address": "123 Main Street",
  "phone": "1234567890",
  "custom_fields": {
    "key": "sample name",
    "value": "sample value"
  },
  "account": "646f8e4619b10e18eb768ea5",
  "avatar": "6577a5c920ab85a0a7aede6b",
  "created_at": "2023-05-25T16:35:18.274Z"
}