This endpoint supports multiple response formats. Pass serializer=name to retrieve data in an alternate format.

• Must be a value contained in the pick list:
  

  Acceptable Value	Description
  contact_field	Contact Field
  contact_field_form	Contact Field Form

Assign the record to this Offer.

• Must be a valid foreign key reference to an Offer. Refer to: /api/docs/1.0/offers

Return records matching these ids.

• Must be an array of decimal values. EG: [0, 1, 2, 3]

Return the next page of results.

• Must be a number.

How many results to return per page. The default is 25.

• Must be a number.

Date formatted like 2016-01-01 12:25:15 -0500

• Must be String

Date formatted like 2016-01-01 12:25:15 -0500

• Must be String

Search for any record that matches this text

• Must be String

Date ranges will be parsed using this time zone.

• Must be a valid time zone. See the list of valid time zones.

Specify the columns you would like returned by the API for a given resource. Limiting the columns can significantly increase API response time since only the requested data will be processed. columns=uuid,number,created_at

Must be any combination of:

• id
• legacy_id
• type
• uuid
• created_at
• updated_at
• deleted_at
• user_updated_at
• routes_show_path
• routes_edit_path
• external_record_id
• offer_id
• sortable_order
• key
• required
• required_on_create
• required_on_ping
• token_id
• check_buyer_filters_before_calling
• name
• context_menu_name
• hint
• value_type
• value_formatter
• value_expression
• html_id
• contact_field_value_ids
• show_in_docs
• show_in_tables
• show_in_reports
• value_decimal_min
• value_decimal_max
• decimal_places
• include_blank
• boolean_true_text
• boolean_false_text
• background_color
• text_color
• contact_field_values_type
• check_buyer_filters_allow_blank
• value_pattern_validation
• check_pattern_validation
• contact_field_values_count
• date_picker_in_future
• date_picker_enabled

• Must be String

Pass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}

• Must be a boolean value: 1, true, yes, on, 0, false, no, off

Assign the record to this Offer.

• Must be a valid foreign key reference to an Offer. Refer to: /api/docs/1.0/offers

The internal token name where values are stored.

• Must be String

Is this field required?

• Must be a boolean value: 1, true, yes, on, 0, false, no, off

The friendly human name displayed to users.

• Must be String

Display a helpful hint to users explaining the purpose of this field.

• Must be String

Field Type

• Must be one of: string, decimal, integer, time, boolean, expression, hidden.

Decimal values/expressions will be rounded to this many decimal places.

• Must be a decimal number.

Expression Formatter

• Must be one of: string, decimal, integer, time, boolean.

Expression

• Must be String

The order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.

• Must be a decimal number.

Assign the record to this Offer.

• Must be a valid foreign key reference to an Offer. Refer to: /api/docs/1.0/offers

The internal token name where values are stored.

• Must be String

Is this field required?

• Must be a boolean value: 1, true, yes, on, 0, false, no, off

The friendly human name displayed to users.

• Must be String

Display a helpful hint to users explaining the purpose of this field.

• Must be String

Field Type

• Must be one of: string, decimal, integer, time, boolean, expression, hidden.

Decimal values/expressions will be rounded to this many decimal places.

• Must be a decimal number.

Expression Formatter

• Must be one of: string, decimal, integer, time, boolean.

Expression

• Must be String

The order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.

• Must be a decimal number.

Assign the record to this Offer.

• Must be a valid foreign key reference to an Offer. Refer to: /api/docs/1.0/offers

The internal token name where values are stored.

• Must be String

Is this field required?

• Must be a boolean value: 1, true, yes, on, 0, false, no, off

The friendly human name displayed to users.

• Must be String

Display a helpful hint to users explaining the purpose of this field.

• Must be String

Field Type

• Must be one of: string, decimal, integer, time, boolean, expression, hidden.

Decimal values/expressions will be rounded to this many decimal places.

• Must be a decimal number.

Expression Formatter

• Must be one of: string, decimal, integer, time, boolean.

Expression

• Must be String

The order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.

• Must be a decimal number.