List billing groups

/billing/groups

For general information on the API, including formatting, parameters, and pagination, please see the API Overview.

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

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

Request

Example request

GET /v2/billing/groups HTTP/1.1
Host: cavatica-api.sbgenomics.com
X-SBG-Auth-Token: 3210a98c1db9318fa9d9273156740f74
curl  -s -H "X-SBG-Auth-Token: 3210a98c1db9318fa9d9273156740f74" -H "content-type: application/json" GET "https://cavatica-api.sbgenomics.com/v2/billing/groups"

Header Fields

Name

Description

X-SBG-Auth-Token
required

Your Cavatica 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 CAVATICA-specific response codes that may be contained in the body of the response.

Example response body

{
  "href": "https://cavatica-api.sbgenomics.com/v2/billing/groups?offset=0&limit=25",
  "items": [
    {
      "id": "ec1dc1e3-12a3-4b56-789c-e3f2dca0c6f7",
      "href": "https://cavatica-api.sbgenomics.com/v2/billing/groups/ec1dc1e3-12a3-4b56-789c-e3f2dca0c6f7",
      "name": "Pilot Funds (RFranklin)"
    }
  ],
  "links": []
}

Language
Click Try It! to start a request and see the response here!