Join the Student Life

Join the Student Life Reports API

Async report jobs: 202 Accepted, then poll.

Documentation GitHub OpenAPI

Operations 2

POST /api/v1/reports Start a report job (async: 202 Accepted, then poll) #

GET /api/v1/reports/{id} Poll a report job #

Specifications

⚙

OpenAPI

https://artifacts.apis.io/jointhestudentlife-com/openapi/jointhestudentlife-com-reports-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/jointhestudentlife-com:jointhestudentlife-com-reports-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Student Life Reports API
  version: 1.0.0
  summary: Student cities, events, ticket prices and partner deals.
  description: 'Open, keyless JSON API of The Student Life (jointhestudentlife.com): the cities where we run student communities, their guides, upcoming events with ticket prices and status, partner deals and pricing. Read endpoints need no authentication. Data refreshes whenever the website does. For AI agents, the same data is available as an MCP server at https://jointhestudentlife.com/mcp. Versioning and deprecation policy: the version is in the path (/api/v1); inside v1 we aim to only add things; a breaking change ships as /api/v2 and is announced on https://jointhestudentlife.com/developers#versioning before the old version changes, with Deprecation (RFC 9745) and, once a date is set, Sunset (RFC 8594) headers on affected endpoints. Rate limits are best effort per client, reported in RateLimit and X-RateLimit headers. Pagination is cursor based. Sandbox: POST /api/contact accepts dry_run to validate without sending.'
  contact:
    name: The Student Life
    email: support@jointhestudentlife.com
    url: https://jointhestudentlife.com/developers
  x-deprecation-policy: https://jointhestudentlife.com/developers#versioning
servers:
- url: https://jointhestudentlife.com
security: []
tags:
- name: Reports
  description: 'Async report jobs: 202 Accepted, then poll.'
paths:
  /api/v1/reports:
    post:
      operationId: createReport
      summary: 'Start a report job (async: 202 Accepted, then poll)'
      tags:
      - Reports
      description: 'Report jobs follow the async job pattern: this answers 202 Accepted with a job id and a Location header; poll GET /api/v1/reports/{id} until status is succeeded. No side effects and nothing is stored. An unknown city in the body is a 400.'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReportRequest'
            example:
              type: city_comparison
              cities:
              - berlin
              - lisbon
      responses:
        '202':
          description: Accepted. Poll the Location.
          headers:
            Location:
              description: URL to poll for the job status and result.
              schema:
                type: string
                format: uri
            Retry-After:
              description: Seconds to wait before the first poll.
              schema:
                type: integer
            RateLimit:
              $ref: '#/components/headers/RateLimit'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimit-Policy'
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/X-RateLimit-Reset'
            API-Version:
              $ref: '#/components/headers/API-Version'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportJob'
        '400':
          $ref: '#/components/responses/Error'
        '413':
          $ref: '#/components/responses/Error'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        default:
          $ref: '#/components/responses/Error'
  /api/v1/reports/{id}:
    get:
      operationId: getReport
      summary: Poll a report job
      tags:
      - Reports
      parameters:
      - name: id
        in: path
        required: true
        description: Job id from createReport.
        schema:
          type: string
          pattern: ^rpt_[A-Za-z0-9_-]{10,600}$
      responses:
        '200':
          description: Job status, with the result once succeeded.
          headers:
            RateLimit:
              $ref: '#/components/headers/RateLimit'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimit-Policy'
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/X-RateLimit-Reset'
            API-Version:
              $ref: '#/components/headers/API-Version'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportJob'
        '404':
          $ref: '#/components/responses/Error'
        '410':
          $ref: '#/components/responses/Error'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        default:
          $ref: '#/components/responses/Error'
components:
  headers:
    RateLimit:
      description: 'Current window: limit, remaining and seconds until reset (draft-ietf-httpapi-ratelimit-headers).'
      schema:
        type: string
      example: limit=120, remaining=119, reset=60
    X-RateLimit-Limit:
      schema:
        type: integer
    X-RateLimit-Remaining:
      schema:
        type: integer
    X-RateLimit-Reset:
      description: Unix time when the window resets.
      schema:
        type: integer
    RateLimit-Policy:
      description: Quota policy.
      schema:
        type: string
      example: 120;w=60
    API-Version:
      description: Major version that served the response.
      schema:
        type: string
      example: '1'
    Retry-After:
      description: Seconds to wait after a 429.
      schema:
        type: integer
  schemas:
    ReportJob:
      type: object
      required:
      - id
      - type
      - status
      - status_url
      properties:
        id:
          type: string
          description: 'Job id. Opaque: pass it back unchanged.'
        type:
          type: string
          enum:
          - city_comparison
          - events_overview
        status:
          type: string
          enum:
          - pending
          - succeeded
          description: pending right after POST; succeeded when polled. The report is built from the data at the moment you poll.
        created_at:
          type: string
          format: date-time
        expires_at:
          type: string
          format: date-time
          description: 24 hours after creation. Polling after that gets 410.
        completed_at:
          type: string
          format: date-time
        status_url:
          type: string
          format: uri
          description: Where to poll. Same as the Location header.
        poll_after_seconds:
          type: integer
        data_updated:
          type: string
        result:
          type: object
          description: 'Present when status is succeeded. city_comparison: {cities: [...]}. events_overview: {total, by_type, by_ticket_status, events: [...]}.'
        note:
          type: string
    ReportRequest:
      type: object
      required:
      - type
      properties:
        type:
          type: string
          enum:
          - city_comparison
          - events_overview
          description: 'city_comparison: monthly costs, everyday prices and upcoming events with the cheapest ticket, side by side (2 to 10 cities). events_overview: every upcoming event with ticket status and the cheapest ticket, counted by type and status.'
        cities:
          type: array
          maxItems: 10
          items:
            type: string
          description: City slugs or names. Required (2 to 10) for city_comparison; optional filter for events_overview.
          example:
          - berlin
          - lisbon
        event_type:
          type: string
          enum:
          - all
          - halloween
          - welcome_festival
          - semester_kickoff
          - orientation_week
          description: events_overview only.
    Error:
      type: object
      required:
      - error
      properties:
        error:
          type: object
          required:
          - code
          - message
          properties:
            code:
              type: string
              enum:
              - bad_request
              - not_found
              - method_not_allowed
              - internal_error
              - rate_limited
              - expired
              - too_large
            message:
              type: string
            status:
              type: integer
            docs:
              type: string
              format: uri
  responses:
    TooManyRequests:
      description: Rate limited
      headers:
        Retry-After:
          $ref: '#/components/headers/Retry-After'
        RateLimit:
          $ref: '#/components/headers/RateLimit'
        RateLimit-Policy:
          $ref: '#/components/headers/RateLimit-Policy'
        X-RateLimit-Limit:
          $ref: '#/components/headers/X-RateLimit-Limit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/X-RateLimit-Remaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/X-RateLimit-Reset'
        API-Version:
          $ref: '#/components/headers/API-Version'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Error:
      description: Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
externalDocs:
  description: For AI agents and developers
  url: https://jointhestudentlife.com/developers