Members

Gets the details for a member

Retrieves the details hullo stores about a specific member. The record will contain any attribute data added using either the hullo API or the hullo application along with the members phone number and full name.

get/endpoints/members/{phoneNumber}

Request

  • Base URL: https://app.hullo.me/api
  • URL: https://app.hullo.me/api/endpoints/members/{phoneNumber}
  • Auth: API key in header X-API-KEY

Path parameters

phoneNumberstring required

The phone number of the subscriber

Response

OK

registrationDatestring date-time

The date the member was registered

phoneNumberstring phone-number required

The phone number of the member

fullNamestring

The full name of the member as "<forename> <surname>"

attributesobject required

The attributes that describe the member

groupsstring[]

The list of groups this member belongs to

Example response

{
  "phoneNumber": "phoneNumber",
  "registrationDate": "2000-01-23T04:56:07.000+00:00",
  "fullName": "fullName",
  "groups": [
    "groups",
    "groups"
  ],
  "attributes": {
    "key": [
      "attributes",
      "attributes"
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.