{"id":16975,"date":"2020-10-20T13:16:49","date_gmt":"2020-10-20T00:16:49","guid":{"rendered":"http:\/\/help.psoda.com\/?page_id=16975"},"modified":"2024-06-04T20:45:39","modified_gmt":"2024-06-04T20:45:39","slug":"details-of-the-api-user","status":"publish","type":"page","link":"https:\/\/www.psoda.com\/help\/details-of-the-api-user\/","title":{"rendered":"Psoda API: Details of the API user"},"content":{"rendered":"<div class='content-column three_fourth'><h3>Psoda API &#8211; \/rest_api\/v2\/objects.json<\/h3>\r\nThis URI returns the details of the API user.\r\n<h3>Header: API-Key (mandatory)<\/h3>\r\nYou 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 top header area.\r\n<h3>Header: If-Modified-Since (optional)<\/h3>\r\nUse 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\r\n<h3>Header: Accept-Language (optional)<\/h3>\r\nUse this header if you want to change the language for the user. The following languages are currently supported:\r\n<ul>\r\n \t<li>af &#8211; Afrikaans<\/li>\r\n \t<li>en &#8211; English<\/li>\r\n \t<li>en-nz &#8211; English<\/li>\r\n \t<li>en-uk &#8211; English<\/li>\r\n \t<li>en-us &#8211; United States English<\/li>\r\n \t<li>ja &#8211; Japanese<\/li>\r\n \t<li>ru &#8211; Russian<\/li>\r\n \t<li>zh-cn &#8211; Simplified Chinese<\/li>\r\n \t<li>zh-hk &#8211; Simplified Chinese<\/li>\r\n \t<li>zh-mo &#8211; Simplified Chinese<\/li>\r\n \t<li>zh-sg &#8211; Simplified Chinese<\/li>\r\n \t<li>zh-tw &#8211; Simplified Chinese<\/li>\r\n \t<li>zh &#8211; Simplified Chinese<\/li>\r\n<\/ul>\r\n<h3>Parameter: lang (optional)<\/h3>\r\nAlternatively you can use this parameter to set the language.\r\n<h3>Format<\/h3>\r\nThe 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.\r\n\r\nOnly .json and .html is currently supported. If no extension is specificied then the help page is returned as well.\r\n<h3>Parameter: fields (optional)<\/h3>\r\nYou 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.\r\n<br><\/div>\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        <li><a href=\"\/help\/top-level\/\">API top level<\/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\/psoda-api-next-page\">Psoda API next page 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\/psoda-api-classes\/\">List of available classes for the API<\/a><\/li>\r\n \t<li><a href=\"\/help\/list-of-preferences\">List preferences API call<\/a><\/li>\r\n        <li><a href=\"\/help\/the-language-string\/\">Retrieve Psoda string by its ID and language<\/a><\/li>\r\n        <li><a href=\"\/help\/system-time-from-the-server\/\">Retrieve the time on the Psoda server<\/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.json  This 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<\/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-16975","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: Details of the API user - Psoda Help Centre<\/title>\n<meta name=\"description\" content=\"Read the documentation and learn how to use Psoda&#039;s Psoda API: Details of the API user\" \/>\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\/details-of-the-api-user\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Psoda API: Details of the API user - Psoda Help Centre\" \/>\n<meta property=\"og:description\" content=\"Read the documentation and learn how to use Psoda&#039;s Psoda API: Details of the API user\" \/>\n<meta property=\"og:url\" content=\"https:\/\/www.psoda.com\/help\/details-of-the-api-user\/\" \/>\n<meta property=\"og:site_name\" content=\"Psoda Help Centre\" \/>\n<meta property=\"article:modified_time\" content=\"2024-06-04T20:45:39+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\/details-of-the-api-user\/\",\"url\":\"https:\/\/www.psoda.com\/help\/details-of-the-api-user\/\",\"name\":\"Psoda API: Details of the API user - Psoda Help Centre\",\"isPartOf\":{\"@id\":\"https:\/\/www.psoda.com\/help\/#website\"},\"datePublished\":\"2020-10-20T00:16:49+00:00\",\"dateModified\":\"2024-06-04T20:45:39+00:00\",\"description\":\"Read the documentation and learn how to use Psoda's Psoda API: Details of the API user\",\"breadcrumb\":{\"@id\":\"https:\/\/www.psoda.com\/help\/details-of-the-api-user\/#breadcrumb\"},\"inLanguage\":\"en-NZ\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/www.psoda.com\/help\/details-of-the-api-user\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/www.psoda.com\/help\/details-of-the-api-user\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/www.psoda.com\/help\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Psoda API: Details of the API user\"}]},{\"@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: Details of the API user - Psoda Help Centre","description":"Read the documentation and learn how to use Psoda's Psoda API: Details of the API user","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\/details-of-the-api-user\/","og_locale":"en_US","og_type":"article","og_title":"Psoda API: Details of the API user - Psoda Help Centre","og_description":"Read the documentation and learn how to use Psoda's Psoda API: Details of the API user","og_url":"https:\/\/www.psoda.com\/help\/details-of-the-api-user\/","og_site_name":"Psoda Help Centre","article_modified_time":"2024-06-04T20:45:39+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\/details-of-the-api-user\/","url":"https:\/\/www.psoda.com\/help\/details-of-the-api-user\/","name":"Psoda API: Details of the API user - Psoda Help Centre","isPartOf":{"@id":"https:\/\/www.psoda.com\/help\/#website"},"datePublished":"2020-10-20T00:16:49+00:00","dateModified":"2024-06-04T20:45:39+00:00","description":"Read the documentation and learn how to use Psoda's Psoda API: Details of the API user","breadcrumb":{"@id":"https:\/\/www.psoda.com\/help\/details-of-the-api-user\/#breadcrumb"},"inLanguage":"en-NZ","potentialAction":[{"@type":"ReadAction","target":["https:\/\/www.psoda.com\/help\/details-of-the-api-user\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/www.psoda.com\/help\/details-of-the-api-user\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/www.psoda.com\/help\/"},{"@type":"ListItem","position":2,"name":"Psoda API: Details of the API user"}]},{"@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\/16975","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=16975"}],"version-history":[{"count":12,"href":"https:\/\/www.psoda.com\/help\/wp-json\/wp\/v2\/pages\/16975\/revisions"}],"predecessor-version":[{"id":24623,"href":"https:\/\/www.psoda.com\/help\/wp-json\/wp\/v2\/pages\/16975\/revisions\/24623"}],"wp:attachment":[{"href":"https:\/\/www.psoda.com\/help\/wp-json\/wp\/v2\/media?parent=16975"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}