CompSuite API
v4
  • v4
  • v3
  • v2
  1. Groups
CompSuite API
v4
  • v4
  • v3
  • v2
  • API Usage Guidelines
  • Authentication
  • Errors
  • Divisions
    • List all divisions
      GET
  • Groups
    • List all groups
      GET
    • Retrieve a group
      GET
    • Create a Group
      POST
    • Update a group
      POST
  • Seasons
    • List all seasons
      GET
  • Events
    • List all events
      GET
    • Retrieve an event
      GET
    • Create an event
      POST
    • Create a Competition
      POST
  • Performances
    • Add a performance
      POST
    • Delete a performance
      DELETE
  • Schedule
    • Retrieve Schedule for Competition
      GET
  • Scores
    • Retrieve Competition Scores
      GET
  1. Groups

Retrieve a group

GET
/groups/{groupId}
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.competitionsuite.com/groups/'
Response Response Example
200 - Result
{
  id: 1234,
  name: "My group name",
  location: "New York, NY",
  active: true,
  pending: false,
  circuitId: "ZB-12834",
  division: {
    id: 456,
    name: "Class AA"
  },
  groupType: {
    id: 1,
    name: "Percussion"
  },
  members: [
    {
      id: 5845,
      email: "test@gmail.com",
      role: {
        id: 1,
        name: "Administrator"
      },
      pending: false
    }
  ],
  data: [
    {
      _id: "a89adaljasdfa",
      name: "Section Name",
      fields: [
        {
          _id: "asdfa809asadff",
          name: "Show Title",
          type: "string",
          value: "My show title"
        }
      ]
    }
  ]
}

Request

Authorization
OAuth 2.0
or
Path Params

Responses

🟢200OK
application/json
200
Body

🟠400Bad Request
Modified at 2025-07-28 18:56:56
Previous
List all groups
Next
Create a Group
Built with