User.com REST API Docs

# Attributes

You can get a list of all attributes' names and their types for each model.

GET /api/public/all-attributes/:model/

Attributes Type Required Description
model string yes Specific model with its own list of attributes.
It can be:
        - activity
        - company
        - deal
        - product
        - ticket
        - user

# 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/all-attributes/:model/"

# Response

[{'name': 'id', 'type': 'integer'},
 {'name': 'company_id', 'type': 'string'},
 {'name': 'assigned_to', 'type': 'integer'},
 {'name': 'name', 'type': 'string'},
 {'name': 'description', 'type': 'string'},
 {'name': 'email', 'type': 'string'},
 {'name': 'country', 'type': 'string'},
 {'name': 'region', 'type': 'string'},
 {'name': 'city', 'type': 'string'},
 {'name': 'phone_numbers', 'type': 'string'},
 {'name': 'address', 'type': 'string'},
 {'name': 'postal_code', 'type': 'string'},
 {'name': 'approx_employees', 'type': 'integer'},
 {'name': 'created_at', 'type': 'datetime'},
 {'name': 'updated_at', 'type': 'datetime'}]

← API changelog →