User.com REST API Docs

# List all company segments

You can return a list with all of your companies’ segments. Use a returned URL to list all companies added to the segment.

GET /companies-segments/

# Request

  • CURL
  • JavaScript
  • PHP
  • Python 
curl -X GET -H "Authorization: Token <your_64_char_api_key>"
-H "Accept: */*; version=2"
"https://<your_app_subdomain>.user.com/api/public/companies-segments/"

# Response

{
  "previous": null,
  "results": [
    {
      "name": "Big",
      "description": "Companies with more than 100 employees.",
      "companies": "https://<your_app_subdomain>.user.com/api/public/companies-segments/1038/companies/",
      "id": 1038,
      "object_count": 100,
      "too_heavy": false,
      "update_interval": 240,
      "last_counted": "2024-10-11T10:12:32.661576Z",
      "updated_at": "2024-10-11T10:12:32.661848Z"
    },
    {
      "name": "New",
      "description": "Companies which started subscription during the last 3 months.",
      "companies": "https://<your_app_subdomain>.user.com/api/public/companies-segments/1039/companies/",
      "id": 1039,
      "object_count": 100,
      "too_heavy": false,
      "update_interval": 240,
      "last_counted": "2024-10-11T10:12:32.661576Z",
      "updated_at": "2024-10-11T10:12:32.661848Z"
    },
  ],
  "next": null,
  "count": 2
}

← View deal segment →