Page Properties | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||
|
...
Name | Description | Type | Presence | Location | Conditionals |
---|---|---|---|---|---|
venue_id | ID of the Performer’s home venue (most performers do not have one) | Integer | Optional | Query | No |
category_id | Show only Performers in this category (does not include sub-categories) | Integer | Optional | Query | No |
category_tree | When true and used in conjunction with category_id performers in sub-categories of the category_id will be included | Boolean | Optional | Query | No |
only_with_upcoming_events | Filter to only Performers who have upcoming events | Boolean | Optional | Query | No |
upcoming_events_end_date | Filter to only Performers who have upcoming events earlier than the date ("only_with_upcoming_events" must be true) | Date (ISO_8601) | Optional | Query | No |
first_letter | Filter to Performers whose names begin with this letter | String | Optional | Query | No |
popularity_score | Filter to Performers whose popularity score is greater than the valuemeets the provided conditionals | Decimal | Optional | Query | NoYes |
disabled_at | Filter to Performers disabled before or after a certain date | Date (ISO_8601) | Optional | Query | Yes |
deleted_at | Filter performers deleted before or after a certain date | Date (ISO_8601) | Optional | Query | Yes |
updated_at | Filter performers updated before or after a certain date | Date (ISO_8601) | Optional | Query | Yes |
name | Exact name of the Performer. Use Performers / Search when searching for a Performer by name. | String | Optional | Query | No |
order_by | Pass in the parameter that you want to order by and the sorting order (Ex. :order_by => "performers.popularity_score DESC") | String | Optional | Query | No |
Examples
Request | Response | |||||||||
---|---|---|---|---|---|---|---|---|---|---|
/v9/performers?name=Pawtucket%20Red%20Sox | ||||||||||
|
|