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.
/api
Prints 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.
/api/meetups
Lists 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 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:
Combining multipe values separated by comma into one parameter implements OR logic. Repeating the same parameter with different values implements AND logic.
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.
By default, the listed meetups are sorted by date. You can change the order of meetups by using a different property:
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.
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:
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.
Configuring the format of returned meetups alters the size of response and used vocabularies. Possible parameters are:
/api/meetups/newest
Finds 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.
Configuring the format of returned meetups alters the size of response and used vocabularies. Possible parameters are:
/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.
Configuring the format of returned meetups alters the size of response and used vocabularies. Possible parameters are:
/api/partners
Lists 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.
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.
Configuring the format of returned partners alters the size of response and used vocabularies. Possible parameters are:
/api/team
Lists 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.
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.
Configuring the format of returned UX Forum team members alters the size of response and used vocabularies. Possible parameters are:
/api/community/events
Lists all community meetups.Returns JSON with all external meetups.
/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.
/api/community/groups
Lists all groups.Returns JSON with all groups.
/api/community/jobs
Lists 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.
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.
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:
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.
Configuring the format of returned job offers alters the size of response and used vocabularies. Possible parameters are:
/resources/logo
Logo of UX Forum in SVG format.Returns SVG image of UX Forum logo:
/resources/preview
Social media preview thumbnail of UX Forum page.Returns PNG image preview thumbnail used on social media pages of UX Forum:
/resources/favicons/{size}
Favicons of various sizes with ratio 1:1.Returns a favicon used by UX Forum of specified size. Possible sizes:
/resources/icons/{size}
Icons of various sizes with ratio 1:1.Returns an icon used by UX Forum of specified size. Possible sizes:
/{social}
Redirects to social platforms used by UX Forum./{service}
Redirects to sites used by the latest meetup./meetup/newest|{id}/{service}
Redirects to sites used by the specific meetup.