groupings | groups
Returns a listing and details of all or selected grouping(s) - including exhibitions, events, web pages, etc.
Call syntax
Normal call: groupings
https://api.artlookonline.com/groupings?tenant_id=1&api_code=Abcde567
Shortcut call: groups
https://api.artlookonline.com/groups/new-modernists-gallery
Return values
Data ('id', 'type', 'title' , 'categoryId', 'location' , 'date_start' , 'date_end' , 'description' ,
'publish', 'link_event', 'sequence' , 'information' , 'subtitle', 'subType' , 'youtube', 'updated_at', 'next',
'previous',[images], [items], [artists], [categories]).
Optional parameters
- id (if one specific group only is required)
&id=36
- sequence (sort order for resulting data – by 'sort', 'type', 'title', 'date_start', 'date_end')
&sequence=title
- categoryName (only include groupings of a specific named type)
&categoryName=exhibition
- categoryId (only include groupings of a specific numeric type)
&categoryId=6118
- titles (only return title and id if true)
&titles=true
- onlyIds (only return a list of ids)
&onlyIds=true
- future (only include groupings where dateStart > today)
&future=true
- current (only include groupings where dateStart <= today and dateEnd >= today)
¤t=true
- notPast (only include groupings where dateEnd >= today)
¬Past=true
- past (only include groupings where dateEnd < today)
- withItems (returns additonal abbreviated list (array) of items (id, title, artist) if true)
&withItems=true
- no-imagecheck (speeds up routine by not checking if grouping image exists)
&no-imagecheck=true
- nav (will return ids of next and previous records – nb only works if id has been specified, ie just one grouping being returned)
&nav=true&id=36526
- withArtists (will return a list of all artists in each grouping as id=>name array pairs),
provided the option withItems has been specified. Groupings that are set to be "artist indexed"
do not need withArtists specified to produce this list, however withItems is still necessary.
&withArtists=true&withItems=true
Notes