API introduction

SEEK includes a JSON Application Programming Interface (API) that allows the searching, listing, reading, updating and creating of many items in SEEK, along with their attributes.

Technical details about the JSON stuctures and available endpoints can be found in the JSON API Overview; and also on SwaggerHub where some aspects of the API can be tested out.

The API conforms to the JSON API specification which describes a standard way of representing APIs in JSON.

Authentication

Calls to the JSON API should use Basic Authentication (base64 encoding of username and password). This identifies the “logged in” user to SEEK. The API only exposes those assets to which that user has access. As a result, the results of a call will vary according to which user is logged in.

The JSON API can also be used without any authentication, in which case only publicly viewable information will be returned.