GET /api/v1/integrations
List Integration records.

Params

Param name
Description
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
  • external_record_id
  • integration_type
  • name
  • public_key
  • category
  • connected_status
  • connected_at
  • disconnected_at
  • is_oauth2
  • zoho_update_td_login_token
  • cache_expires_in
  • 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


PUT /api/v1/integrations/objects/:id
Update the status of an Integration Object.

Supported Formats

json

Params

Param name
Description
active
Optional

Enable or disable an integration object.

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


GET /api/v1/integrations/new
Build Integration with defaults.

Params

Param name
Description
integration_type
Optional

Integration Type

  • Must be one of: google_adwords, typeform, mailchimp, pagerduty, zoho_crm, tcpa_shield, mailgun, salesforce, slack, facebook_leadads, blacklist_alliance, sendgrid, zadarma, infusionsoft.


POST /api/v1/integrations
Create Integration.

Params

Param name
Description
integration_type
Optional

Integration Type

  • Must be one of: google_adwords, typeform, mailchimp, pagerduty, zoho_crm, tcpa_shield, mailgun, salesforce, slack, facebook_leadads, blacklist_alliance, sendgrid, zadarma, infusionsoft.


GET /api/v1/integrations/:id
Get Integration by id.


PUT /api/v1/integrations/:id
Update Integration by id.

Params

Param name
Description
integration_type
Optional

Integration Type

  • Must be one of: google_adwords, typeform, mailchimp, pagerduty, zoho_crm, tcpa_shield, mailgun, salesforce, slack, facebook_leadads, blacklist_alliance, sendgrid, zadarma, infusionsoft.


DELETE /api/v1/integrations/:id
Destroy Integration by id.