Skip to main content
GET
/
users
/
find_by_custom_field
cURL
curl --request GET \
  --url https://app.fliqr.ai/api/users/find_by_custom_field \
  --header 'X-ACCESS-TOKEN: <api-key>'
{
  "data": [
    {
      "id": 123,
      "page_id": 123,
      "first_name": "<string>",
      "last_name": "<string>",
      "channel": 123,
      "profile_pic": "<string>",
      "locale": "<string>",
      "gender": 123,
      "timezone": 123,
      "last_sent": 123,
      "last_delivered": 123,
      "last_seen": 123,
      "last_interaction": 123,
      "subscribed_date": "<string>",
      "subscribed": 123,
      "tags": [
        {
          "id": 123,
          "name": "<string>"
        }
      ],
      "custom_fields": [
        {
          "id": 123,
          "type": 123,
          "value": "<string>"
        }
      ]
    }
  ]
}

Authorizations

X-ACCESS-TOKEN
string
header
required

Query Parameters

field_id
string
required

Custom field ID. Use 'phone' or 'email' as custom field id if you want to find the user by phone or email

value
string
required

Response

data
object[]