List billing groups

This call lists all your billing groups, including groups that are pending or have been disabled.

Request

https://api.sbgenomics.com/v2/billing/groups
https://eu-api.sbgenomics.com/v2/billing/groups

Example request

GET /v2/billing/groups HTTP/1.1
Host: api.sbgenomics.com
X-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74
curl  -s -H "X-SBG-Auth-Token: 6282d5e2121d43e7900e9d52b15845e7" -H "content-type: application/json" GET "https://api.sbgenomics.com/v2/billing/groups"
from sevenbridges import Api

api = Api(url='https://api.sbgenomics.com/v2',
          token='3259c50e1ac5426ea8f1273259740f74')

# send GET request to SB API
billing_groups = api.billing_groups.query()

for billing_group in billing_groups:
    print(billing_group.name)

Header Fields

Name

Description

X-SBG-Auth-Token
required

Your Seven Bridges Platform authentication token.

Query parameters

Name

Data type

Description

fields

string

Selector specifying a subset of fields to include in the response.

limit

integer

The maximum number of collection items to return for a single request. Minimum value is 1. The maximum value is 100 and the default value is 25. This is a pagination-specific attribute.

offset

integer

The zero-based starting index in the entire collection of the first item to return. The default value is 0. This is a pagination-specific attribute.

Response

See a list of Seven Bridges Platform-specific response codes that may be contained in the body of the response.

Example response body

{
  "href": "https://api.sbgenomics.com/v2/billing/groups?offset=0&limit=25",
  "items": [
    {
      "id": "eb5fdee2-36c3-41d1-b179-d9f5d0a0f6f7",
      "href": "https://api.sbgenomics.com/v2/billing/groups/eb5fdee2-36c3-41d1-b179-d9f5d0a0f6f7",
      "name": "RFranklin Billing Group"
    }
  ],
  "links": []
}