API Get Info

Get Info

Returns lookup data needed by other API calls: categories, subcategories, judging sessions, awards, paperwork file types, rounds, project custom questions, and entry types. Call this first when integrating.

Authentication

All data API calls are POST (unless noted) with JSON body:

Field	Required	Description
ApiKey	Yes*	Private API key for your site. Prefer this over username/password.
Username / Password	Yes*	Alternate auth if not using ApiKey.
FairId	Yes	Fair GUID from the site URL (f query parameter).
Body	Depends	Request payload. Use {} when no body fields are needed.

• Provide either ApiKey or Username+Password.

Calls must be run server-side — do not expose your API key in a browser.

Response envelope

Most endpoints return:

{
  Success: true,
  Message: null,   // error text when Success is false
  Body: { ... }    // endpoint-specific payload
}

Request

fetch('/api/data/info', {
    method:'POST',
    headers:{'Content-Type': 'application/json'},
    body: JSON.stringify({
            ApiKey:'<Private key>',
            FairId: '9df61f13-474b-442f-ac1f-edca7348ef71', // value of f in your URL
            Body: {}
        })
})
.then(response => response.json())
.then(data=>{console.log('Success: ',data);})
.catch((error)=>{console.log('Error: ', error);});

Response

On success Body looks like:

{
  Success: true,
  Message: null,
  Body: {
    Categories: [{ Id: 123, Name: "Biology", Abbreviation: "BIO" }],
    SubCategories: [{ Id: 456, Name: "Microbiology", Abbreviation: "MB" }],
    JudgingSessions: [{
      Id: 1,
      Name: "Morning Session",
      MinGrade: 6,
      MaxGrade: 12,
      StartTime: "...",
      EndTime: "..."
    }],
    SpecialAwards: [{ Id: 10, Name: "Best in Fair" }],
    CategoryAward: [{ Id: 3, Name: "1st Place" }],
    PaperworkFileTypes: [{ Id: 7, Name: "Form 1C" }],
    Rounds: [{ Id: 2, Name: "Round One" }],
    ProjectCustomQuestions: [{
      Id: 55,
      Name: "How large is your display?",
      Values: ["small", "large"]  // only when the question has preset values
    }],
    EntryTypes: [{
      Id: 1,
      PublicId: "9df61f13-474b-442f-ac1f-edca7348ef71",
      Name: "Research Entry"
    }]
  }
}

Field notes

• Use category / subcategory / entry type / award / round / paperwork type ids from this response in other API calls.
• ProjectCustomQuestions.Values is only populated when the question has a fixed list of options.
• PaperworkFileTypes ids are used when uploading paperwork via API Upload Project Assets.

Related APIs

• API Get Projects / API Add Project / API Update Project
• API Upload Project Assets
• API Add Category / API Add Round
• API Judging Scores / API Set Judging Assignments