Using the API

Client Id

The API access is protected by a client id token.

In order to access the api please send a email to ‘feedback at clubjudge.com’ with your needs and use case.

https://bifrost.clubjudge.com/v2/artists/1981.json?clientId=orderYourKeyFirst

Resource Embedding

Some resources include a links property, which contains pointers to its various subresources (so an Artist has an Events subresource, among others). Some of these subresources are embeddable, which means that you can include them in the response when requesting the main resource. These are annotated throughout the documentation as embeddable resources.

Example:

https://bifrost.clubjudge.com/v2/artists/1981.json?embeds=events

This yields:

{
  "artist": {
    "id": 1981,
    "name": "Tiesto",
    ...
    "events": {
      "_pagination": {
        "currentPage": 1,
        "perPage": 10,
        "totalPages": 3,
        "totalItems": 22
      },
      "_links": {
        "first": "https://bifrost.clubjudge.com/v2/artists/1981/events.json?page=1",
        "previous": null,
        "self": "https://bifrost.clubjudge.com/v2/artists/1981/events.json?page=1",
        "next": "https://bifrost.clubjudge.com/v2/artists/1981/events.json?page=2",
        "last": "https://bifrost.clubjudge.com/v2/artists/1981/events.json?page=3"
      },
      "source": [...]
    }
  }
}

When embedding a subresource, its assorted metadata (such as _links and _pagination) will be under a key with the subresources name (events in this case). The actual response will be under a special source attribute (in this case, it contains an array of Events).

Partial Responses

The API supports partial responses, meaning that you can select which fields you want the response to contain. It works by passing a fields property in the querystring, using comma-separated values:

https://bifrost.clubjudge.com/v2/artists/1981.json?fields=id,name,address.city

This yields:

{
  "artist": {
    "id": 1981,
    "name": "Tiesto",
    "_links": {
      "events": "https://bifrost.clubjudge.com/v2/artists/1981/events.json",
      "followers": "https://bifrost.clubjudge.com/v2/artists/1981/followers.json",
      "comments": "https://bifrost.clubjudge.com/v2/artists/1981/comments.json",
      "musicGenres": "https://bifrost.clubjudge.com/v2/artists/1981/musicGenres.json"
    }
  }
}

Metadata attributes such as links are not removable, they are always included in the response.

Deep nested fields

You can select deep nested fields in a response by using a dot-separated syntax, as such:

?fields=address.city

In this case, only the city key in the address key will be included.

Response Status Codes

The possible response status codes returned by the API are:

HTTP Code Description
200 OK The request has succeeded
201 Created The request has been fulfilled and resulted in a new resource being created
400 Bad Request Probably caused by a programming error.
401 Unauthorized Make sure you’re sending us a token.
403 Forbidden You don’t have access to whatever it is you’re asking for.
404 Not Found You’re asking for something that doesn’t exist.
429 Too Many Requests The user has sent too many requests in a given amount of time
500 Internal Server Error Uh-oh. Something went wrong on our side. We’re very sorry.
599 Connection Timeout There was a connection timeout while processing this request

Models

Search Item

A search result.

Name Type Description Example
model String Type of result "City"
source Hash Result payload {id: 891,name: "Lisbon",aliases: [],geolocation: {lat: 38.71667,lon:-9.13333},country: {id: 49,name: "Portugal",isocode: "PT"},region: {id: 2646,name: "Lisbon",isocode: null}}

Social Links

A Clubjudge Social link information.

Name Type Description Example Defaults / Info
name String The social link name "Facebook" read only
slug String The social link slug name "facebook" required
href String The social link uri "https://www.facebook.com/panama.amsterdam020" required
  • Twitter (twitter)
  • Facebook (facebook)
  • YouTube (youtube)
  • SoundCloud (soundcloud)
  • Google+ (google+)
  • Songkick (songkick)
  • Instagram (instagram)

Tag

A Clubjudge Tag.

Name Type Description Example
id Integer Unique identifier of tag 9800
name String Name of the tag "Trendy"
type String Tag type descriptor "VenueType"

Venue Schedule

A Clubjudge Venue schedule information.

  allYear: {
    seasonStart: "01-01",
    seasonEnd: "12-31",
    timetable": [{
      startHour: 21:30,
      endHour: 3:00,
      monday: false,
      tuesday: false,
      wendsday: false,
      thursday: true,
      friday: true,
      saturday: true,
      sunday: false
    }]
  },
  seasons: [{
    seasonStart: "10-01",
    seasonEnd: "10-20",
    timetable: [{
      startHour: 20:30,
      endHour: 4:00,
      monday: true,
      tuesday: true,
      wendsday: true,
      thursday: true,
      friday: true,
      saturday: true,
      sunday: false
    }]
  }]

Venue

A Clubjudge Venue information.

Name Type Description Example Defaults / Info
id Integer The venue unique identifier 233 null
createdAt String UTC Datetime when this venue was last modified 2014-04-02T12:05:00 null
updatedAt String UTC Datetime when this venue was created 2014-04-02T12:05:00 null
name String The venue name "Awesome venue" null
closed Boolean Is the venue closed? true false
reviewsCount Integer Number of reviews 455 read only
commentsCount Integer Number of comments 90 read only
followersCount Integer Number of followers 344 read only
upcomingEventsCount Integer Number of upcoming events 344 read only
keywords [String] Array with keywords that describe the venue ["dancing club", "old venue club", "historic"] required
venueTypes [String] Array with venue types ["Rooftop", "Bar"] required
logo Hash Links to venue logo image { guid: 'guid', square_32: 'https://img.cdn-clubjudge.com/guid/1/square_32.jpg', square_60: 'https://img.cdn-clubjudge.com/guid/1/square_60.jpg', square_90: 'https://img.cdn-clubjudge.com/guid/1/square_90.jpg', square_120: 'https://img.cdn-clubjudge.com/guid/1/square_120.jpg', square_160: 'https://img.cdn-clubjudge.com/guid/1/square_160.jpg', square_180: 'https://img.cdn-clubjudge.com/guid/1/square_180.jpg', square_250: 'https://img.cdn-clubjudge.com/guid/1/square_250.jpg', portrait_600: 'https://img.cdn-clubjudge.com/guid/1/portrait_600.jpg' } null and only guid is writable
background Hash Links to venue background image { guid: 'guid', square_160: "https://img.cdn-clubjudge.com/guid/1/square_160.jpg", square_320: "https://img.cdn-clubjudge.com/guid/1/square_320.jpg", square_noblur_320: "https://img.cdn-clubjudge.com/guid/1/square_noblur_320.jpg", square_blur_420: "https://img.cdn-clubjudge.com/guid/1/square_blur_420.jpg", square_720: "https://img.cdn-clubjudge.com/guid/1/square_720.jpg", square_1140: "https://img.cdn-clubjudge.com/guid/1/square_1140.jpg", square_1900: "https://img.cdn-clubjudge.com/guid/1/square_1900.jpg", rectangle_noblur_320x150: "https://img.cdn-clubjudge.com/guid/1/rectangle_noblur_320x150.jpg", rectangle_1240: "https://img.cdn-clubjudge.com/guid/1/rectangle_1240.jpg" } null and only guid is writable
address Hash Venue address { street: 'Oostelijke Handelskade 4', zipCode: '1019 BM', geolocation: { lat: 52.37, lon: 4.93 }, city: [City] } required street, zipCode and city
scores Hash Venue scores, global and by category { global: 8.4, pricing: 7.6, location: 7, atmosphere: 6, safety: 10, service: 8.6, musicAndLineup: 5} read only
_links Hash Include the subresources api links. Subresouces keys: details, areas, schedule, socialLinks, musicGenres read only

Venue Details

A Clubjudge Venue details information.

Name Type Description Example Defaults
email String Contact email "venue@email.com" null
hideEmail Boolean Contact email should be private false false
websiteUrl String website url "http://venue.com" null
phoneNumber String Contact phone for this venue "+55 5555-5555" null
hidePhoneNumber Boolean Contact phone should be private false false
description String Description of this venue This venue is awesome <br> null
escapedDescription String An escaped version of the description This venue is awesome.\n null
shortDescription String A short sentence about this venue This venue is one of the most iconic places in berlin null
openSince String Opening date "2015-01-25" null
capacity Integer The venue overall capacity 1000 (default: null) null
minimumAge Integer The venue entrance minimum age 16 (default: null) null
vipAccess Boolean VIP entrance true (default: null) null
priceRange Integer Price range from 1(cheapest) to 5(most expensive) 1 (default: null) null
vipPrivateArea Boolean The venue have a VIP private area true (default: null) null
parking [Hash] Parking information { street: true, private: true, payed: true } { street: null, private: null, payed: null }
publicTransportation String Public transportation information "By Metro using the Green line on exit 'Cais do Sodré'" null
paymentOptions [Hash] Available payment options { debit: true, visa: true, mastercard: true, amex: false} { debit: null, visa: null, mastercard: null, amex: null}
services [Hash] Available services { weelchair: true, smokingArea: true, lockers: true, food: true} { weelchair: null, smokingArea: null, lockers: null, food: null}
houseRules String Specific venue house rules description "Dress code with fleep floops not allowed." null

Venue Area

A Clubjudge Venue area.

{
  id: 1,
  name: 'Back Stage'
}

User

A ClubJudge User.

Name Type Description Example
id Integer Id of this user 233
email String Email address of this user "user@clubjudge.com"
address Hash Address for this user { address: { city: { id: "891", name: "Lisbon", lonLat: [-9.13333, 38.71667], venuesCount: 10}, country: { id: 49, name: "Portugal", isocode: "PT"}, region: { id: 2646, name: "Lisbon", isocode: null}, composedName: "Lisbon,Portugal"}} v1 only. Replaced by city in v2
city Hash City for this user "city": { "id": 891, "name": "Lisbon", "aliases": [{ "id": 174066, "cityId": 891, "name": "Lisboa", "locale": "pt" }, { "id": 174067, "cityId": 891, "name": "Olisipo", "locale": "la" }], "geolocation": { "lat": 38.71667, "lon": -9.13333 }, "country": { "id": 49, "name": "Portugal", "isocode": "PT" }, "region": { "id": 2646, "name": "Lisbon", "isocode": null } } v2 only. Replaces address
firstName String First name of this user "John"
lastName String Last name of this user "Snow"
fullName String Full name of this user "John Snow"
avatarUrl String Link to this user’s profile picture "http://example.com/john_snow.jpg"
createdAt String When this user first signed up 2014-01-16T21:00:00+01:00
reviewsCount Integer Number of reviews performed by this user 90
expertReviewsCount Integer Number of expert reviews performed by this user 20 (v1 only)
friendsCount Integer Number of friends this user has 344
mutualFriendsCount Integer Number of mutual friends between this user and the logged in user 100 (v1 only)
isFriend Boolean Is this user a friend of the logged in user true (v1 only)
isPendingFriend Boolean Is there an outstanding friend request from the logged in user false (v1 only)
upcomingEventsCount Integer The number of upcoming events for this user 10 (v1 only)
pastEventsCount Integer The number of events this user went to 20 (v1 only)
score Hash This user’s score { totalPoints: 290, usedPoints: 0, availablePoints: 200, availableTickets: 5}
gender String This user’s genre "Male"
bornOn String This user’s birthdate "1986-10-13T00:00:00.000Z"

Review

A Clubjudge Venue Review information.

Name Type Description Example Defaults / Info
id Integer The review unique identifier 1 null
type String The review type, supported options: VenueReview "VenueReview" read only
createdAt String UTC Datetime when this review was last modified "2014-04-02T12:05:00" read only
updatedAt String UTC Datetime when this review was created "2014-04-02T12:05:00" read only
targetId Integer The venue unique identifier 221 required
userId Integer The reviewer unique identifier 1 required
title String The review title "Awesome Place to party!!" required
positiveComments String Positive comments about the venue "The environment is awesome!" null
negativeComments String Negative comments about the venue "Hard to enter!" null
scores Hash Review score by category, in beetween [0-10] {"pricing", 10,"location", 0,"atmosphere", 5,"safety", 1,"service", 10,"musicAndLineup", 10} required
edited Boolean Was this review edited false read only
likedCount Integer Number of users who liked this review 344 read only
unlikedCount Integer Number of users who didn’t liked this review 1 read only
userData Hash User data associated with the current user {"liked", true} null
_links Hash Include the subresources api links. Subresouces keys: user, target read only

NOTE: The userId and targetId of a review can’t be changed after review creation.

PAYLOAD

{
  "id": 1,
  "type": "VenueReview",
  "createdAt": "2014-01-16T21:00:00+01:00",
  "updatedAt": "2014-01-16T21:00:00+01:00",
  "targetId": 221,
  "userId": 1829,
  "title": "Awesome Place to party!!",
  "positiveComments": "The environment is awesome!",
  "negativeComments": "Hard to enter!",
  "scores": {
    "pricing": 10,
    "location": 0,
    "atmosphere": 5,
    "safety": 1,
    "service": 10,
    "musicAndLineup": 10
  },
  "edited": false,
  "likedCount": 10
  "unlikedCount": 1,
  "userData": { "liked", true }
}

Me

A logged in ClubJudge User.

Name Type Description Example
id Integer Id of this user 233
email String Email address of this user "user@clubjudge.com"
address Hash Address for this user { address: { city: { id: "891", name: "Lisbon", lonLat: [-9.13333, 38.71667], venuesCount: 10}, country: { id: 49, name: "Portugal", isocode: "PT"}, region: { id: 2646, name: "Lisbon", isocode: null}, composedName: "Lisbon,Portugal"}} v1 only. Replaced by city in v2
city Hash City for this user "city": { "id": 891, "name": "Lisbon", "aliases": [{ "id": 174066, "cityId": 891, "name": "Lisboa", "locale": "pt" }, { "id": 174067, "cityId": 891, "name": "Olisipo", "locale": "la" }], "geolocation": { "lat": 38.71667, "lon": -9.13333 }, "country": { "id": 49, "name": "Portugal", "isocode": "PT" }, "region": { "id": 2646, "name": "Lisbon", "isocode": null } } v2 only. Replaces address
firstName String First name of this user "John"
lastName String Last name of this user "Snow"
fullName String Full name of this user "John Snow"
avatarUrl String Link to this user’s profile picture "http://example.com/john_snow.jpg"
createdAt String When this user first signed up 2014-01-16T21:00:00+01:00
reviewsCount Integer Number of reviews performed by this user 90
expertReviewsCount Integer Number of expert reviews performed by this user 20 (v1 only)
friendsCount Integer Number of friends this user has 344
mutualFriendsCount Integer Number of mutual friends between this user and the logged in user 100 (v1 only)
isFriend Boolean Is this user a friend of the logged in user true (v1 only)
isPendingFriend Boolean Is there an outstanding friend request from the logged in user false (v1 only)
upcomingEventsCount Integer The number of upcoming events for this user 10 (v1 only)
pastEventsCount Integer The number of events this user went to 20 (v1 only)
score Hash This user’s score { totalPoints: 290, usedPoints: 0, availablePoints: 200, availableTickets: 5}
gender String This user’s genre "Male"
bornOn String This user’s birthdate "1986-10-13T00:00:00.000Z"
preferences Hash This user’s preferences { preferences: { musicGenres: ["62", "1"], city: { id: "891", name: "Lisbon", lonLat: [-9.13333, 38.71667], venuesCount: 10 }, birthdatePreferences: { showOnProfile: false, hideYear: false } } (v1 only)

Ticket

A Clubjudge Ticket.

Name Type Description Example
name String Name of the ticket "door sale"
cents Integer Price of tickets in cents 1233
currency String Currency of ticket price "EUR"
text String Formatted text of value €12,33

NOTE: The available currencies are:

euro => EUR

dollar => USD

australian dollar => AUD

british pound => GBP

brazilian real => BRL

bulgarian lev => BGN

canadian dollar => CAD

chinese yuan => CNY

croatian kuna => HRK

czech koruna => CZK

danish krone => DKK

georgian lari => GEL

hungarian forint => HUF

hong kong dollar => HKD

icelandic krona => ISK

indian rupee => INR

japan yen => JPY

lithuanian litas => LTL

mexican peso => MXN

new zealand dollar => NZD

norwegian krone => NOK

polish zloty => PLN

romanian leu => RON

russian ruble => RUB

serbian dinar => RSD

singapore dollar => SGD

south korean won => KRW

swedish krona => SEK

swiss franc => CHF

turkish lira => TRY

ukrainian hryvnia => UAH

Music Genre

A Clubjudge Music Genre.

Name Type Description Example
id Integer Id of the music genre 36002
parentId Integer Reference to parent genre 1233
name String Name of the music genre "House"
inferred Boolean Weather the music genre was inserted or infered true

Comment

A Clubjudge City.

Name Type Description Example
id Integer Id of the comment 36002
message String Comment message "This is awesome"
timestamp String Date and time when the comment was published "2014-03-15T15:55:33.979Z"
type String Type of comment (comment,activity)
user Hash User representation see User

Artist

A Clubjudge Artist.

Properties

Name Type Description Example
id Integer The unique identifier for this artist 56
name String The name of this artist "Awesome Artist"
description String The bio of this artist "This artist is awesome"
follow Boolean Weather the logged user is going to this artist or not true
followersCount Integer The number of people following this artist 156
commentsCount Integer The number of comments on this artist 856
friendsFollowingCount Integer The number of friends of the logged user going to this artist 20
socialLinks [Hash] Links to the artist in the web { name: 'facebook', slug: 'facebook', href: 'http://facebook.com/artist'}
avatars [Hash] Links to avatars { base: 'http://example.com', ext: 'jpg', id: 1981 } }
email String Contact email "artist@email.com"
websiteUrl String Link to artist’s website "http://artist.com"
upcomingEventsCount Integer Number of upcoming events for this artist 24
socialMentionsCount Integer Number of social mentions for this artist 238
address Hash Address for contact with the artist { city: null, country:null, region:null composedName:null}
background Hash Links to background images for this artist { base: 'http://example.com', ext: 1981 }

Subresources

Name Model
events Event
comments Comment
followers User
musicGenres Music Genre

Event

A Clubjudge Event.

Properties

Name Type Description Example
id Integer The unique identifier for this event 56
name String The name of this event "Awesome Event"
flyers [Hash] The flyers for this event in various sizes [{"square_32": "http://http://local.clubjudge.com:3000/baws/api///flyers/80379/square_32.jpg", "square_60": "http://http://local.clubjudge.com:3000/baws/api///flyers/80379/square_60.jpg", "square_90": "http://http://local.clubjudge.com:3000/baws/api///flyers/80379/square_90.jpg", "square_120": "http://http://local.clubjudge.com:3000/baws/api///flyers/80379/square_120.jpg", "square_160": "http://http://local.clubjudge.com:3000/baws/api///flyers/80379/square_160.jpg", "square_180": "http://http://local.clubjudge.com:3000/baws/api///flyers/80379/square_180.jpg", "square_250": "http://http://local.clubjudge.com:3000/baws/api///flyers/80379/square_250.jpg", "portrait_600": "http://http://local.clubjudge.com:3000/baws/api///flyers/80379/portrait_600.jpg"}]
description String The description of this event "This event is awesome"
startsAt String Date and time when the event starts "2014-01-16T21:00:00+01:00"
endsAt String Date and time when the event ends "2014-01-17T03:00:00+01:00"
updatedAt String Date and time when the event was last modified "2014-01-10T14:00:00+01:00"
featured Boolean Weather the event is featured or not true
lineUpToBeAnnounced Boolean Weather the lineup has being announced or not false
published Boolean Weather the event is published on the website or not true
followersCount Integer The number of people going to this event 156
commentsCount Integer The number of comments on this event 856
friendsFollowingCount Integer The number of friends of the logged user going to this event 20
userData Hash Logged user data regarding this event { appliedForGuestlist: true, attended: true, cancelledByUser: false, confirmed: true, expertJudge: false, judged: false, liked: true, rejected: false }
contest Hash Contest data { startDate: '2014-01-16T21:00:00+01:00', spots: 5, entriesDeadline: '2014-01-16T21:00:00+01:00', organizerConfirmationDeadline: '2014-01-16T21:00:00+01:00', guestlistCloseTime: '2014-01-16T21:00:00+01:00', confirmationToken: 'acbd18db4cc', abortReason: null, entryCost: 50, organizerIds: [123,349] }

Subresources

Name Model
artists Artist
comments Comment
flyers Flyer
invitations Invitation
followers User
musicGenres Music Genre
tickets Ticket
venue Venue

Image

An image.

Name Type Description Example
guid String a unique id of an image 9e0d5901-e778-48e3-ab90-0abc0343ba0c

Country

A Clubjudge Country.

Name Type Description Example
id Integer Id of the country 36002
isocode String Isocode of the country "PT"
name String Name of the country Portugal

City

A Clubjudge City.

v1

Name Type Description Example
id Integer Id of the city 36002
name String Name of the city "Aabenraa"
aliases [String] Other names by which the city is known ["Apenrad"]
region String Region where the city belongs "South Denmark"
geolocation Hash Lat & long coordinates { lat: 55.04434, lon: 9.41741}

v2

Name Type Description Example
id Integer Id of the city 36002
name String Name of the city "Aabenraa"
aliases [Hash] Other names by which the city is known [{id: 60119,cityId: 1743,name: "Kargavank",locale: ""}]
region Hash Region where the city belongs "{id: 1587,name: "North Jeolla",isocode: null}"
country Hash Country where the city belongs { id: 74, name: "South Korea", isocode: "KR"}
geolocation Hash Lat & long coordinates { lat: 55.04434, lon: 9.41741}

Events

PUT _posts/2002-01-02-put-event.md

Update a ClubJudge Event.

Example

curl -H "Content-Type: application/json" -X PUT /
-d '{ \
  "id": 9999,
  "name": "Awesome Party", \
  "venueId": 221, \
  "startsAt": "2016-05-14T23:00:00", \
  "endsAt": "2016-05-15T04:00:00", \
  "flyerGuid": '5e7c80d0-f977-417d-bcb2-77fd6c7020bc', \
  "musicGenreIds": [1], \
  "tickets": [{ \
    "name": "door sale", \
    "cents": 1000, \
    "currency": "EUR", \
    "url": "http://tibbaa.com" \
  }], \
  "artistIds": [1] \
}' \
https://bifrost.clubjudge.com/v2/events/9999.json

POST _posts/2002-01-02-post-event.md

Create a new ClubJudge Event.

Example

curl -H "Content-Type: application/json" -X POST /
-d '{ \
  "name": "Awesome Party", \
  "venueId": 221, \
  "startsAt": "2016-05-14T23:00:00", \
  "endsAt": "2016-05-15T04:00:00", \
  "flyerGuid": '5e7c80d0-f977-417d-bcb2-77fd6c7020bc', \
  "musicGenreIds": [1], \
  "tickets": [{ \
    "name": "door sale", \
    "cents": 1000, \
    "currency": "EUR", \
    "url": "http://tibbaa.com" \
  }], \
  "artistIds": [1] \
}' \
https://bifrost.clubjudge.com/v2/events.json

GET _posts/2002-01-01-get-events.md

A list of ClubJudge Events.

Example

curl "https://bifrost.clubjudge.com/v2/events.json"

Filters

To use the location filter you have to enter at least longitude and latitude.

Parameter Type Description
type String (upcoming, featured, nearby)
lat Decimal latitude
long Decimal longitude
radius Integer radius
starts Date selects any event beginging after this date
ends Date selects any events beginging until this date
musicGenres String filter by music genre
cityId Integer all events from this city
country String country isocode (pt,nl,be …)

Cities

GET _posts/2003-01-01-get-cities-search.md

A collection of ClubJudge City models.

Example

curl "https://bifrost.clubjudge.com/v2/cities/search.json?term=berlin"

Partial responses and Pagination are also supported.

Filters

To use the location filter you have to enter at least longitude and latitude.

Parameter Type Description
term String the term to perform the search against
lat Decimal latitude
lon Decimal longitude

Countries

Artists

PUT _posts/2004-01-01-put-artist.md

Updates a ClubJudge Artist.

Example

curl -H "Content-Type: application/json" -X PUT /
-d '{ \
  "name": "teste-artist-update", \
  "musicGenreIds": [8], \
  "websiteUrl": "http://wearesingular.com", \
  "email": "something@wearesingular.com", \
  "avatarGuid": "55dbc4a8-c081-4322-a1d7-6b6ae6648586" \
}' \
https://bifrost.clubjudge.com/v2/artists/28345.json

POST _posts/2004-01-01-post-artist.md

Create a new ClubJudge Artist.

Example

curl -H "Content-Type: application/json" -X POST /
-d '{ \
  "name": "teste-artist-create", \
  "musicGenreIds": [8], \
  "websiteUrl": "http://wearesingular.com", \
  "email": "something@wearesingular.com", \
  "avatarGuid": "55dbc4a8-c081-4322-a1d7-6b6ae6648586" \
}' \
https://bifrost.clubjudge.com/v2/artists.json

Users

GET _posts/2005-01-04-get-me-reviews.md

A list of Reviews made by the current User. Current user is identified by token.

Partial responses and Pagination are also supported.

Example

curl "https://bifrost.clubjudge.com/v2/me/reviews.json?token=sometoken"

PAYLOAD

{
  "reviews": [
    {
      "id": 1,
      "type": "VenueReview",
      "createdAt": "2015-06-03T16:45:20",
      "updatedAt": "2015-06-03T16:45:20",
      "targetId": 221,
      "userId": 1829,
      "title": "Awesome Place to party!!",
      "positiveComments": "The environment is awesome!",
      "negativeComments": "Hard to enter!",
      "scores": {
        "pricing": 1,
        "location": 1,
        "atmosphere": 1,
        "safety": 1,
        "service": 1,
        "musicAndLineup": 1
      },
      "_links": {
        "target": "https://bifrost.clubjudge.com/v2/reviews/1/target.json",
        "user": "https://bifrost.clubjudge.com/v2/reviews/1/user.json"
      }
    }
  ],
  "_pagination": {
    "currentPage": 1,
    "perPage": 1,
    "totalPages": 27,
    "totalItems": 27
  },
  "_links": {
    "first": "https://bifrost.clubjudge.com/v2/me/reviews.json?page=1",
    "previous": null,
    "self": "https://bifrost.clubjudge.com/v2/me/reviews.json?page=1",
    "next": "https://bifrost.clubjudge.com/v2/me/reviews.json?page=2",
    "last": "https://bifrost.clubjudge.com/v2/me/reviews.json?page=27"
  }
}

Parameters

Reviews can be filtered by venueId (optional).

Parameter Type Description
targetId Integer Filter reviews by targetId (optional)

GET _posts/2005-01-02-get-user-venues-followed.md

A list of Venues followed by the User.

Partial responses and Pagination are also supported.

Example

curl "https://bifrost.clubjudge.com/v2/users/1829/venues.json?type=followed"

PAYLOAD

{
  "venues": [
    {
      "id": 4989,
      "createdAt": "2014-08-14T11:52:48",
      "updatedAt": "2014-09-05T11:43:03",
      "name": "Paradise Garage",
      "reviewsCount": 0,
      "commentsCount": 0,
      "followersCount": 0,
      "upcomingEventsCount": 0,
      "keywords": [],
      "venueTypes": [],
      "logo": null,
      "background": null,
      "address": {
        "street": "Rua João Oliveira Miquens 34/38",
        "zipCode": "1350-187",
        "city": {
          "id": 891
        },
        "geolocation": {
          "lat": 38.7051792,
          "lon": -9.1740121
        }
      },
      "closed": false,
      "scores": null,
      "userData": null,
      "_links": {
        "details": "https://bifrost.clubjudge.com/v2/venues/4989/details.json",
        "schedule": "https://bifrost.clubjudge.com/v2/venues/4989/schedule.json",
        "areas": "https://bifrost.clubjudge.com/v2/venues/4989/areas.json",
        "socialLinks": "https://bifrost.clubjudge.com/v2/venues/4989/socialLinks.json",
        "musicGenres": "https://bifrost.clubjudge.com/v2/venues/4989/musicGenres.json",
        "reviews": "https://bifrost.clubjudge.com/v2/venues/4989/reviews.json"
      }
    }
  ],
  "_pagination": {
    "currentPage": 1,
    "perPage": 1,
    "totalPages": 29,
    "totalItems": 29
  },
  "_links": {
    "first": "https://bifrost.clubjudge.com/v2/users/1829/venues.json?type=followed&perPage=1&page=1",
    "previous": null,
    "self": "https://bifrost.clubjudge.com/v2/users/1829/venues.json?type=followed&perPage=1&page=1",
    "next": "https://bifrost.clubjudge.com/v2/users/1829/venues.json?type=followed&perPage=1&page=2",
    "last": "https://bifrost.clubjudge.com/v2/users/1829/venues.json?type=followed&perPage=1&page=15"
  }
}

GET _posts/2005-01-02-get-user-reviews.md

A list of Reviews made by the specified User.

Partial responses and Pagination are also supported.

Example

curl "https://bifrost.clubjudge.com/v2/users/1829/reviews.json"

PAYLOAD

{
  "reviews": [
    {
      "id": 1,
      "type": "VenueReview",
      "createdAt": "2015-06-03T16:45:20",
      "updatedAt": "2015-06-03T16:45:20",
      "targetId": 221,
      "userId": 1829,
      "title": "Awesome Place to party!!",
      "positiveComments": "The environment is awesome!",
      "negativeComments": "Hard to enter!",
      "scores": {
        "pricing": 1,
        "location": 1,
        "atmosphere": 1,
        "safety": 1,
        "service": 1,
        "musicAndLineup": 1
      },
      "_links": {
        "target": "https://bifrost.clubjudge.com/v2/reviews/1/target.json",
        "user": "https://bifrost.clubjudge.com/v2/reviews/1/user.json"
      }
    }
  ],
  "_pagination": {
    "currentPage": 1,
    "perPage": 1,
    "totalPages": 27,
    "totalItems": 27
  },
  "_links": {
    "first": "https://bifrost.clubjudge.com/v2/users/1829/reviews.json?page=1",
    "previous": null,
    "self": "https://bifrost.clubjudge.com/v2/users/1829/reviews.json?page=1",
    "next": "https://bifrost.clubjudge.com/v2/users/1829/reviews.json?page=2",
    "last": "https://bifrost.clubjudge.com/v2/users/1829/reviews.json?page=27"
  }
}

Stats

Venues

GET _posts/2007-01-12-get-venue-tags.md

Get the Tag on the ClubJudge Venue.

Example

Get all tags for venue 221

curl -H "Content-Type: application/json" -X GET https://bifrost.clubjudge.com/v2/venues/221/tags.json

PAYLOAD

{
  "tags": [
    {
      "name": "Suggested",
      "tagType": "Editorial",
      "id": 1
    },
    {
      "name": "Fun",
      "tagType": "Atmosphere",
      "id": 2
    }
  ],
  "_pagination": {
    "currentPage": 1,
    "perPage": 2,
    "totalPages": 1,
    "totalItems": 2
  },
  "_links": {
    "first": "http://127.0.0.1:5050/v2/venues/221/tags.json?page=1",
    "previous": null,
    "self": "http://127.0.0.1:5050/v2/venues/221/tags.json?page=1",
    "next": null,
    "last": "http://127.0.0.1:5050/v2/venues/221/tags.json?page=1"
  }
}

POST _posts/2007-01-11-post-venue-tag.md

Create the Tag on the ClubJudge Venue.

Example

Creates a link between venue 221 and the reference tag with id 9800.

curl -H "Content-Type: application/json" -X POST /
-d '{"id": 9800 }' /
https://bifrost.clubjudge.com/v2/venues/221/tags.json?token=userToken

NOTES: The tag with can be obtain from /tags and only administrator users are allowed to perform this operation.

GET _posts/2007-01-10-get-venue-reviews.md

Retrieve a list of Review from the Venue.

Partial responses and Pagination are also supported.

Example

Returns a list of reviews.

curl -H "Content-Type: application/json" -X GET https://bifrost.clubjudge.com/v2/venues/221/reviews.json

PAYLOAD

{
  "reviews": [
    {
      "id": 1,
      "type": "VenueReview",
      "createdAt": "2015-06-03T16:45:20",
      "updatedAt": "2015-06-03T16:45:20",
      "targetId": 221,
      "userId": 1829,
      "title": "Awesome Place to party!!",
      "positiveComments": "The environment is awesome!",
      "negativeComments": "Hard to enter!",
      "scores": {
        "pricing": 1,
        "location": 1,
        "atmosphere": 1,
        "safety": 1,
        "service": 1,
        "musicAndLineup": 1
      },
      "_links": {
        "target": "https://bifrost.clubjudge.com/v2/reviews/1/target.json",
        "user": "https://bifrost.clubjudge.com/v2/reviews/1/user.json"
      }
    }
  ],
  "_pagination": {
    "currentPage": 1,
    "perPage": 1,
    "totalPages": 27,
    "totalItems": 27
  },
  "_links": {
    "first": "https://bifrost.clubjudge.com/v2/venues/221/reviews.json?page=1",
    "previous": null,
    "self": "https://bifrost.clubjudge.com/v2/venues/221/reviews.json?page=1",
    "next": "https://bifrost.clubjudge.com/v2/venues/221/reviews.json?page=2",
    "last": "https://bifrost.clubjudge.com/v2/venues/221/reviews.json?page=27"
  }
}

Parameters

Reviews can be ordered by date, score, likes and unlikes.

Parameter Type Description
token String Current user token, will be used to retrieve user data (optional)
orderBy String Order criteria: date (default), score, likes and unlikes
order String Order type: desc (default), asc

PUT _posts/2007-01-08-put-venue-areas.md

Updates a VenueArea on a ClubJudge Venue.

Example

Updates area 1 for venue 221

curl -H "Content-Type: application/json" -X PUT /
-d '{"name": "Main stage updated"}' /
https://bifrost.clubjudge.com/v2/venues/221/areas/1.json?token=userToken

PUT _posts/2007-01-06-put-venue-social-link.md

Update the SocialLink in the ClubJudge Venue.

Example

Updates the link of social network facebook on venue 221

curl -H "Content-Type: application/json" -X PUT /
-d '{"href": "http://facebook.com/mybook"}' /
https://bifrost.clubjudge.com/v2/venues/221/socialLinks/facebook.json?token=userToken

POST _posts/2007-01-06-post-venue-social-link.md

Create the SocialLink on the ClubJudge Venue.

Example

Creates a link between venue 221 and the social network facebook

curl -H "Content-Type: application/json" -X POST /
-d '{"slug": "facebook", "href": "http://facebook.com/mybook", name: "Facebook"}' /
https://bifrost.clubjudge.com/v2/venues/221/socialLinks.json?token=userToken

PUT _posts/2007-01-04-put-venue-schedule.md

Update the ClubJudge VenueSchedule.

Example

curl -H "Content-Type: application/json" -X POST /
-d '{"allYear": { \
    "seasonStart": "01-01", \
    "seasonEnd": "12-31", \
    "timetable": [{ \
      "startHour": "21:30", \
      "endHour": 3:00, \
      "monday": false, \
      "tuesday": false, \
      "wendsday": false, \
      "thursday": true, \
      "friday": true, \
      "saturday": true, \
      "sunday": false \
    }] \
  }, \
  "seasons": [{ \
    "seasonStart": "10-01", \
    "seasonEnd": "10-20", \
    "timetable": [{ \
      "startHour": "20:30", \
      "endHour": "4:00", \
      "monday": true, \
      "tuesday": true, \
      "wendsday": true, \
      "thursday": true, \
      "friday": true, \
      "saturday": true, \
      "sunday": false \
    }]
  }]}' /
https://bifrost.clubjudge.com/v2/venues/221/schedule.json?token=userToken

PUT _posts/2007-01-03-put-venue-details.md

Update the ClubJudge VenueDetails.

Example

curl -H "Content-Type: application/json" -X POST /
-d '{ \
  "details": { \
    "email": "someemail@email.com", \
    "hideEmail": false, \
    "websiteUrl": "http://www.website.com", \
    "phoneNumber": "+351 9999999", \
    "hidePhoneNumber": false, \
    "description": "This is a description", \
    "escapedDescription": "This is a description", \
    "shortDescription": "This is", \
    "openSince": "2012-01-01", \
    "capacity": 100, \
    "minimumAge": 16, \
    "vipAccess": true, \
    "priceRange": 2, \
    "vipPrivateArea": true, \
    "parking": { \
      "street":true, \
      "private":true, \
      "payed":true \
    }, \
    "services": { \
      "wheelchair": true, \
      "smokingArea":true, \
      "lockers":true, \
      "food":true \
    }, \
    "paymentOptions": { \
      "debit":true, \
      "visa":true, \
      "mastercard":true, \
      "amex":true \
    }, \
    "publicTransportation": "a bus", \
    "houseRules": "No shoes" \
  } \
}'\
https://bifrost.clubjudge.com/v2/venues/221/details.json?token=userToken

PUT _posts/2007-01-02-put-venue.md

Update the ClubJudge Venue.

Example

curl -H "Content-Type: application/json" -X PUT /
-d '{ \
      "name": "De Mast", \
      "reviewsCount": 0, \
      "commentsCount": 0, \
      "followersCount": 0, \
      "upcomingEventsCount": 0, \
      "keywords": [ \
          "word1", \
          "word2" \
      ], \
      "venueTypes": [ \
        "Rooftop", \
      ], \
      "logo": { \
        "guid": "fsd78f8sd-f45hfgdhgf5f5-f53ft24f5" \
      }, \
      "background": { \
          "guid": "fsd78f8sd-f453gff5f5-f53ft24f5" \
      }, \
      "address": { \
          "street": "Industrielaan 2", \
          "zipCode": "8820 Torhout", \
          "geolocation": { \
              "lat": 51.6478451, \
              "lon": 5.6437661 \
          }, \
          "city": { \
              "id": 774, \
          } \
      }' \
https://bifrost.clubjudge.com/v2/venues/221.json?token=userToken

POST _posts/2007-01-02-post-venue.md

Create a new ClubJudge Venue.

Example

curl -H "Content-Type: application/json" -X POST /
-d '{ \
      "name": "De Mast", \
      "reviewsCount": 0, \
      "commentsCount": 0, \
      "followersCount": 0, \
      "upcomingEventsCount": 0, \
      "keywords": [ \
          "word1", \
          "word2" \
      ], \
      "venueTypes": [ \
        "Rooftop" \
      ], \
      "logo": { \
        "guid": "fsd78f8sd-f45hfgdhgf5f5-f53ft24f5" \
      }, \
      "background": { \
          "guid": "fsd78f8sd-f453gff5f5-f53ft24f5" \
      }, \
      "address": { \
          "street": "Industrielaan 2", \
          "zipCode": "8820 Torhout", \
          "geolocation": { \
              "lat": 51.6478451, \
              "lon": 5.6437661 \
          }, \
          "city": { \
              "id": 774, \
          } \
      }' \
https://bifrost.clubjudge.com/v2/venues/221.json?token=userToken

GET _posts/2007-01-01-get-venues.md

A list of ClubJudge Venues.

Example

curl "https://bifrost.clubjudge.com/v2/venues.json"

Partial responses and Pagination are also supported.

Filters

Parameter Type Description
cityId Integer city id
countryId Integer country id
country String country isocode (pt,nl,be …)
type String (nearby, trending, bestJudged)
tagTypes Array (recommended, cj)
tags Array (trendy, luxury)
venueTypes Array (club, hotel, restaurant)
lat float latitude
lon float longitude
radius float radius
closed boolean Filter by closed clubs (closed=true) or open clubs (closed=false)
orderBy string Order by: score, reviews, id (default)
order string Ordering: asc (default) desc

NOTES: The radius options can be combined with lat&lon or with cityId.

GET _posts/2007-01-01-get-venues-search.md

ONLY FOR V1. REPLACED BY /venues.json?q=

A collection of ClubJudge Venue models.

Example

curl "https://bifrost.clubjudge.com/v1/venues/search.json?term=paradiso"

Partial responses and Pagination are also supported.

Filters

To use the location filter you have to enter at least longitude and latitude.

Parameter Type Description
term String the term to perform the search against
lat Decimal latitude
lon Decimal longitude

GET _posts/2007-01-01-get-venue-search.md

A collection of ClubJudge Venue models that match the search parameter.

Example

curl "https://bifrost.clubjudge.com/v2/venues.json?q=paradiso"

Partial responses and Pagination are also supported.

Filters

To use the location filter you have to enter at least longitude and latitude.

Parameter Type Description
q String the term to perform the search against

Tags

GET _posts/2008-01-01-get-tags.md

A ClubJudge Tag.

Example

curl "https://bifrost.clubjudge.com/v2/tags.json?type=VenueType"

Pagination is also supported.

Filters

type filter is mandatory.

Parameter Type Description
type String A tag type (“VenueType”|”VenueKeyword”). Returns tags of given type

Music Genres

GET _posts/2008-02-01-get-music-genres.md

A ClubJudge MusicGenre.

Example

curl "https://bifrost.clubjudge.com/v2/musicGenres.json?type=parent"

Pagination is also supported.

Filters

type filter is mandatory.

Parameter Type Description Optional
type String A music genre type filter, type=parent returns parent music genres only. true

Images

POST _posts/2010-01-01-post-images-logos.md

Create a temp Image logo

Example

Creates a temporary image logo

With a blob

curl -H "Content-Type: application/json" -X POST /
-d '{"blob": { "data": "asfsadf", "extension": "png"}}' /
https://bifrost.clubjudge.com/v2/images/logos.json

With a url

curl -H "Content-Type: application/json" -X POST /
-d '{"url": "http://mycdn.com/image.png" }' /
https://bifrost.clubjudge.com/v2/images/logos.json

POST _posts/2010-01-01-post-images-flyers.md

Create a temp Image flyer

Example

Creates a temporary image flyer

With a blob

curl -H "Content-Type: application/json" -X POST /
-d '{"blob": { "data": "asfsadf", "extension": "png"}}' /
https://bifrost.clubjudge.com/v2/images/flyers.json

With a url

curl -H "Content-Type: application/json" -X POST /
-d '{"url": "http://mycdn.com/image.png" }' /
https://bifrost.clubjudge.com/v2/images/flyers.json

POST _posts/2010-01-01-post-images-avatars.md

Create a temp Image avatar

Example

Creates a temporary image avatar.

With a blob

curl -H "Content-Type: application/json" -X POST /
-d '{"blob": { "data": "asfsadf", "extension": "png"}}' /
https://bifrost.clubjudge.com/v2/images/avatars.json

With a url

curl -H "Content-Type: application/json" -X POST /
-d '{"url": "http://mycdn.com/image.png" }' /
https://bifrost.clubjudge.com/v2/images/avatars.json

POST _posts/2010-01-01-post-image-background.md

Create a temp Image background

Example

Creates a temporary image background

With a blob (using enconding base64 or binary string)

curl -H "Content-Type: application/json" -X POST /
-d '{"blob": { "data": "asfsadf", "extension": "png", enconding: 'base64'}}' /
https://bifrost.clubjudge.com/v2/images/backgrounds.json

With a url

curl -H "Content-Type: application/json" -X POST /
-d '{"url": "http://mycdn.com/image.png" }' /
https://bifrost.clubjudge.com/v2/images/backgrounds.json

Reviews

GET _posts/2011-03-03-get-review-users.md

Retrieve the User for the current review

Partial responses and Pagination are also supported.

Example

Returns the reviews’s user.

curl -H "Content-Type: application/json" -X GET https://bifrost.clubjudge.com/v2/reviews/5/user.json

PAYLOAD

{ "user": { "id": 6, "email": "dadah@sapo.pt", "city": { "id": 891, "name": "Lisbon", "aliases": [ { "id": 174066, "cityId": 891, "name": "Lisboa", "locale": "pt" }, { "id": 174067, "cityId": 891, "name": "Olisipo", "locale": "la" } ], "geolocation": { "lat": 38.71667, "lon": -9.13333 }, "country": { "id": 49, "name": "Portugal", "isocode": "PT" }, "region": { "id": 2646, "name": "Lisbon", "isocode": null } }, "firstName": "Francisco", "lastName": "Temudo", "fullName": "Francisco Temudo", "avatarUrl": "https://images.clubjudge.com/3b48a1a4-e0fe-4093-913a-6fbce8c09805/1/square_100.jpg", "isFacebook": true, "createdAt": "2012-12-14T04:15:03", "updatedAt": "2015-02-27T18:49:47", "reviewsCount": 0, "friendsCount": 35, "score": { "totalPoints": 0, "usedPoints": 0, "availablePoints": 0, "availableTickets": 0 }, "gender": "male", "bornOn": "1979-10-01T00:00:00", "_links": { "events": "http://localhost:5000/v2/users/6/events.json?type=upcoming", "reviews": "http://localhost:5000/v2/users/6/reviews.json" } } }

DELETE _posts/2011-01-03-delete-review.md

Delete an existent Review.

Example

Delete the review with id 1.

curl -H "Content-Type: application/json" -X DELETE https://bifrost.clubjudge.com/v2/reviews/1.json?token=userToken

NOTE: Only adminstrator users and the user who created the review are allowed to delete the review.

PUT _posts/2011-01-02-put-review.md

Update an existent Review.

Example

Update the review with id 1.

curl -H "Content-Type: application/json" -X PUT -d \
'{
  "title": "Awesome Place to party!!",
  "positiveComments": "The environment is awesome!",
  "negativeComments": "Hard to enter!",
  "scores": {
    "pricing": 10,
    "location": 0,
    "atmosphere": 5,
    "safety": 1,
    "service": 10,
    "musicAndLineup": 10
  }
}' \
https://bifrost.clubjudge.com/v2/reviews/1.json?token=userToken

NOTE: Only the user who created the review are allowed to update the review.

POST _posts/2011-01-01-post-review.md

Create the Review on the ClubJudge.

Example

Creates a new review for venue 221.

curl -H "Content-Type: application/json" -X POST -d \
'{
  "type": "VenueReview",
  "targetId": 221,
  "title": "Awesome Place to party!!",
  "positiveComments": "The environment is awesome!",
  "negativeComments": "Hard to enter!",
  "scores": {
    "pricing": 10,
    "location": 0,
    "atmosphere": 5,
    "safety": 1,
    "service": 10,
    "musicAndLineup": 10
  }
}' \
https://bifrost.clubjudge.com/v2/reviews.json?token=userToken

GET _posts/2011-01-01-get-reviews.md

Retrieve a list of Review.

Partial responses and Pagination are also supported.

Example

Returns a list of reviews.

curl -H "Content-Type: application/json" -X GET https://bifrost.clubjudge.com/v2/reviews.json

PAYLOAD

{
  "reviews": [
    {
      "id": 1,
      "type": "VenueReview",
      "createdAt": "2015-06-03T16:45:20",
      "updatedAt": "2015-06-03T16:45:20",
      "targetId": 221,
      "userId": 1829,
      "title": "Awesome Place to party!!",
      "positiveComments": "The environment is awesome!",
      "negativeComments": "Hard to enter!",
      "scores": {
        "pricing": 1,
        "location": 1,
        "atmosphere": 1,
        "safety": 1,
        "service": 1,
        "musicAndLineup": 1
      },
      "_links": {
        "target": "https://bifrost.clubjudge.com/v2/reviews/1/target.json",
        "user": "https://bifrost.clubjudge.com/v2/reviews/1/user.json"
      }
    }
  ],
  "_pagination": {
    "currentPage": 1,
    "perPage": 1,
    "totalPages": 27,
    "totalItems": 27
  },
  "_links": {
    "first": "https://bifrost.clubjudge.com/v2/reviews.json?page=1",
    "previous": null,
    "self": "https://bifrost.clubjudge.com/v2/reviews.json?page=1",
    "next": "https://bifrost.clubjudge.com/v2/reviews.json?page=2",
    "last": "https://bifrost.clubjudge.com/v2/reviews.json?page=27"
  }
}

Parameters

Reviews can be ordered by date, score, likes and unlikes.

Parameter Type Description
token String Current user token, will be used to retrieve user data (optional)
type String Filter by review type: VenueReview
startsAt DateTime get reviews updated after startsAt
endsAt DateTime get reviews updated before endsAt
cityId Integer get reviews for given city
orderBy String Order criteria: date (default), score, likes and unlikes
order String Order type: desc (default), asc
targetId Integer Filter reviews by target Id (optional)
userId Integer Filter reviews by user Id (optional)
country String Filter reviews by country isocode (optional)
countryId Integer Filter reviews by country Id (optional)

GET _posts/2011-01-01-get-review.md

Retrieve a specific Review.

Partial responses and Pagination are also supported.

Example

Returns the review with id 1.

curl -H "Content-Type: application/json" -X GET -d https://bifrost.clubjudge.com/v2/reviews/1.json

PAYLOAD

{
  "review": {
    "id": 1,
    "type": "VenueReview",
    "createdAt": "2015-06-04T15:45:46",
    "updatedAt": "2015-06-04T15:45:46",
    "targetId": 221,
    "userId": 1829,
    "title": "Awesome Place to party!!",
    "positiveComments": "The environment is awesome!",
    "negativeComments": "Hard to enter!",
    "scores": {
      "pricing": 10,
      "location": 0,
      "atmosphere": 5,
      "safety": 1,
      "service": 10,
      "musicAndLineup": 10
    },
    "_links": {
      "target": "https://bifrost.clubjudge.com/v2/reviews/1/target.json",
      "user": "https://bifrost.clubjudge.com/v2/reviews/1/user.json"
    }
  }
}

NOTE: The token parameter is optional and will be used to retrieve user data.

Search

GET _posts/2011-04-01-get-search.md

Only available for City and Country A collection of SearchItem models that match the search parameter.

Example

curl "https://bifrost.clubjudge.com/v2/search.json?q=lisbon&models[]=city&models[]=country"

Partial responses and Pagination are also supported.

Filters

To use the location filter you have to enter at least longitude and latitude.

Parameter Type Description
q String the term to perform the search against
models String Array list of models to search