| Requires any of the roles: | Admin, TenantAdmin, MarketplaceAdmin |
| GET | /providers | Gets a list of all supported providers by provider type. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ProviderType | query | ProviderType | Yes | Provider type (payment, invoicing etc.)Allowable Values
|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Version | form | integer | No | Api version |
| Name | Value |
|---|---|
| Payment | 1 |
| Invoicing | 2 |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Data | form | List<ProviderView> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | Guid | No | |
| OrganizationId | form | Guid | No | |
| Name | form | string | No | |
| Description | form | string | No | |
| Type | form | ProviderType | No | |
| Configuration | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /providers HTTP/1.1 Host: api.4spaces.io Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"data":[{"id":"00000000000000000000000000000000","organizationId":"00000000000000000000000000000000","name":"String","description":"String","type":1,"configuration":"String"}],"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}