Resources

The resources use a data model that is supported by a set of client-side libraries that are made available on the files and libraries page.

You may also enjoy the interactive interface provided for this API by Swagger.

Try it out!

name path methods description
AdminCrawledEvents
  • /admin/events-crawled
  • GET
This resource provide the methods to list crawled events as admin users.
AdminEventCreators
  • /admin/event-creator
  • GET POST
Created by ivo on 05/12/2017.
AdminEventCreatorsNew
  • /admin/event-creator-new
  • GET POST
Created by ivo on 05/12/2017.
AdminEventOtherProfiles
  • /admin/event-other-profile
  • GET POST
Created by ivo on 05/12/2017.
AdminEventPlaces
  • /admin/event-place
  • /admin/event-place/transform/{sequence}
  • /admin/event-place/{eventPlaceSequence}/additional-informations
  • GET POST
  • GET
  • GET
This resource provide the methods to search for Event Places and to create or update them as an internal user.
AdminEventTeamUsers
  • /admin/team-users/event/{eventSequence}
  • GET
AdminEvents
  • /admin/events-adm
  • /admin/events-adm/resend-payment-email
  • /admin/events-adm/{eventSequence}
  • /admin/events-adm/{sequence}
  • /admin/events-adm/{eventId}/transform
  • /admin/events-adm/{eventSequence}/add-admin
  • /admin/events-adm/{eventSequence}/remove-admin
  • /admin/events-adm/{sequence}/block-push-notifications
  • /admin/events-adm/{sequence}/duplicate
  • /admin/events-adm/{sequence}/event-creators
  • /admin/events-adm/{sequence}/modular
  • /admin/events-adm/{sequence}/other-profiles
  • /admin/events-adm/{sequence}/photos
  • /admin/events-adm/{sequence}/suspend
  • /admin/events-adm/{teamUserSequence}/change-user
  • GET POST
  • POST
  • DELETE PUT
  • GET
  • GET
  • POST
  • DELETE
  • PUT
  • POST
  • GET
  • GET
  • GET
  • GET
  • PUT
  • PUT
This resource provide the methods to manage events as admin users.
AdminEventsFinancialTransactions
  • /admin/events-financial-adm/update-texts
  • /admin/events-financial-adm/{eventSequence}/financial-info
  • /admin/events-financial-adm/{eventSequence}/financial-transactions
  • /admin/events-financial-adm/{financialTransactionSequence}/delete-bank-document
  • /admin/events-financial-adm/{financialTransactionSequence}/delete-receipt
  • /admin/events-financial-adm/{financialTransactionSequence}/upload-bank-document
  • /admin/events-financial-adm/{financialTransactionSequence}/upload-receipt
  • PUT
  • GET
  • GET POST
  • DELETE
  • DELETE
  • POST
  • POST
AdminGoinUsers
  • /admin/goin-users
  • /admin/goin-users/refund
  • /admin/goin-users/{userSequence}/owned-tickets
  • GET
  • POST
  • GET
AdminPartners
  • /admin/partner
  • /admin/partner/iban
  • /admin/partner/impression
  • /admin/partner/stats
  • /admin/partner/{id}
  • /admin/partner/{sequence}
  • /admin/partner/convert/{goinUserSequence}
  • /admin/partner/financial/{sequence}
  • /admin/partner/{partnerSequence}/event-lines
  • /admin/partner/{partnerSequence}/totals
  • /admin/partner/financial/{financialTransactionSequence}/upload-invoice
  • /admin/partner/financial/{financialTransactionSequence}/upload-receipt
  • /admin/partner/financial/{sequence}/delete-invoice
  • /admin/partner/financial/{sequence}/delete-receipt
  • GET POST
  • PUT
  • GET
  • GET
  • DELETE
  • GET
  • GET
  • GET POST
  • GET
  • GET
  • POST
  • POST
  • DELETE
  • DELETE
AdminPublicProfileCategories
  • /admin/categories
  • GET POST
Created by ivo on 05/12/2017.
AdminPublicProfiles
  • /admin/public-profile/{userSequence}
  • GET
AdminRefunds
  • /admin/events-refund-adm/{refundSequence}/upload-document
  • /admin/events-refund-adm/{sequence}/refunds
  • POST
  • GET
This resource provide the methods to manage events as admin users.
AdminTicketTransactions
  • /admin/transactions/all
  • /admin/transactions/{eventId}/all
  • GET
  • GET
Authentication
  • /authentication/activate-account-pin
  • /authentication/change-password
  • /authentication/check-pin
  • /authentication/check-pin-instagram
  • /authentication/login
  • /authentication/login-admin
  • /authentication/login-instagram
  • /authentication/login-social
  • /authentication/logout
  • /authentication/recover-password
  • /authentication/resend-activate-email
  • /authentication/reset-password
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • GET
  • POST
  • POST
  • POST
This resource provide the necessary methods for user activation, authentication and account recovery.
It also allows any user to invalidate the session.
BlockchainAdminResource
  • /admin/bc/add-tokens
  • /admin/bc/{userId}/info
  • POST
  • GET
BlockchainResource
  • /bc/add-tokens
  • /bc/default-device
  • /bc/history
  • /bc/identifiers
  • /bc/info
  • POST
  • PUT
  • GET
  • GET
  • GET
BusinessPlans
  • /business-plan/all
  • /business-plan/private
  • /business-plan/public
  • /business-plan/{businessPlanOptionId}/payment-information
  • GET
  • GET
  • GET
  • GET
This resource provides the methods to list all the business plans available in the system
Carts
  • /cart
  • /cart/change-invoicing-email
  • /cart/checkout
  • /cart/generate-mb-reference
  • /cart/generate-mbway-reference
  • /cart/jose-lucio
  • /cart/purchase-free
  • /cart/{cartItemSequence}
  • GET POST
  • PUT
  • POST
  • GET
  • POST
  • POST
  • POST
  • DELETE GET PUT
This resource provide the methods a given user his cart and update it, by adding and removing items. It also allows the checkout of the cart and the generation of the mb references.
EchoApi
  • /try-me
  • /try-me/error-codes
  • /try-me/nif
  • /try-me/phc-resend
  • /try-me/public-profile-photos
  • /try-me/who-iam
  • GET
  • GET
  • GET
  • GET
  • POST
  • GET
This resource provide the methods needed to test if the api is up and to test the usage of the auth-token on a endpoint only accessible to a logged user.
This Resource is for testing only
EventFees
  • /admin/event-fees/{eventId}
  • GET POST
EventFilters
  • /events-filters
  • /events-filters/{sequence}
  • /events-filters/my/{filter-type}
  • POST
  • DELETE PUT
  • GET
This resource provide the methods to register, list and view profile from Goin Users.
EventGuestListUsers
  • /event-guest-list-users/previous
  • /event-guest-list-users/{guestListUserSequence}
  • /event-guest-list-users/event/{eventSequence}
  • /event-guest-list-users/{guestListUserSequence}/offer-more-tickets
  • /event-guest-list-users/event/{eventSequence}/add-email
  • /event-guest-list-users/event/{eventSequence}/add-user
  • /event-guest-list-users/event/{eventSequence}/confirm
  • /event-guest-list-users/event/{eventSequence}/decline
  • GET
  • DELETE
  • GET
  • PUT
  • POST
  • POST
  • GET
  • GET
This resource provide the methods to list and management events' guest lists.
EventOtherProfiles
  • /event-other-profile
  • GET
Created by ivo on 05/12/2017.
EventPlaces
  • /event-place
  • /event-place/near-me
  • /event-place/popular
  • /event-place/suggested
  • /event-place/{eventPlaceSequence}
  • /event-place/details-photo/{imageId}
  • /event-place/photo/{imageId}
  • /event-place/website-photo/{imageId}
  • /event-place/{eventPlaceSequence}/additional-info
  • GET POST
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
This resource provide the methods to search for Event Places.
EventReports
  • /event-reports/{sequence}/activity
  • /event-reports/{sequence}/graph-checked-in
  • /event-reports/{sequence}/graph-event-share
  • /event-reports/{sequence}/graph-favorites
  • /event-reports/{sequence}/graph-goin
  • /event-reports/{sequence}/graph-private
  • /event-reports/{sequence}/graph-tickets
  • /event-reports/{sequence}/graph-views
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
This resource provide the methods to view event reports.
EventTeamUsers
  • /event-team-users/previous
  • /event-team-users/{teamUserSequence}
  • /event-team-users/event/{eventSequence}
  • /event-team-users/whoami/{eventSequence}
  • /event-team-users/event/{eventSequence}/add-user
  • /event-team-users/event/{eventSequence}/confirm
  • GET
  • DELETE
  • GET
  • GET
  • POST
  • GET
This resource provide the methods to list and manage events' teams.
EventTickets
  • /tickets
  • /tickets/check-in
  • /tickets/check-in-sms
  • /tickets/history
  • /tickets/purchased
  • /tickets/refund
  • /tickets/tickets-history
  • /tickets/{eventSequenceId}
  • /tickets/admin/{eventSequenceId}
  • /tickets/get-ticket/{eventTicketSequence}
  • /tickets/{eventSequence}/create-ticket
  • /tickets/{eventSequence}/edit-ticket
  • /tickets/{eventTicketSequence}/buyers
  • /tickets/{eventTicketSequence}/check-code
  • /tickets/{eventTicketSequence}/total-offered
  • /tickets/{purchaseEventTransactionId}/resend-invoice
  • /tickets/{purchasedEventTicketSequence}/my-qrcode
  • /tickets/{sequence}/offer-sms
  • /tickets/{sequence}/resend-offer-sms
  • /tickets/history/{transactionSequence}/tickets
  • /tickets/{eventSequence}/delete-ticket/{eventTicketSequence}
  • /tickets/{eventSequence}/tickets/{userSequence}
  • /tickets/{purchasedEventTicketSequence}/qrcode/{imageId}
  • /tickets/{purchasedEventTicketSequence}/ticket-owner-qrcode/{imageId}
  • /tickets/{sequence}/offer-email/{futureUserEmail}
  • /tickets/{sequence}/offer-in-app/accept
  • /tickets/{sequence}/offer-in-app/decline
  • /tickets/{sequence}/offer-in-app/{userSequence}
  • GET
  • POST
  • POST
  • GET
  • GET
  • POST
  • GET
  • GET
  • GET
  • GET
  • POST
  • POST
  • POST
  • POST
  • GET
  • GET
  • GET
  • POST
  • GET
  • GET
  • DELETE
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
This resource provide the methods to list an event tickets' information.
EventTicketsGiveaways
  • /ticket-giveaways
  • GET
This resource provide the methods to list event tickets giveaways.
EventTicketsPromotions
  • /ticket-promotions
  • GET
This resource provide the methods to list event tickets in promotion.
Events
  • /events/categories
  • /events/checked-in
  • /events/created
  • /events/fast-filter
  • /events/goin
  • /events/invited
  • /events/my
  • /events/near-me
  • /events/popular
  • /events/private
  • /events/promotions
  • /events/public
  • /events/public-64
  • /events/search
  • /events/suggested
  • /events/unpaid
  • /events/{sequence}
  • /events/associated/{publicProfileSequence}
  • /events/category/{categorySequence}
  • /events/checked-in/{username}
  • /events/created/{username}
  • /events/details/{imageId}
  • /events/goin/{username}
  • /events/list/{imageId}
  • /events/map/{imageId}
  • /events/options/{imageId}
  • /events/private/{eventSequence}
  • /events/promotions/{imageId}
  • /events/public/{eventSequence}
  • /events/public-profile/{publicProfileSequence}
  • /events/qrcode/{imageId}
  • /events/similar-category/{eventSequence}
  • /events/similar-creator/{eventSequence}
  • /events/similar-location/{eventSequence}
  • /events/similar-profiles/{eventSequence}
  • /events/stats/{eventSequence}
  • /events/tickets-map/{imageId}
  • /events/{eventId}/add-promotional-code
  • /events/{eventId}/edit-promotional-code
  • /events/{eventId}/promotions
  • /events/{eventId}/{promotionalCodeId}
  • /events/{eventSequence}/analytics
  • /events/{eventSequence}/attending
  • /events/{eventSequence}/financial-info
  • /events/{eventSequence}/has-sold-tickets
  • /events/{eventSequence}/scanner-statistics
  • /events/{eventSequence}/terms-and-conditions
  • /events/{eventSequence}/tickets-map
  • /events/{sequence}/additional-info
  • /events/{sequence}/associated-profiles
  • /events/{sequence}/modular
  • /events/{sequence}/photos
  • /events/{sequence}/place-additional-info
  • /events/{sequence}/push-notifications
  • /events/{sequence}/send-push
  • GET
  • GET
  • GET
  • POST
  • GET
  • GET
  • GET
  • GET
  • GET
  • POST
  • GET
  • POST
  • POST
  • GET
  • GET
  • GET
  • DELETE GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • PUT
  • GET
  • PUT
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • POST
  • POST
  • GET
  • DELETE
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET PUT
  • DELETE GET POST
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • POST
This resource provide the methods to register, list and view profile from Goin Users.
FavoriteEvents
  • /favorites
  • /favorites/{eventSequence}
  • /favorites/others/{userSequence}
  • GET
  • DELETE GET
  • GET
This resource provide the methods to list and manage the users favorites list.
GoinUsers
  • /goin-users
  • /goin-users/billing-info
  • /goin-users/cover-photo
  • /goin-users/deactivate-my-account
  • /goin-users/delete-my-profile
  • /goin-users/fetch-profile
  • /goin-users/fetch-profile-as-zip
  • /goin-users/gdpr
  • /goin-users/notifications
  • /goin-users/phone
  • /goin-users/profile
  • /goin-users/profile-photo
  • /goin-users/register
  • /goin-users/register-social
  • /goin-users/tickets-sales-info
  • /goin-users/update-gdpr
  • /goin-users/{sequence}
  • /goin-users/public/cover-photo/{imageId}
  • /goin-users/public/my/qr-code-url
  • /goin-users/public/my/urls
  • /goin-users/public/profile/{username}
  • /goin-users/public/profile-photo/{imageId}
  • /goin-users/public/user-profile/{userSequence}
  • /goin-users/public/{userSequence}/urls
  • GET
  • GET PUT
  • GET
  • GET
  • DELETE
  • GET
  • GET
  • GET
  • GET PUT
  • POST PUT
  • GET PUT
  • GET
  • POST
  • POST
  • GET PUT
  • PUT
  • GET
  • GET
  • GET
  • GET PUT
  • GET
  • GET
  • GET
  • GET
This resource provide the methods to:
-register a user;
-register a user via a social network (Facebook, Instagram, Google+, Twitter);
-view the logged user's profile;
-view a user's public profile;
-get a logged user's profile photo
-get a logged user's cover photo
-get a given user's profile photo
-get a given user's cover photo
-get a logged user's billing info
-update a logged user's billing info
Notifications
  • /notifications
  • /notifications/public-profile
  • GET
  • GET
This resource provide the methods to list the users and public profiles' notifications list.
PaymentMethods
  • /payment-methods/credit-card
  • /payment-methods/credit-card/{cardId}
  • GET POST
  • DELETE PUT
This resource provide the methods to list and manage the user's stripe credit cards.
PublicProfileCategories
  • /public-profile-category
  • /public-profile-category/photo/{imageId}
  • GET
  • GET
This resource provides a method to list all the public profile categories existing in the API.
The public profile category - PublicProfileCategory - is needed to fill the user public profile information
PublicProfileTypes
  • /public-profile-type
  • GET
This resource provides a method to list all the public profile types existing in the API.
The public profile type - PublicProfileType - is needed to fill the user public profile information
PublicProfiles
  • /public-profile
  • /public-profile/activate-public-profile-pin
  • /public-profile/check-pin
  • /public-profile/cover-photo
  • /public-profile/event-creator
  • /public-profile/fetch-facebook
  • /public-profile/my
  • /public-profile/notifications
  • /public-profile/other-profiles
  • /public-profile/popular
  • /public-profile/profile-photo
  • /public-profile/recent
  • /public-profile/resend-activate-email
  • /public-profile/suggest
  • /public-profile/suggested
  • /public-profile/{publicProfileSequence}
  • /public-profile/change-user/{profileSequence}
  • /public-profile/public/cover-photo/{imageId}
  • /public-profile/public/profile-photo/{imageId}
  • /public-profile/public/website-cover-photo/{imageId}
  • GET POST
  • POST
  • POST
  • GET
  • GET
  • GET
  • GET
  • GET PUT
  • GET
  • GET
  • GET
  • GET
  • GET
  • POST
  • GET
  • GET
  • PUT
  • GET
  • GET
  • GET
This resource allows the user to interact with its public profile.
It contains the methods needed to:
- get the logged user public profile;
- fetch public profile info from Facebook (used to pre-fill information while creating a Public Profile);
- createOrUpdate a public profile and receive an email to activate that profile;
- check a given pin
- activate a public profile using a pin
- resend the activation email sent for a public profile
PushDevices
  • /mobile-notifications/register
  • /mobile-notifications/revoke
  • POST
  • POST
SeatsResource
  • /seats/import
  • /seats/merged
  • GET
  • GET
Sequência de utilização: Solicitar a lista das sessões disponíveis e depois os dados de cada uma das sessões -> importSession Reservar os lugares pretendidos Dar ordem de venda dos lugares reservados
SibsResource
  • /sibs/callback
  • POST
SlotMachines
  • /slot-machine/next-play/{eventTicketSequence}
  • /slot-machine/play/{eventTicketSequence}
  • GET
  • GET
This resource provide the methods to list event tickets giveaways.
SocialService
  • /social-network/follow-multiple
  • /social-network/multiple-friend-request
  • /social-network/accept-friend/{friend-sequence}
  • /social-network/check-in/{eventSequence}
  • /social-network/decline-friend/{friend-sequence}
  • /social-network/follow/{username}
  • /social-network/followed-by/my
  • /social-network/followed-by/{userSequence}
  • /social-network/followers/my
  • /social-network/followers/{userSequence}
  • /social-network/follows/my
  • /social-network/follows/{userSequence}
  • /social-network/friend-request/{friend-username}
  • /social-network/friends/my
  • /social-network/friends/{userSequence}
  • /social-network/friends-that-follow/{userSequence}
  • /social-network/goin/{eventSequence}
  • /social-network/goin-users/{eventSequence}
  • /social-network/not-check-in/{eventSequence}
  • /social-network/not-goin/{eventSequence}
  • /social-network/not-private-mode/{eventSequence}
  • /social-network/private-mode/{eventSequence}
  • /social-network/rate/{profileSequence}
  • /social-network/rate/{username}
  • /social-network/share/{eventSequence}
  • /social-network/subscribe/{eventId}
  • /social-network/unfollow/{username}
  • /social-network/unfriend/{friend-username}
  • /social-network/event/{eventSequence}/social-counter
  • /social-network/public-profile/friends-that-follow/{publicProfileSequence}
  • /social-network/rate/average/{profileSequence}
  • /social-network/{event_sequence}/accept-event/{event_invitee_username}
  • /social-network/{event_sequence}/decline-event/{event_invitee_username}
  • /social-network/{event_sequence}/event-request/{event_invitee_username}
  • POST
  • POST
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • POST
  • POST
  • POST
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
This resource provides the methods needed to list and manage a user's list of friends and list of followed public profiles.
It also allows public profiles to see their followers
Taxes
  • /taxes/exemption-reasons
  • /taxes/{eventId}
  • GET
  • GET
This resource provides the latest taxes/service fees values.
TermsAndConditions
  • /terms
  • GET
This resource provide the method needed to see the terms and conditions of GOIN