Skip to main content
GET
/
connections
Get connections
curl --request GET \
  --url https://api.cloud.flexprice.io/v1/connections \
  --header 'x-api-key: <api-key>'
{
  "connections": [
    {
      "created_at": "<string>",
      "created_by": "<string>",
      "environment_id": "<string>",
      "id": "<string>",
      "metadata": {},
      "name": "<string>",
      "provider_type": "flexprice",
      "status": "published",
      "sync_config": {
        "deal": {
          "inbound": true,
          "outbound": true
        },
        "invoice": {
          "inbound": true,
          "outbound": true
        },
        "payment": {
          "inbound": true,
          "outbound": true
        },
        "plan": {
          "inbound": true,
          "outbound": true
        },
        "quote": {
          "inbound": true,
          "outbound": true
        },
        "subscription": {
          "inbound": true,
          "outbound": true
        }
      },
      "tenant_id": "<string>",
      "updated_at": "<string>",
      "updated_by": "<string>"
    }
  ],
  "limit": 123,
  "offset": 123,
  "total": 123
}

Authorizations

​
x-api-key
string
header
required

Enter your API key in the format x-api-key <api-key>*

Query Parameters

​
connection_ids
string[]
​
end_time
string
​
expand
string
​
limit
integer
Required range: 1 <= x <= 1000
​
offset
integer
Required range: x >= 0
​
order
enum<string>
Available options:
asc,
desc
​
provider_type
enum<string>
Available options:
flexprice,
stripe,
s3,
hubspot,
razorpay,
chargebee,
quickbooks
​
start_time
string
​
status
enum<string>
Available options:
published,
deleted,
archived

Response

OK

​
connections
object[]
​
limit
integer
​
offset
integer
​
total
integer