{"id":21192,"date":"2021-08-17T01:25:10","date_gmt":"2021-08-17T01:25:10","guid":{"rendered":"https:\/\/www.psoda.com\/help\/?page_id=21192"},"modified":"2024-06-04T20:44:57","modified_gmt":"2024-06-04T20:44:57","slug":"top-level","status":"publish","type":"page","link":"https:\/\/www.psoda.com\/help\/top-level\/","title":{"rendered":"Psoda API: Top level"},"content":{"rendered":"<div class='content-column three_fourth'><h3>Psoda API &#8211; \/rest_api\/v2\/objects.json<\/h3><p>This URI returns the details of the API user.<\/p><h3>Header: API-Key (mandatory)<\/h3><p>You must specify an API-Key to access any data from Psoda. You can find your API-Key by logging into Psoda with the user account you want to use for the API, navigate to &#8220;My stuff&#8221; and then click on the &#8220;API Code&#8221; button in the toolbar.<\/p><h3>Header: If-Modified-Since (optional)<\/h3><p>Use this header if you want to retrieve the object details only if it has been modified since the specified date. The date is in a text format, e.g. 15 Nov 1994 12:45:26 GMT<\/p><h3>Header: Accept-Language (optional)<\/h3><p>Use this header if you want to change the language for the user. The following languages are currently supported:<\/p><ul><li>af &#8211; Afrikaans<\/li><li>en &#8211; English<\/li><li>en-nz &#8211; English<\/li><li>en-uk &#8211; English<\/li><li>en-us &#8211; United States English<\/li><li>ja &#8211; Japanese<\/li><li>ru &#8211; Russian<\/li><li>zh-cn &#8211; Simplified Chinese<\/li><li>zh-hk &#8211; Simplified Chinese<\/li><li>zh-mo &#8211; Simplified Chinese<\/li><li>zh-sg &#8211; Simplified Chinese<\/li><li>zh-tw &#8211; Simplified Chinese<\/li><li>zh &#8211; Simplified Chinese<\/li><\/ul><h3>Parameter: lang (optional)<\/h3><p>Alternatively you can use this parameter to set the language.<\/p><h3>Format<\/h3><p>The extention on your path specifies the required format. For example https:\/\/www.psoda.com\/rest_api\/v2\/objects\/{object id}.json will returns the details of the object identified by {object id} in JSON format. If your extension is .html then a help page is returned instead.<\/p><p>Only .json and .html is currently supported. If no extension is specificied then the help page is returned as well.<\/p><h3>Parameter: fields (optional)<\/h3><p>You can use this parameter to limit which attributes are returned from the API call. You can specify multiple fields with commas separating them. If the field does not exist for the item then it will not be included in the result.<\/p><\/div>\r\n\r\n<div class='content-column one_fourth last_column'><h4>Related topics<\/h4>\r\n<ul>\r\n \t<li><a href=\"https:\/\/www.psoda.com\/help\/api-and-integration\/\">API integration home page<\/a><\/li>\r\n \t<li><a href=\"\/help\/list-of-descendants\">Listing descendants API call<\/a><\/li>\r\n \t<li><a href=\"\/help\/list-of-child-objects\">Listing child objects API call<\/a><\/li>\r\n \t<li><a href=\"\/help\/list-of-preferences\">List preferences API call<\/a><\/li>\r\n \t<li><a href=\"\/help\/details-of-a-specific-object\">Details of a specific object<\/a><\/li>\r\n\t<li><a href=\"\/help\/details-of-the-api-user\">Details of the API user<\/a><\/li>\r\n \t<li><a href=\"\/help\/psoda-api-classes\/\">List of available classes for the API<\/a><\/li>\r\n        <li><a href=\"\/help\/system-time-from-the-server\/\">Retrieve the time on the Psoda server<\/a><\/li>\r\n        <li><a href=\"\/help\/the-language-string\/\">Retrieve Psoda string by its ID and language<\/a><\/li>\r\n<\/ul><\/div><div class='clear_column'><\/div>","protected":false},"excerpt":{"rendered":"<p><div class='content-column three_fourth'><\/div>  Psoda API &#8211; \/rest_api\/v2\/objects.jsonThis URI returns the details of the API user.Header: API-Key (mandatory)You must specify an API-Key to access any data from Psoda. You can find your API-Key by logging into Psoda with the user account you want to use for the API, navigate to &#8220;My stuff&#8221; and then click on the<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":0,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"inline_featured_image":false,"footnotes":""},"class_list":["post-21192","page","type-page","status-publish","hentry"],"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v27.0 - https:\/\/yoast.com\/product\/yoast-seo-wordpress\/ -->\n<title>Psoda API: Top level - Psoda Help Centre<\/title>\n<meta name=\"description\" content=\"Read the documentation and learn how to use Psoda&#039;s Psoda API: Top level\" \/>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/www.psoda.com\/help\/top-level\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Psoda API: Top level - Psoda Help Centre\" \/>\n<meta property=\"og:description\" content=\"Read the documentation and learn how to use Psoda&#039;s Psoda API: Top level\" \/>\n<meta property=\"og:url\" content=\"https:\/\/www.psoda.com\/help\/top-level\/\" \/>\n<meta property=\"og:site_name\" content=\"Psoda Help Centre\" \/>\n<meta property=\"article:modified_time\" content=\"2024-06-04T20:44:57+00:00\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data1\" content=\"2 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/www.psoda.com\/help\/top-level\/\",\"url\":\"https:\/\/www.psoda.com\/help\/top-level\/\",\"name\":\"Psoda API: Top level - Psoda Help Centre\",\"isPartOf\":{\"@id\":\"https:\/\/www.psoda.com\/help\/#website\"},\"datePublished\":\"2021-08-17T01:25:10+00:00\",\"dateModified\":\"2024-06-04T20:44:57+00:00\",\"description\":\"Read the documentation and learn how to use Psoda's Psoda API: Top level\",\"breadcrumb\":{\"@id\":\"https:\/\/www.psoda.com\/help\/top-level\/#breadcrumb\"},\"inLanguage\":\"en-NZ\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/www.psoda.com\/help\/top-level\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/www.psoda.com\/help\/top-level\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/www.psoda.com\/help\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Psoda API: Top level\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/www.psoda.com\/help\/#website\",\"url\":\"https:\/\/www.psoda.com\/help\/\",\"name\":\"Psoda Help Centre\",\"description\":\"Information and support to help you use Psoda\",\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/www.psoda.com\/help\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-NZ\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Psoda API: Top level - Psoda Help Centre","description":"Read the documentation and learn how to use Psoda's Psoda API: Top level","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/www.psoda.com\/help\/top-level\/","og_locale":"en_US","og_type":"article","og_title":"Psoda API: Top level - Psoda Help Centre","og_description":"Read the documentation and learn how to use Psoda's Psoda API: Top level","og_url":"https:\/\/www.psoda.com\/help\/top-level\/","og_site_name":"Psoda Help Centre","article_modified_time":"2024-06-04T20:44:57+00:00","twitter_card":"summary_large_image","twitter_misc":{"Est. reading time":"2 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/www.psoda.com\/help\/top-level\/","url":"https:\/\/www.psoda.com\/help\/top-level\/","name":"Psoda API: Top level - Psoda Help Centre","isPartOf":{"@id":"https:\/\/www.psoda.com\/help\/#website"},"datePublished":"2021-08-17T01:25:10+00:00","dateModified":"2024-06-04T20:44:57+00:00","description":"Read the documentation and learn how to use Psoda's Psoda API: Top level","breadcrumb":{"@id":"https:\/\/www.psoda.com\/help\/top-level\/#breadcrumb"},"inLanguage":"en-NZ","potentialAction":[{"@type":"ReadAction","target":["https:\/\/www.psoda.com\/help\/top-level\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/www.psoda.com\/help\/top-level\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/www.psoda.com\/help\/"},{"@type":"ListItem","position":2,"name":"Psoda API: Top level"}]},{"@type":"WebSite","@id":"https:\/\/www.psoda.com\/help\/#website","url":"https:\/\/www.psoda.com\/help\/","name":"Psoda Help Centre","description":"Information and support to help you use Psoda","potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/www.psoda.com\/help\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-NZ"}]}},"_links":{"self":[{"href":"https:\/\/www.psoda.com\/help\/wp-json\/wp\/v2\/pages\/21192","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.psoda.com\/help\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/www.psoda.com\/help\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/www.psoda.com\/help\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.psoda.com\/help\/wp-json\/wp\/v2\/comments?post=21192"}],"version-history":[{"count":10,"href":"https:\/\/www.psoda.com\/help\/wp-json\/wp\/v2\/pages\/21192\/revisions"}],"predecessor-version":[{"id":24725,"href":"https:\/\/www.psoda.com\/help\/wp-json\/wp\/v2\/pages\/21192\/revisions\/24725"}],"wp:attachment":[{"href":"https:\/\/www.psoda.com\/help\/wp-json\/wp\/v2\/media?parent=21192"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}