List question sets

​

List this org's question sets (the rubrics audits are scored against), newest first, with cursor pagination. Each set embeds its non-deleted questions in set order. Filter by type, production flag, and deleted state; batch-get by repeating id=. Add include_total=true for an exact count of all matching question sets. Read-only resource. Eventually consistent: may lag a create/update by a few seconds — see the API overview.

OAuth scopes
  • question_sets:read

Query Parameters

  • limit
    Type: integer
    min:  
    1
    max:  
    100

    Integer numbers.

  • starting_after
    Type: stringFormat: uuid
  • ending_before
    Type: stringFormat: uuid
  • include_total
    Type: string

    When true, include an exact total_count of all rows matching the filters (independent of pagination). Adds a count query.

  • id
  • type
    Type: string
  • is_production
    Type: string
  • is_deleted
    Type: string

Responses

  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for get/v2/question_sets
curl 'https://api.brellium.dev/v2/question_sets?limit=20&is_deleted=false' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "object": "list",
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "object": "question_set",
      "org_id": "string",
      "set_name": "string",
      "set_code": "string",
      "type": null,
      "is_production": true,
      "is_deleted": true,
      "allow_doc_upload": true,
      "thresholds": [],
      "questions": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "object": "question",
          "query": "string",
          "question_type": null,
          "severity": null,
          "remediation": null
        }
      ],
      "created_at": "string",
      "updated_at": "string"
    }
  ],
  "has_more": true,
  "total_count": 342
}

A list of question sets

Previous
Question sets
Next
Get a question set
Brellium API