Contents

GET/fb/subscriber/getInfoByUserRef

The contact a checkbox plugin user_ref belongs to.

Key
The account's key, as a Bearer token
Limit
No per-second limit stated

Parameters

NameInTypeRequired
user_refqueryinteger or stringYes

Request

curl "https://engage.growthdept.ai/api/fb/subscriber/getInfoByUserRef?user_ref=%5Bobject%20Object%5D" \
  -H "Authorization: Bearer 1000001:YOUR_SECRET"

Answer

HTTP 200 with status: "success" and data:

FieldType
idstring
page_idstring
user_refsarray of object
first_namestring
last_namestring
namestring
genderstring or null
profile_picstring or null
localestring or null
languagestring or null
timezonestring
live_chat_urlstring
last_input_textstring or null
optin_phoneboolean
phonestring or null
optin_emailboolean
emailstring or null
subscribedstring or null
last_interactionstring or null
last_seenstring or null
is_followup_enabledboolean
ig_usernamestring or null
ig_idinteger or null
whatsapp_phonestring or null
whatsapp_bsuidstring or null
whatsapp_usernamestring or null
optin_whatsappboolean
custom_fieldsarray of object
tagsarray of Tag
FieldType
id*integer
name*string

Errors

  • 400 Refused
  • 401 Missing or invalid key
  • 429 Over the operation's limit; see Retry-After

Shapes and numbered codes: Errors.