BIbigchange
WorksheetGroups

Get a worksheet group

Retrieve the details of a single worksheet group (required scope worksheets:read)

get/v1/worksheetGroups/{worksheetGroupId}

Request

  • Base URL
    https://api.bigchange.com
  • URL
    https://api.bigchange.com/v1/worksheetGroups/{worksheetGroupId}
  • Auth
    HTTP bearer

Path parameters

worksheetGroupIdinteger required

The unique identifier of the worksheet group

Headers

Customer-Idinteger required

The customer identifier

Response

OK

idinteger

The unique identifier of the worksheet group

namestring

The name of the worksheet group

createdAtstring date-time

The UTC timestamp of when this worksheet group was created

Example response

{
  "id": 12345,
  "name": "Example Worksheet Group",
  "createdAt": "2022-11-29T16:50:16.0000000+00:00"
}

Changes

No recorded changes to this operation across all 13 revisions of this API.