What is the Admin query and what information I can expect to receive?

The main purpose of the Admin query is to return a summarized view of all the details related with your account.

Some of the information you will be able to retrieve through the Admin query is:

  • Client names and codes
  • Linked accesses and whether they are active or not, details about the access (credentials, parameters...), context associated with the access, whether they are test or not...
  • Linked Sellers
  • Linked profiles
  • Linked products

You will be able to personalize the Admin query in order to receive only the information of your interest. Below you will find an example where only the information about the client names and accesses is returned:

{"query":"{\n admin {\n\t\tclients{\n\t\t\tedges{\n\t\t\t\tnode{\n\t\t\t\t\tcode\n\t\t\t\t\tclientData{\n\t\t\t\t\t\tcode\n\t\t\t\t\t\tname\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n accesses {\n edges {\n \n node {\n code\n accessData{\n code\n user\n password\n isActive\n isTest\n urls{\n search\n quote\n book\n generic\n }\n parameters{\n key\n value\n }\n markets\n rateRules\n shared {\n code\n }\n owner{\n code\n \n }\n supplier{\n code\n\t\t\t\t\t\tsupplierData{\n\t\t\t\t\t\t\tcontext\n\t\t\t\t\t\t}\n }\n\t\t\t\t\tname\n }\n error {\n code\n type\n description\n }\n createdAt\n updatedAt\n }\n }\n }\n }\n}\n"}

You will find more information on our Playground in the DOCS tab.