List billing groups

/billing/groups

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

Path

https://api.sb.biodatacatalyst.nhlbi.nih.gov/v2/billing/groups

Request

Example request

HTTP

GET /v2/billing/groups HTTP/1.1
Host: api.sb.biodatacatalyst.nhlbi.nih.gov
X-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74

cURL

curl  -s -H "X-SBG-Auth-Token: 6282d5e2121d43e7900e9d52b15845e7" -H "content-type: application/json" GET "http://api.sb.biodatacatalyst.nhlbi.nih.gov/v2/billing/groups"

Header Fields

Name	Description
X-SBG-Auth-Token required	Your 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 specific response codes that may be contained in the body of the response.

Example response body

JSON

{
  "href": "https://api.sb.biodatacatalyst.nhlbi.nih.gov/v2/billing/groups?offset=0&limit=25",
  "items": [
    {
      "id": "ec1dc1e3-12a3-4b56-789c-e3f2dca0c6f7",
      "href": "https://api.sb.biodatacatalyst.nhlbi.nih.gov/v2/billing/groups/ec1dc1e3-12a3-4b56-789c-e3f2dca0c6f7",
      "name": "My billing group (RFranklin)"
    }
  ],
  "links": []
}