Params

Param name
Description
auth_token
Optional

Authorize requests using your token. Get it from your profile: trackdrive.net/profile/edit

  • Must be String

serializer
Optional Blank Value Allowed

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 ValueDescription
    contact_fieldContact Field
    contact_field_formContact Field Form
offer_id
Optional

Assign the record to this Offer.

ids
Optional

Return records matching these ids.

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

page
Optional

Return the next page of results.

  • Must be a number.

per_page
Optional

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

  • Must be a number.

created_at_to
Optional

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

  • Must be String

created_at_from
Optional

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

  • Must be String

fulltext
Optional

Search for any record that matches this text

  • Must be String

time_zone
Optional

Date ranges will be parsed using this time zone.

columns
Optional
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
  • offer_id
  • sortable_order
  • key
  • required
  • required_on_create
  • 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
  • Must be String

root
Optional

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