List Providers
List all supported integrations with their resources, operations, and argument schemas.
Request
GET /v1/providersHeaders
| Header | Value |
|---|---|
Authorization | Bearer YOUR_API_KEY |
Response
200 OK
{
"providers": [
{
"id": "tmobile",
"name": "T-Mobile",
"resources": [
{
"name": "paymentMethod",
"operations": {
"read": {
"description": "List saved payment methods on the account",
"arguments": null,
"result": { ... }
},
"write": {
"description": "Add a new payment method to the account",
"arguments": {
"type": "object",
"properties": {
"cardNumber": { "type": "string" },
"expirationDate": { "type": "string" },
"cvv": { "type": "string" },
"nameOnCard": { "type": "string" },
"billingZip": { "type": "string" },
"dryRun": { "type": "boolean" }
},
"required": ["cardNumber", "expirationDate", "cvv", "nameOnCard", "billingZip"]
},
"result": { ... }
}
}
},
{
"name": "mobileBillingStatement",
"operations": {
"read": {
"description": "Retrieve billing statement history",
"arguments": { ... },
"result": { ... }
}
}
}
]
}
]
}Response structure
Each provider entry contains:
| Field | Type | Description |
|---|---|---|
id | string | Integration identifier (used in POST /v1/links) |
name | string | Human-readable name |
resources | array | Available resources |
resources[].name | string | Resource identifier (used in POST /v1/links) |
resources[].operations | object | Map of action name to operation definition |
resources[].operations[action].description | string | What this operation does |
resources[].operations[action].arguments | object | null | JSON Schema for the operation’s arguments, or null if no arguments are needed |
resources[].operations[action].result | object | null | JSON Schema describing the canonical result shape for this operation, or null if unspecified |
Notes
- Use this endpoint to discover valid
integrationId+resource+actioncombinations forPOST /v1/links - The
argumentsfield is a JSON Schema that describes what data can be passed when creating a link - The
resultfield is a JSON Schema describing the shape of theresultobject returned in webhooks andGET /v1/links/:idwhen the operation completes successfully - Operations with
arguments: nullrequire no arguments
Last updated on