Describe API

[azhurat]

Documentation mentions describe for a particular entity. I've found a hidden(can't find it in the docs) endpoint that lists all entities - GET https://apisandbox.zuora.com/apps/api/describe. Will this endpoint be maintainable(public) in the future so that I can use it?

Thanks,

Artur

[Dennis]

Hi @azhurat

The link shows full list objects are documented in below article.

https://knowledgecenter.zuora.com/DC_Developers/SOAP_API/M_Zuora_Object_Query_Language/Export_ZOQL

It is not maintainable by customers. What is the use case of this?

You can check it anytime with the above link.

Thanks.

Dennis

[azhurat]

Hi @Dennis

Actually the list returned from GET https://apisandbox.zuora.com/apps/api/describe differs from that from the https://knowledgecenter.zuora.com/DC_Developers/SOAP_API/M_Zuora_Object_Query_Language/Export_ZOQL (for example CommunicationProfile entity is missed in the doc). If I correctly understand the documentation - each customer has its own list of entities returned by /describe (depending on zuora edition, for example https://knowledgecenter.zuora.com/DC_Developers/SOAP_API/E1_SOAP_API_Object_Reference/Feature is not enabled in all editions). 

I need to get the full entity list per zuora customer(dynamically, having only customer creds) and it seems like /describe endpoint is what I need, I just want to make sure that this endpoint will be accessible in the future as it is not mentioned in the documentation.

[Dennis · Accepted solution]

Hi @azhurat,

Yes, you are right. The endpoint https://apisandbox.zuora.com/apps/api/describe is the correct one you can refer to. It is always accessible to customers.

Regards,

Dennis