List App Connections

Returns a collection of app connections

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

company_id

string

An ID of a company to filter by, which will look like biz_*************

resource_id

string

An ID of an object to filter by, which will look like prod_*************

resource_type

enum<string>

The type of resource to filter by, ex 'product'.

Available options:

product

page

integer

default:

1

The page number to retrieve

per

integer

default:

10

The number of resources to return per page. There is a limit of 50 results per page.

Response

200 - application/json

data

object[]

required

Show child attributes

data.app_id

string

required

The ID of the app, which will look like app_*************

data.company_id

string

required

The ID of the company, which will look like biz_*************

data.created_at

number

required

The date the billing usage was created as a unix timestamp.

data.id

string

required

The ID of the app connection, which will look like apco_*************

data.resource_id

string

required

The ID of the polymorphic resource for the connection. Ex. a product ID like prod_*************.

data.resource_type

enum<string>

required

The type of the polymorphic resource for the connection. Ex. 'product'

Available options:

product

data.view_type

enum<string>

required

The type of view for the connection.

Available options:

customer_before_checkout_view

pagination

object

required

Show child attributes

pagination.current_page

number

required

Current page number

pagination.next_page

number

required

Next page number

pagination.prev_page

number

required

Previous page number

pagination.total_count

number

required

Total number of records

pagination.total_pages

number

required

Total number of pages