API calls

  1. GET/apiPrints HTML documentation of the API.

    All data used by UX Forum are available via open and free API. This documentation explains logic and nuances of using the API.

    In case of any questions or requests contact us via Facebook.

Meetups

  1. GET/api/meetupsLists all meetups.

    Lists all meetups in JSON format – array with objects representing meetups. By default the JSON uses custom UX Forum template, this can be changed by using query parameters.

    Successful request returns status code 200.

    You can use query string parameters for aditional customization. First parameter must be preceeded by ? symbol, all others by & symbol.

    Some parameters can have only one value while others can have multiple values. Both OR and AND logic are available for parameters supporting multiple values. OR logic is implemented by separating the values with comma while AND logic is implemented by repeating the parameter with different values.

    Request with invalid or unknown query string parameter returns status code 400.


    Filters

    Filters enable you to remove all unwanted meetups based on multiple given criteria. Supporting multiple values, filters implement both OR and AND logic. You can use following filter parameters and their respective values:

    • year
      • 2018
      • 2019
      • 2020
    • difficulty
      • 0
      • 1
      • 2
      • 3
    • status
      • draft
      • upcoming
      • ongoing
      • finished
    • language
      • sk
      • cz
      • en
    • country
      • sk
      • hu
    • city
      • bratislava
      • budapest
    • venue
      • sygic
      • prezi
    • url
      • register
      • photos
      • feedback
      • facebook
      • slido
      • livestream
    • id
      13 possible values
      • 2018-02-20
      • 2018-04-17
      • 2018-06-19
      • 2018-09-11
      • 2018-10-23
      • 2018-11-20
      • 2018-12-20
      • 2019-03-05
      • 2019-06-14
      • 2019-06-18
      • 2019-10-08
      • 2019-12-03
      • 2020-02-04

    Combining multipe values separated by comma into one parameter implements OR logic. Repeating the same parameter with different values implements AND logic.


    Search

    You can filter meetups by searching for a specific keyword or phrase using parameter search. Search supports multiple values, therefore you can use both OR and AND logic. Search is case insensitive.

    Combining multipe values separated by comma into one parameter implements OR logic. Repeating the same parameter with different values implements AND logic.


    Sort

    By default, the listed meetups are sorted by date. You can change the order of meetups by using a different property:

    • date
    • title
    • difficulty
    • status
    • language
    • country
    • city
    • venue

    Sorting requires prepending either + for ascending order or - for descending order before the property (default is -date).

    Sorting by multiple properties is not allowed and will result in an error.


    Pagination

    It is possible to limit the listed meetups to certain number starting from a specific position. This helps reduce the size of response in case only specific amount of meetups is required. Possible parameters are:

    limit
    limits the amount of listed meetups (default is 0 – do not limit).
    offset
    offsets (skips) the listed meetups from either the beginning or the end (default is 0)

    Order of the parameters does not change the output.

    Using negative offset lists given amount of meetups from the end.

    Using negative offset can yield similar results to using combination of sort and limit parameters – difference being in the order of results.

    Limit and offset parameters do not support multiple values.


    Format

    Configuring the format of returned meetups alters the size of response and used vocabularies. Possible parameters are:

    pretty
    beautifies the JSON response by given amount of spaces increasing its size (default is 0)
    vocabulary
    lists meetups in specified sets of vocabularies (default is uxforum):
    uxforum
    returns meetup information in our custom JSON structure
    schema
    returns meetup information in standard JSON-LD schema
  2. GET/api/meetups/newestFinds the newest meetup.

    Returns only the newest meetup in JSON format. Newest meetup can be upcoming, ongoing or already finished one.

    This request is a shorthand for www.dev.uxforum.sk/api/meetups?sort=-date&limit:1 and www.dev.uxforum.sk/api/meetups?offset=-1.

    Successful request returns status code 200.

    You can use query string parameters for aditional customization. First parameter must be preceeded by ? symbol, all others by & symbol.

    Request with invalid or unknown query string parameter returns status code 400.


    Format

    Configuring the format of returned meetups alters the size of response and used vocabularies. Possible parameters are:

    pretty
    beautifies the JSON response by given amount of spaces increasing its size (default is 0)
    vocabulary
    lists meetups in specified sets of vocabularies (default is uxforum):
    uxforum
    returns meetup information in our custom JSON structure
    schema
    returns meetup information in standard JSON-LD schema
  3. GET/api/meetups/{id}Finds meetup by ID.

    Returns only a specific meetup in JSON format. Provided ID will determine which meetup is returned. ID of each meetup is generated based on the start date of the meetup in format YYYY-MM-DD.

    This request is a shorthand for www.dev.uxforum.sk/api/meetups?id={id}.

    Successful request returns status code 200. Request with invalid or unknown ID returns status code 404.

    You can use query string parameters for aditional customization. First parameter must be preceeded by ? symbol, all others by & symbol.

    Request with invalid or unknown query string parameter returns status code 400.


    Format

    Configuring the format of returned meetups alters the size of response and used vocabularies. Possible parameters are:

    pretty
    beautifies the JSON response by given amount of spaces increasing its size (default is 0)
    vocabulary
    lists meetups in specified sets of vocabularies (default is uxforum):
    uxforum
    returns meetup information in our custom JSON structure
    schema
    returns meetup information in standard JSON-LD schema
  4. GET/api/partnersLists all partners.

    Lists all partners in JSON format – array with objects representing partners. By default the JSON uses custom UX Forum template, this can be changed by using query parameters.

    Successful request returns status code 200.

    You can use query string parameters for aditional customization. First parameter must be preceeded by ? symbol, all others by & symbol.

    Request with invalid or unknown query string parameter returns status code 400.


    Search

    You can filter partners by searching for a specific keyword or phrase using parameter search. Search supports multiple values, therefore you can use both OR and AND logic. Search is case insensitive.

    Combining multipe values separated by comma into one parameter implements OR logic. Repeating the same parameter with different values implements AND logic.


    Format

    Configuring the format of returned partners alters the size of response and used vocabularies. Possible parameters are:

    pretty
    beautifies the JSON response by given amount of spaces increasing its size (default is 0)
    vocabulary
    lists partners in specified sets of vocabularies (default is uxforum):
    uxforum
    returns job offer information in our custom JSON structure
    schema
    returns job offer information in standard JSON-LD schema
  5. GET/api/teamLists all team members.

    Lists all team members in JSON format – array with objects representing team member. By default the JSON uses custom UX Forum template, this can be changed by using query parameters.

    Successful request returns status code 200.

    You can use query string parameters for aditional customization. First parameter must be preceeded by ? symbol, all others by & symbol.

    Request with invalid or unknown query string parameter returns status code 400.


    Search

    You can filter UX Forum team members by searching for a specific keyword or phrase using parameter search. Search supports multiple values, therefore you can use both OR and AND logic. Search is case insensitive.

    Combining multipe values separated by comma into one parameter implements OR logic. Repeating the same parameter with different values implements AND logic.


    Format

    Configuring the format of returned UX Forum team members alters the size of response and used vocabularies. Possible parameters are:

    pretty
    beautifies the JSON response by given amount of spaces increasing its size (default is 0)
    vocabulary
    lists UX Forum team members in specified sets of vocabularies (default is uxforum):
    uxforum
    returns UX Forum team members information in our custom JSON structure
    schema
    returns UX Forum team members information in standard JSON-LD schema

Community

  1. GET/api/community/eventsLists all community meetups.

    Returns JSON with all external meetups.

  2. GET/api/community/events/{id}Finds community meetup by id.

    Returns JSON of a specific external meetup based on an provided ID. If the ID is invalid then returns status code 404.

  3. GET/api/community/groupsLists all groups.

    Returns JSON with all groups.

  4. GET/api/community/jobsLists all job offers.

    Lists all job offers in JSON format – array with objects representing job offers. By default the JSON uses custom UX Forum template, this can be changed by using query parameters.

    Successful request returns status code 200.

    You can use query string parameters for aditional customization. First parameter must be preceeded by ? symbol, all others by & symbol.

    Some parameters can have only one value while others can have multiple values. Both OR and AND logic are available for parameters supporting multiple values. OR logic is implemented by separating the values with comma while AND logic is implemented by repeating the parameter with different values.

    Request with invalid or unknown query string parameter returns status code 400.


    Search

    You can filter job offers by searching for a specific keyword or phrase using parameter search. Search supports multiple values, therefore you can use both OR and AND logic. Search is case insensitive.

    Combining multipe values separated by comma into one parameter implements OR logic. Repeating the same parameter with different values implements AND logic.


    Pagination

    It is possible to limit the listed job offers to certain number starting from a specific position. This helps reduce the size of response in case only specific amount of job offers is required. Possible parameters are:

    limit
    limits the amount of listed job offers (default is 0 – do not limit).
    offset
    offsets (skips) the listed job offers from either the beginning or the end (default is 0)

    Order of the parameters does not change the output.

    Using negative offset lists given amount of job offers from the end.

    Limit and offset parameters do not support multiple values.


    Format

    Configuring the format of returned job offers alters the size of response and used vocabularies. Possible parameters are:

    pretty
    beautifies the JSON response by given amount of spaces increasing its size (default is 0)
    vocabulary
    lists job offers in specified sets of vocabularies (default is uxforum):
    uxforum
    returns job offer information in our custom JSON structure
    schema
    returns job offer information in standard JSON-LD schema

Resources

  1. GET/resources/logoLogo of UX Forum in SVG format.

    Returns SVG image of UX Forum logo:

    Logo of UX Forum
  2. GET/resources/previewSocial media preview thumbnail of UX Forum page.

    Returns PNG image preview thumbnail used on social media pages of UX Forum:

    Social media preview thumbnail of UX Forum page
  3. GET/resources/favicons/{size}Favicons of various sizes with ratio 1:1.

    Returns a favicon used by UX Forum of specified size. Possible sizes:

    • Favicon 16x16
      16
    • Favicon 32x32
      32
    • Favicon 48x48
      48
  4. GET/resources/icons/{size}Icons of various sizes with ratio 1:1.

    Returns an icon used by UX Forum of specified size. Possible sizes:

    • Icon 72x72
      72
    • Icon 76x76
      76
    • Icon 96x96
      96
    • Icon 120x120
      120
    • Icon 128x128
      128
    • Icon 144x144
      144
    • Icon 152x152
      152
    • Icon 180x180
      180
    • Icon 192x192
      192
    • Icon 384x384
      384
    • Icon 512x512
      512

Redirects

  1. GET/{social}Redirects to social platforms used by UX Forum.

  2. GET/{service}Redirects to sites used by the latest meetup.

  3. GET/meetup/newest|{id}/{service}Redirects to sites used by the specific meetup.