POST
/
connections
/
search
List connections by filter
curl --request POST \
  --url https://api.cloud.flexprice.io/v1/connections/search \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "connection_ids": [
    "<string>"
  ],
  "end_time": "<string>",
  "expand": "<string>",
  "filters": [
    {
      "data_type": "string",
      "field": "<string>",
      "operator": "eq",
      "value": {
        "array": [
          "<string>"
        ],
        "boolean": true,
        "date": "<string>",
        "number": 123,
        "string": "<string>"
      }
    }
  ],
  "limit": 500,
  "offset": 1,
  "order": "asc",
  "provider_type": "flexprice",
  "sort": [
    {
      "direction": "asc",
      "field": "<string>"
    }
  ],
  "start_time": "<string>",
  "status": "published"
}'
{
  "connections": [
    {
      "created_at": "<string>",
      "created_by": "<string>",
      "environment_id": "<string>",
      "id": "<string>",
      "name": "<string>",
      "provider_type": "flexprice",
      "status": "published",
      "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>*

Body

application/json

Filter

connection_ids
string[]
end_time
string
expand
string
filters
object[]
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,
razorpay
sort
object[]
start_time
string
status
enum<string>
Available options:
published,
deleted,
archived

Response

OK

connections
object[]
limit
integer
offset
integer
total
integer