Versions Compared

Version Old Version 6 New Version Current
Changes made by

J Cobb

J Cobb

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Page Properties
labelapi_docs_CONTROLLERTAG


NameSearch
DescriptionSearches against given types
TypeGET
URL
/search
Credential TypeAPI|User
Supports PaginationYesNo


Long Description

Searches against given types. 

 



Parameters

Name
Description
Type
Required
types
OR
types[] 

Either a comma-separated list (preferred) or an array of entities for which you would like to get. Possible values:

  • brokerages
  • clients
  • events
  • offices
  • performers
  • venues

 

 




Info

If you use an array be sure to urlencode the square brackets. e.g.: GET /v9/search?types%5B%5D=events&types%5B%5D=performers

 

 

 




String

Required
qThe search query for suggestions.StringRequired
fuzzyIf search results are to match any instead of all words passed. Default is false.BooleanOptional
order_by_popularityIndicate if you wish to sort the results with most popular firstBooleanOptional

 


Examples

 

 
RequestResponse

GET /v9/search?order_by_popularity=true&page=1&per_page=2&q=yankee&types=events,performers,venues

OR

GET /v9/search?order_by_popularity=true&page=1&per_page=2&q=yankee&types%5B%5D=events&types%5B%5D=performers&types%5B%5D=venues


Code Block
languageruby
themeConfluence
{
  "results": [
    {
      "products_count": 3636,
      "state": "shown",
      "occurs_at": null,
      "_type": "Event",
      "url": "/events/909300",
      "updated_at": null,
      "_score": "1541.52",
      "configuration": null,
      "performances": [
        {
          "performer": {
            "url": "/performers/15533",
            "id": "15533"
          },
          "primary": true
        },
        {
          "performer": {
            "url": "/performers/15535",
            "id": "15535"
          },
          "primary": false
        }
      ],
      "venue": null,
      "name": "Toronto Blue Jays at New York Yankees",
      "category": null,
      "id": "909300"
    },
    {
      "products_count": 4087,
      "state": "shown",
      "occurs_at": null,
      "_type": "Event",
      "url": "/events/913939",
      "updated_at": null,
      "_score": "868.28",
      "configuration": null,
      "performances": [
        {
          "performer": {
            "url": "/performers/15533",
            "id": "15533"
          },
          "primary": false
        },
        {
          "performer": {
            "url": "/performers/15541",
            "id": "15541"
          },
          "primary": true
        }
      ],
      "venue": null,
      "name": "New York Yankees at Los Angeles Angels",
      "category": null,
      "id": "913939"
    }
  ]
}