Oauth Connection API resource for managing Oauth Connection.

GET /api/v1/oauth_connections
List Oauth Connection records.

Params

Param name
Description
Validations
ids
Optional

Return records matching these ids.

Validations:

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

Return the next page of results.

Validations:

  • Must be a number.
per_page
Optional

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

Validations:

  • Must be a number.
created_at_to
Optional

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

Validations:

  • Must be a String
created_at_from
Optional

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

Validations:

  • Must be a String
fulltext
Optional

Search for any record that matches this text

Validations:

  • Must be a String
time_zone
Optional

Date ranges will be parsed using this time zone.

Validations:
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
  • name
  • key
  • predefined_type
  • description
  • client_id
  • webhook_remote_url
  • webhook_remote_method
  • webhook_remote_body
  • webhook_remote_headers
  • webhook_read_timeout
  • webhook_response_success_codes
  • access_token_path
  • expires_in
  • expires_at
  • fetched_at

Validations:

  • Must be a 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: {}}

Validations:

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

GET /api/v1/oauth_connections/new
Build Oauth Connection with defaults.

Params

Param name
Description
Validations
name
Optional Blank Value Allowed

Name

Validations:

  • Must be a String
description
Optional Blank Value Allowed

Description

Validations:

  • Must be a String
client_id
Optional Blank Value Allowed

Client

Validations:

  • Must be a String
client_secret
Optional Blank Value Allowed

Client Secret

Validations:

  • Must be a String
webhook_remote_url
Optional Blank Value Allowed

Webhook Remote Url

Validations:

  • Must be a String
webhook_remote_method
Optional Blank Value Allowed

Webhook Remote Method

Validations:

  • Must be a String
webhook_remote_body
Optional Blank Value Allowed

Webhook Remote Body

Validations:

  • Must be a String
webhook_remote_headers
Optional Blank Value Allowed

Webhook Remote Headers

Validations:

  • Must be a String
webhook_read_timeout
Optional Blank Value Allowed

Webhook Read Timeout

Validations:

  • Must be a decimal number.
webhook_response_success_codes
Optional Blank Value Allowed

Webhook Response Success Codes

Validations:

  • Must be a String
access_token_path
Optional Blank Value Allowed

Access Token Path

Validations:

  • Must be a String
access_token
Optional Blank Value Allowed

Access Token

Validations:

  • Must be a String
expires_in
Optional Blank Value Allowed

Expires In

Validations:

  • Must be a decimal number.
expires_at
Optional Blank Value Allowed

Expires At

Validations:

  • Must be a valid time: 2025-07-11 07:02:51 +0000
fetched_at
Optional Blank Value Allowed

Fetched At

Validations:

  • Must be a valid time: 2025-07-11 07:02:51 +0000
updated_at
Optional Blank Value Allowed

Updated At

Validations:

  • Must be a valid time: 2025-07-11 07:02:51 +0000
created_at
Optional Blank Value Allowed

Created At

Validations:

  • Must be a valid time: 2025-07-11 07:02:51 +0000

POST /api/v1/oauth_connections
Create Oauth Connection.

Params

Param name
Description
Validations
name
Optional Blank Value Allowed

Name

Validations:

  • Must be a String
description
Optional Blank Value Allowed

Description

Validations:

  • Must be a String
client_id
Optional Blank Value Allowed

Client

Validations:

  • Must be a String
client_secret
Optional Blank Value Allowed

Client Secret

Validations:

  • Must be a String
webhook_remote_url
Optional Blank Value Allowed

Webhook Remote Url

Validations:

  • Must be a String
webhook_remote_method
Optional Blank Value Allowed

Webhook Remote Method

Validations:

  • Must be a String
webhook_remote_body
Optional Blank Value Allowed

Webhook Remote Body

Validations:

  • Must be a String
webhook_remote_headers
Optional Blank Value Allowed

Webhook Remote Headers

Validations:

  • Must be a String
webhook_read_timeout
Optional Blank Value Allowed

Webhook Read Timeout

Validations:

  • Must be a decimal number.
webhook_response_success_codes
Optional Blank Value Allowed

Webhook Response Success Codes

Validations:

  • Must be a String
access_token_path
Optional Blank Value Allowed

Access Token Path

Validations:

  • Must be a String
access_token
Optional Blank Value Allowed

Access Token

Validations:

  • Must be a String
expires_in
Optional Blank Value Allowed

Expires In

Validations:

  • Must be a decimal number.
expires_at
Optional Blank Value Allowed

Expires At

Validations:

  • Must be a valid time: 2025-07-11 07:02:51 +0000
fetched_at
Optional Blank Value Allowed

Fetched At

Validations:

  • Must be a valid time: 2025-07-11 07:02:51 +0000
updated_at
Optional Blank Value Allowed

Updated At

Validations:

  • Must be a valid time: 2025-07-11 07:02:51 +0000
created_at
Optional Blank Value Allowed

Created At

Validations:

  • Must be a valid time: 2025-07-11 07:02:51 +0000

GET /api/v1/oauth_connections/:id
Get Oauth Connection by id.

PUT /api/v1/oauth_connections/:id
Update Oauth Connection by id.

Params

Param name
Description
Validations
name
Optional Blank Value Allowed

Name

Validations:

  • Must be a String
description
Optional Blank Value Allowed

Description

Validations:

  • Must be a String
client_id
Optional Blank Value Allowed

Client

Validations:

  • Must be a String
client_secret
Optional Blank Value Allowed

Client Secret

Validations:

  • Must be a String
webhook_remote_url
Optional Blank Value Allowed

Webhook Remote Url

Validations:

  • Must be a String
webhook_remote_method
Optional Blank Value Allowed

Webhook Remote Method

Validations:

  • Must be a String
webhook_remote_body
Optional Blank Value Allowed

Webhook Remote Body

Validations:

  • Must be a String
webhook_remote_headers
Optional Blank Value Allowed

Webhook Remote Headers

Validations:

  • Must be a String
webhook_read_timeout
Optional Blank Value Allowed

Webhook Read Timeout

Validations:

  • Must be a decimal number.
webhook_response_success_codes
Optional Blank Value Allowed

Webhook Response Success Codes

Validations:

  • Must be a String
access_token_path
Optional Blank Value Allowed

Access Token Path

Validations:

  • Must be a String
access_token
Optional Blank Value Allowed

Access Token

Validations:

  • Must be a String
expires_in
Optional Blank Value Allowed

Expires In

Validations:

  • Must be a decimal number.
expires_at
Optional Blank Value Allowed

Expires At

Validations:

  • Must be a valid time: 2025-07-11 07:02:51 +0000
fetched_at
Optional Blank Value Allowed

Fetched At

Validations:

  • Must be a valid time: 2025-07-11 07:02:51 +0000
updated_at
Optional Blank Value Allowed

Updated At

Validations:

  • Must be a valid time: 2025-07-11 07:02:51 +0000
created_at
Optional Blank Value Allowed

Created At

Validations:

  • Must be a valid time: 2025-07-11 07:02:51 +0000

DELETE /api/v1/oauth_connections/:id
Destroy Oauth Connection by id.