Authentication

Apart from the fields and their values in a request, you may also specify the options to control how the request is interpreted and how a response is generated.

This parameter can be added to Get One and Get List of any CRM entity.

Option Description

Option	Description
`fields`	EXAMPLE: `?fields=name,title` Some requests return the compact representations of objects, to protect the resources and accomplish the request efficiently. While other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should return for the objects. Note! Regardless of the field options, the id of included objects will always be returned.

fields

EXAMPLE: ?fields=name,title

Some requests return the compact representations of objects, to protect the resources and accomplish the request efficiently. While other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should return for the objects.

Note! Regardless of the field options, the id of included objects will always be returned.

Default output looks like this:


# Request
curl -X GET \
     --header "Accept: application/json" \
     --header "X-API2CRM-USER-KEY: <your_user_key>" \
     --header "X-API2CRM-APPLICATION-KEY: <your_applicstion_key>" \
     "https://api-2445581398133.apicast.io:443/v1/account"

# Response
HTTP/1.1 200
[
  {
    "id": "00158000002bRg3AAE",
    "type": "Customer - Direct",
    "name": "Edge Comunic",
    "ticker_symbol": "EDGE",
    "employees": "12",
    "ownership": "Public",
    "industry": "Electronics",
    …
  },
  {
    "id": "00158000002bRg4AAE",
    "type": "Customer - Direct",
    "name": "Burlington Textiles Corp of America",
    "ticker_symbol": "BTXT",
    "employees": "9000",
    "ownership": "Public",
    "industry": "Apparel",
    ...
  },
  ...
]

You can send this request via a sandbox on our interactive documentation. Try request now

Output with field option will look like this:


# Request
curl -X GET \
     --header "Accept: application/json" \
     --header "X-API2CRM-USER-KEY: <your_user_key>" \
     --header "X-API2CRM-APPLICATION-KEY: <your_applicstion_key>" \
     "https://api-2445581398133.apicast.io:443/v1/account?fields=name%2Cindustry"

# Response
HTTP/1.1 200
[
  {
    "id": "00158000002bRg3AAE",
    "name": "Edge Comunic",
    "industry": "Electronics"
  },
  {
    "id": "00158000002bRg4AAE",
    "name": "Burlington Textiles Corp of America",
    "industry": "Apparel"
  },
  ...
]

You can send this request via a sandbox on our interactive documentation. Try request now