Skip Main Navigation
Page Content

Users

Note

These URLs will accept “me” in place of a user ID in URLs - for example, /users/me/orders/ will return orders placed by the current user.

GET /users/:id/

Returns a user for the specified user as user. If you want to get details about the currently authenticated user, use /users/me/.

Parameters

Takes no parameters

Errors

No endpoint-specific errors

GET /users/:id/orders/

Returns a paginated response of orders, under the key orders, of all orders the user has placed (i.e. where the user was the person buying the tickets).

param int id:The id assigned to a user.
param datetime changed_since:
 (optional) Only return attendees changed on or after the time given.

Note

A datetime represented as a string in ISO8601 combined date and time format, always in UTC.

Parameters

Name Type Required Description
changed_since datetime No Only return resource changed on or after the time given
time_filter string No Limits results to either past or current & future events / orders. (Valid choices are: all, past, or current_future)

Errors

No endpoint-specific errors

GET /users/:id/organizers/

Returns a paginated response of organizer objects that are owned by the user.

Parameters

Takes no parameters

Errors

No endpoint-specific errors

GET /users/:id/owned_events/

Returns a paginated response of events, under the key events, of all events the user owns (i.e. events they are organising)

Parameters

Name Type Required Description
order_by string No How to order the results (Valid choices are: start_asc, start_desc, created_asc, or created_desc)
show_series_parent boolean No True: Will show parent of a serie instead of children False: Will show children of a serie (Default value)
status string No Filter by events with a specific status set. This should be a comma delimited string of status. Valid status: all, draft, live, canceled, started, ended.

Errors

No endpoint-specific errors

GET /users/:id/events/

Returns a paginated response of events, under the key events, of all events the user has access to

Parameters

Name Type Required Description
name_filter string No Filter event results by name
order_by string No How to order the results (Valid choices are: start_asc, start_desc, created_asc, or created_desc)
show_series_parent boolean No True: Will show parent of a serie instead of children False: Will show children of a serie (Default value)
status string No Filter by events with a specific status set. This should be a comma delimited string of status. Valid status: all, draft, live, canceled, started, ended.
event_group_id string No Filter event results by event_group_id

Errors

No endpoint-specific errors

GET /users/:id/venues/

Returns a paginated response of venue objects that are owned by the user.

Parameters

Takes no parameters

Errors

No endpoint-specific errors

GET /users/:id/owned_event_attendees/

Returns a paginated response of attendees, under the key attendees, of attendees visiting any of the events the user owns (events that would be returned from /users/:id/owned_events/)

Parameters

Name Type Required Description
status string No Limits results to either confirmed attendees or cancelled/refunded/etc. attendees (Valid choices are: attending, or not_attending)
changed_since datetime No Only return resource changed on or after the time given

Errors

No endpoint-specific errors

GET /users/:id/owned_event_orders/

Returns a paginated response of orders, under the key orders, of orders placed against any of the events the user owns (events that would be returned from /users/:id/owned_events/)

Parameters

Name Type Required Description
status string No Filter to active (attending), inactive (not attending), or all (both) orders (Valid choices are: active, inactive, or all)
only_emails list No Only include orders placed by one of these emails
exclude_emails list No Don’t include orders placed by any of these emails
changed_since datetime No Only return resource changed on or after the time given

Errors

No endpoint-specific errors

GET /users/:id/contact_lists/

Returns a list of contact_list that the user owns as the key contact_lists.

Parameters

Takes no parameters

Errors

No endpoint-specific errors

POST /users/:id/contact_lists/

Makes a new contact_list for the user and returns it as contact_list.

Parameters

Name Type Required Description
contact_list.name string Yes Name of the new contact list

Errors

No endpoint-specific errors

GET /users/:id/contact_lists/:contact_list_id/

Gets a user’s contact_list by ID as contact_list.

Parameters

Takes no parameters

Errors

No endpoint-specific errors

POST /users/:id/contact_lists/:contact_list_id/

Updates the contact_list and returns it as contact_list.

Parameters

Name Type Required Description
contact_list.name string Yes New name of the contact list

Errors

No endpoint-specific errors

DELETE /users/:id/contact_lists/:contact_list_id/

Deletes the contact list. Returns {"deleted": true}.

Parameters

Takes no parameters

Errors

No endpoint-specific errors

GET /users/:id/contact_lists/:contact_list_id/contacts/

Returns the contacts on the contact list as contacts.

Parameters

Takes no parameters

Errors

No endpoint-specific errors

POST /users/:id/contact_lists/:contact_list_id/contacts/

Adds a new contact to the contact list. Returns {"created": true}.

There is no way to update entries in the list; just delete the old one and add the updated version.

Parameters

Name Type Required Description
contact.email string Yes Contact’s email address
contact.first_name string No Contact’s first name (or full name)
contact.last_name string No Contact’s last name

Errors

No endpoint-specific errors

DELETE /users/:id/contact_lists/:contact_list_id/contacts/

Deletes the specified contact from the contact list. Returns {"deleted": true}.

Parameters

Name Type Required Description
email string Yes Email address to remove

Errors

No endpoint-specific errors

GET /users/:id/bookmarks/

Gets all the user’s saved events.

In order to update the saved events list, the user must unsave or save each event.

A user is authorized to only see his/her saved events.

Parameters

Name Type Required Description
bookmark_list_id string No Optional bookmark list id to fetch all bookmarks from

Errors

No endpoint-specific errors

POST /users/:id/bookmarks/save/

Adds a new bookmark for the user. Returns {"created": true}.

A user is only authorized to save his/her own events.

Parameters

Name Type Required Description
event_id integer No Event id to bookmark for the user
event_ids list No Event ids to batch bookmark for the user
bookmark_list_id string No Optional Bookmark list id to save the bookmark(s) to

Errors

  • BOOKMARK_ALREADY_EXISTS: The bookmark you are attempting to create already exists.

POST /users/:id/bookmarks/unsave/

Removes the specified bookmark from the event for the user. Returns {"deleted": true}.

A user is only authorized to unsave his/her own events.

Parameters

Name Type Required Description
event_id integer No Event id to bookmark for the user
event_ids list No Event ids to batch bookmark for the user
bookmark_list_id string No Bookmark list id to save the bookmark(s) to

Errors

No endpoint-specific errors