GET Project API
    GET Project API
    • Basic Information
    • Projects
      • Projects_GetAll
        GET
    • ProjectSites
      • ProjectSites_GetAll
        GET
      • ProjectSites_CreateOrUpdate
        PUT
    • ProjectTags
      • ProjectTags_GetTagOverview
        GET
      • ProjectTags_GetTransactionsForTag
        GET
      • ProjectTags_PayoutTag
        PUT
    • ProjectTagAssignments
      • ProjectTagAssignments_GetAll
        GET
    • ProjectTickets
      • ProjectTickets_GetAll
        GET
      • ProjectTickets_CreateOrUpdate
        POST
      • ProjectTickets_GetById
        GET
      • ProjectTickets_GetByBarcode
        GET
    • ProjectTransactions
      • ProjectTransactions_GetAll
        GET
      • ProjectTransactions_GetById
        GET
    • ProjectAreas
      • ProjectAreas_GetAll
        GET
      • ProjectAreas_GetById
        GET
      • ProjectAreas_CreateOrUpdate
        PUT
      • ProjectAreas_Delete
        DELETE
    • ProjectFields
      • ProjectFields_GetAll
        GET
      • ProjectFields_GetById
        GET
      • ProjectFields_CreateFieldConfig
        POST
      • ProjectFields_UpdateFieldConfig
        PUT
    • ProjectProductLists
      • ProjectProductLists_GetAll
    • ProjectProductListProducts
      • ProjectProductListProducts_GetAll
      • ProjectProductListProducts_GetByExternalId
      • ProjectProductListProducts_CreateOrUpdateProduct
      • ProjectProductListProducts_Delete
      • ProjectProductListProducts_CreateOrUpdateProductVariant
      • ProjectProductListProducts_DeleteVariant
      • ProjectProductListProducts_SetDefaultVariant
    • ProjectTaxRates
      • ProjectTaxRates_GetAll
    • ProjectTagBlacklists
      • ProjectTagBlacklists_GetAll
      • ProjectTagBlacklists_GetTagSessionEntries
      • ProjectTagBlacklists_UpdateBlackListForTag
    • ProjectAccountingCategory
      • ProjectAccountingCategory_GetAll
      • ProjectAccountingCategory_GetById
    • ProjectTagChange
      • ProjectTagChange_Create
      • ProjectTagChange_Get
      • ProjectTagChange_GetAll
      • ProjectTagChange_Cancel
    • ProjectTagChangeViaTicket
      • ProjectTagChangeViaTicket_Create
      • ProjectTagChangeViaTicket_Get
      • ProjectTagChangeViaTicket_GetAll
    • ProjectWorkTimeStamps
      • ProjectWorkTimeStamps_GetAll
      • ProjectWorkTimeStamps_GetById
    • ProjectWorkTimes
      • ProjectWorkTimes_GetAll
      • ProjectWorkTimes_GetById
    • ProjectTicketValidations
      • ProjectTicketValidations_GetAll
      • ProjectTicketValidations_GetByTicketId
      • ProjectTicketValidations_GetByBarcode
    • ProjectUnits
      • ProjectUnits_GetAll
      • ProjectUnits_GetById
    • ProjectCompanies
      • ProjectCompanies_GetAll
      • ProjectCompanies_GetById
    • ProjectTagStates
      • ProjectTagStates_GetAll
      • ProjectTagStates_GetAllForTag
      • ProjectTagStates_GetForTagAndSessionCounter
    • Schemas
      • ArrayResultOfProjectModel
      • ProjectModel
      • ArrayResultOfSiteModel
      • SiteModel
      • TransactionCompanyModel
      • ExternalSiteModel
      • SiteStatusEnumModel
      • ExternalSiteTypeModel
      • Void
      • ExternalSiteTicketTypeLabelModel
      • SiteConfigNotReadyErrorType
      • ValueType
      • ExternalSiteTicketTypeLabelGroupModel
      • TagOverviewModel
      • ArrayResultOfTransactionModel
      • TransactionModel
      • TransactionOperatorModel
      • TransactionStatusEnumModel
      • TransactionTypeEnumModel
      • AccessCheckModel
      • AccreditationModel
      • WorkerGroupTypesEnum
      • TransactionTicketValidationModel
      • FinanceModel
      • TransactionItemTypeEnumModel
      • PaymentModel
      • ExternalPayoutArgsModel
      • ArrayResultOfTagAssignmentModel
      • TagAssignmentModel
      • TagAssignmentTypeEnumModel
      • TagAssignmentStatusEnumModel
      • GenderTypeEnum
      • ArrayResultOfTicketModel
      • TicketModel
      • ExternalTicketModelGenderTypeEnum
      • ExternalTicketModel
      • ArrayResultOfAreaModel
      • AreaModel
      • AreaCountedWorkerTypeEnum
      • ExternalAreaModel
      • ArrayResultOfFieldModel
      • FieldModel
      • ExternalFieldsTypeEnum
      • ExternalCreateFieldConfigModel
      • ExternalUpdateFieldConfigModel
      • ArrayResultOfProductListModel
      • ProductListModel
      • ArrayResultOfProductsModel
      • ProductsModel
      • ProductTypeEnum
      • ProductVariantModel
      • ExternalProductModel
      • ExternalDefaultProductVariantModel
      • ExternalProductVariantModel
      • ExternalSetDefaultVariantModel
      • ArrayResultOfTaxRatesModel
      • TaxRatesModel
      • ArrayResultOfTagBlacklistModel
      • TagBlacklistModel
      • ExternalTagBlacklistModel
      • ArrayResultOfAccountingCategoryModel
      • AccountingCategoryModel
      • ExternalTagChangeModel
      • ExternalChangeReferenceModel
      • ExternalChangeItemModel
      • ArrayResultOfExternalApiTagChangeInfoModel
      • ExternalApiTagChangeInfoModel
      • ExternalApiChangeInfoStatusEnumModel
      • ExternalApiChangeItemInfoModel
      • ExternalApiChangeItemChangeInfoModel
      • ExternalTicketChangeModel
      • ArrayResultOfExternalApiTicketChangeInfoModel
      • ExternalApiTicketChangeInfoModel
      • ExternalApiTicketChangeItemInfoModel
      • ExternalApiTicketChangeItemChangeInfoModel
      • ExternalApiTicketChangeItemApplyInfoModel
      • ExternalApiTicketChangeItemChangeResultInfoModel
      • ArrayResultOfWorkTimeStampModel
      • WorkTimeStampModel
      • WorkTimeStampTypeEnumModel
      • ArrayResultOfWorkTimeModel
      • WorkTimeModel
      • ArrayResultOfTicketValidationModel
      • TicketValidationModel
      • ArrayResultOfUnitModel
      • UnitModel
      • ArrayResultOfCompanyModel
      • CompanyModel
      • ArrayResultOfCurrentTagStateModel
      • CurrentTagStateModel
      • PublicTagStateModel
      • TagSystemFlagsModel
      • ProjectFieldsModel
      • FlagValueField
      • CounterValueField
      • Utf8StringValueField

    Basic Information

    Introduction#

    The GET Project API allows you to retrieve various types of data, such as transactions or tickets, from our system. It is a Server-to-Server API primarily used for data synchronization. Additionally, it supports modifying project configurations and sending Online Deliveries to a chip (e.g., topping up or making adjustments on the chip).

    Authorization#

    Prefix
    Important: It is necessary to prefix the provided API key with "Bearer". The API key needs to be included in a header parameter called Authorization.
    Example: Authorization: Baerer <API key>

    Example use cases#

    Pulling all transaction data: ProjectTransactions_GetAll
    Pushing ticketing data: ProjectTickets_CreateOrUpdate
    Required fields:
    barcode
    ticketTypeId or ticketTypeAlias
    unitId
    externalId
    sourceName
    Pulling all ticketing data: ProjectTickets_GetAll
    Changing data on chips (tags): ProjectTagChange_Create
    Pushing product data: ProjectProductListProducts_GetAll
    Pulling data for specific ticket (e.g. linked chip): ProjectTagAssignments_GetAll
    Modified at 2025-05-28 11:22:58
    Next
    Projects_GetAll
    Built with