Psoda API: Top level

Psoda API – /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 “My stuff” and then click on the “API Code” button in the toolbar.

Header: If-Modified-Since (optional)

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

Header: Accept-Language (optional)

Use this header if you want to change the language for the user. The following languages are currently supported:

  • af – Afrikaans
  • en – English
  • en-nz – English
  • en-uk – English
  • en-us – United States English
  • ja – Japanese
  • ru – Russian
  • zh-cn – Simplified Chinese
  • zh-hk – Simplified Chinese
  • zh-mo – Simplified Chinese
  • zh-sg – Simplified Chinese
  • zh-tw – Simplified Chinese
  • zh – Simplified Chinese

Parameter: lang (optional)

Alternatively you can use this parameter to set the language.


The extention on your path specifies the required format. For example{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.

Only .json and .html is currently supported. If no extension is specificied then the help page is returned as well.

Parameter: fields (optional)

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.