Rest API in Mautic 5 delivers empty result array but no error

mcdiver · January 21, 2024, 7:55pm

Hey Guys,

MyMautic: 5.0.2 (VPS)
MyPHP Server: 8.1
MyPHP local 8.2.

I am using a php script to retrieve a mail with the Rest API. The code worked fine with Mautic 4.x. However, I am trying to use it on my Mautic 5.0.2 and unfortunately all I get as result is an empty email array

Are there known issues with the Rest API in Mautic 5? Or did I miss something, which I need to consider now in contrast to Mautic 4?

Thank you in advance for your help.

Kind regards,

mzagmajster · January 22, 2024, 8:27am

Maybe there is no records?

What request are you issuing to the server?

mcdiver · January 23, 2024, 6:22am

Yeah, that is generally a good idea to check. Unfortunately, I tried mails and users without succes, both arrays are empty even though there are some entries in the database.

Is there anybody who already uses the API with PHP in Mautic 5? (I am pretty sure, I miss something but I am confused since my code is working fine with Mautic 4 but not with Mautic 5)

mzagmajster · January 23, 2024, 10:19am

Can you paste the exact endpoint/url you are calling and request you are sending on that endpoint?

steffenabel · January 24, 2024, 8:29pm

I’m having the same issue after upgrading to Mautic 5 from Mautic 4.
A quickfix for the moment is to disable setting of the serializer groups in Line 679 of app/bundles/ApiBundle/Controller/FetchCommonApiController.php. I just commented out this single line here. Now the returned entities are pretty large but it is a quickfix that works for me at the moment.

        if (!empty($this->serializerGroups)) {
//            $context->setGroups($this->serializerGroups);
        }

Would highly appreciate a hint to a complete fix. I don’t understand where the relation between serializer group and fields that should be serialized is defined as I didn’t find any annotations on the entities.

mzagmajster · January 24, 2024, 9:14pm

There is a method in Entity\Lead.php that sets groups for this serializer.

github.com

mautic/mautic/blob/3be38f31b6b5d8d8c7e1feff30dd4d388619ff70/app/bundles/LeadBundle/Entity/Lead.php#L427


      
                      'timezone',
                      'country',
                  ],
                  FieldModel::$coreFields
              );
          }
          
          /**
           * Prepares the metadata for API usage.
           */
          public static function loadApiMetadata(ApiMetadataDriver $metadata): void
          {
              $metadata->setRoot('lead')
                  ->setGroupPrefix('leadBasic')
                  ->addListProperties(
                      [
                          'id',
                          'points',
                          'color',
                          'title',
                          'firstname',

steffenabel · January 24, 2024, 9:25pm

I didn’t have time to look into it further, but could the issue occur due to the missing leadBasic serializerGroup in LeadApiController?

github.com

mautic/mautic/blob/3be38f31b6b5d8d8c7e1feff30dd4d388619ff70/app/bundles/LeadBundle/Controller/Api/LeadApiController.php#L81


      
              MauticFactory $factory
          ) {
              $this->doNotContactModel = $doNotContactModel;
          
              $leadModel = $modelFactory->getModel(self::MODEL_ID);
              \assert($leadModel instanceof LeadModel);
              $this->model            = $leadModel;
              $this->entityClass      = Lead::class;
              $this->entityNameOne    = 'contact';
              $this->entityNameMulti  = 'contacts';
              $this->serializerGroups = ['leadDetails', 'frequencyRulesList', 'doNotContactList', 'userList', 'stageList', 'publishDetails', 'ipAddress', 'tagList', 'utmtagsList'];
          
              parent::__construct($security, $translator, $entityResultHelper, $router, $formFactory, $appVersion, $requestStack, $doctrine, $modelFactory, $dispatcher, $coreParametersHelper, $factory);
          
              $this->setCleaningRules();
          }
          
          /**
           * Obtains a list of users for lead owner edits.
           *
           * @return \Symfony\Component\HttpFoundation\Response

Topic		Replies	Views
API not returning data Mautic 5 Install/Upgrade Support	1	243	January 27, 2024
Regarding Mautic api issue Development	9	344	August 1, 2023
Get contacts by emails /api/contacts Product Support mautic-3	0	787	July 13, 2022
Thrive Leads - API Connection - Empty Mailing Lists Product Support	7	728	November 25, 2017
Not able to fetch contacts listing by API calling Development	1	785	June 13, 2018

Rest API in Mautic 5 delivers empty result array but no error

Related topics