Skip to main content
GET
/
connection-definitions
List connection definitions
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.{id}.gr4vy.app/connection-definitions"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
{
  "items": [
    {
      "id": "stripe-card",
      "type": "connection-definition",
      "name": "Stripe",
      "count": 1,
      "group": "payment-service",
      "category": "card",
      "icon_url": "https://cdn.gr4vy.app/stripe.svg",
      "provider": "Stripe"
    }
  ]
}
This API is different from the list payment service definitions endpoint because it returns definitions for all service types including anti-fraud and gift card services. This endpoint requires the connections.read scope.

Authorizations

​
Authorization
string
header
required

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

Response

Returns a list of connection definitions.

A list of available connection definitions.

​
items
Connection Definition · object[]