List all customers

List all customers in your organization with pagination.

Introduction

The FeatureOS list all customers API allows you to retrieve information about your customers. You can also retrieve customers' associated data.

GET https://api.featureos.app/api/v3/customers

curl -X GET 'https://api.featureos.app/api/v3/customers' \
  -H 'API-KEY: YOUR_API_KEY' \
  -H 'Content-Type: application/json'

const response = await fetch('https://api.featureos.app/api/v3/customers', {
  method: 'GET',
  headers: {
    'API-KEY': 'YOUR_API_KEY',
    'Content-Type': 'application/json'
  }
});
const data = await response.json();

import requests

response = requests.get(
    'https://api.featureos.app/api/v3/customers',
    headers={
        'API-KEY': 'YOUR_API_KEY',
        'Content-Type': 'application/json'
    }
)
data = response.json()

Headers

Parameter	Default	Description
API-KEY	-	Generate from organization settings on the admin dashboard.

Query Parameters

Parameter	Default	Description
limit	30	Limits the number of results returned.
page	1	Page number of the results to fetch.

Sample Response

[
  {
    "id": 9116912321,
    "name": "Developer",
    "email": "[email protected]",
    "blocked": false,
    "post_count": 1,
    "votes_count": 1,
    "comments_count": 2,
    "member_since": "about 1 year",
    "created_at": "2021-06-29T11:19:08.000Z",
    "starred": true,
    "labels": ["DEV ", "RUBY"],
    "custom_fields": {
      "kind": "Customer"
    },
    "profile_picture": null
  },
  {
    "id": 911691232123,
    "name": "Design",
    "email": "[email protected]",
    "blocked": false,
    "post_count": 6,
    "votes_count": 13,
    "comments_count": 3,
    "member_since": "about 1 year",
    "created_at": "2021-07-07T09:54:24.000Z",
    "starred": true,
    "labels": [],
    "custom_fields": {
      "kind": "Vendor"
    },
    "profile_picture": null
  }
]