GET format-group

A lookup call to get all available format groups, including their ID and description. The call will allow a single ID to be given in order to limit results to the specific format group.

When accessed via a GET request this API method will return a list of all available format groups.

INPUT

As this method is accessed via a GET request there is no HTTP body so options can be specified via the URL.

parameter type description
id int (optional) a format group id to restrict results to

OUTPUT - JSON sample

If accessing GET /api/format-group?id=1 the following JSON would be returned:

{
    "data": [{
        "id": 1,
        "description": "6 Sheets"
    }]
}
        

A "data" element that contains an array of format groups