STstreakyc
Contacts

Get contact field

Changed on

Returns one custom contact field definition for a team.

get/v2/teams/{teamKey}/contacts/fields/{fieldKey}

Request

  • Base URL
    https://api.streak.com/api
  • URL
    https://api.streak.com/api/v2/teams/{teamKey}/contacts/fields/{fieldKey}
  • Auth
    HTTP bearer

Path parameters

fieldKeystring required
teamKeystring required

Response

OK

namestring required

Display name for the field.

keystring required

Stable key for the field.

type'TEXT_INPUT' | 'DROPDOWN' | 'CHECKBOX' | 'DATE' | 'PERSON' | 'FORMULA' | 'TAG' | 'TEAM_CONTACT' | 'TEAM_ORGANIZATION' required
defaultValuestring nullable

Default textual field value, when one is configured.

lastDefaultValueUpdatedTimestampinteger nullable

Timestamp when the default value last changed, in epoch milliseconds.

lastUpdatedTimestampinteger nullable

Timestamp when the field definition last changed, in epoch milliseconds.

Example response

{
  "lastDefaultValueUpdatedTimestamp": 1646870400000,
  "lastUpdatedTimestamp": 1646870400000
}

Changes