Custom Fields
Supported custom field attributes:
| Attribute | Type | Description |
|---|---|---|
id | number | Unique identifier of the custom field. |
name | string | Name of the custom field. |
type | string | Type of the custom field. |
resource_type | string | Type name of the resource the custom field can be attached to. Possible values: lead, contact, prospect_and_customer, deal |
Custom field type
Every custom field has defined type, which implies possible value format:
| Type | Value Format |
|---|---|
address | Address |
bool | boolean(true) |
date | string("4/27/2016") |
datetime | string("4/28/2016 6:00") |
email | string("[email protected]") |
list | object({"id":1, "name":"ABC"}) |
multi_select_list | array([{"id":1, "name":"ABC"},{"id":3, "name":"XYZ"}]) |
number | string("123.45") |
phone | string |
string | string |
text | string |
url | string("http://foobar.com") |
Endpoints
Stream Custom Fields
Read the stream of custom fields events.
See the Firehose Overview article for more details on request and response formats and parameters.
Action
GET /v3/custom_fields/stream
Examples
Read the stream of custom field events
GET /v3/custom_fields/stream?position=tailAccept: application/jsonAuthorization: Bearer $ACCESS_TOKENUser-Agent: $CLIENT_NAME
HTTP/1.1 200 OKContent-Type: application/json{"items": [{"data": {"id": 26722,"name": "my_field","resource_type": "deal","type": "string"},"meta": {"event_id": "Id5Bsy9GQte0XM3nNqq3zQ","event_time": "2016-08-22T15:14:23Z","event_cause": "interaction","event_type": "created","sequence": 1,"type": "custom_field"}}],"meta": {"links": {"next": "https://api.getbase.com/v3/custom_fields/stream?position=ZmlyZWhvc2UuZmFjdG9pZC5jb250YWN0LnNuYXBzaG90cywxLDMwNTQ5Mg=="},"position": "ZmlyZWhvc2UuZmFjdG9pZC5jb250YWN0LnNuYXBzaG90cywxLDMwNTQ5Mg==","top": false}}