Koha REST API (1)

This API is documented in OpenAPI format.

The API supports the following authentication mechanisms

• HTTP Basic authentication
• OAuth2 (client credentials grant)
• Cookie-based

Both Basic authentication and the OAuth2 flow, need to be enabled by system preferences.

The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format:

{
  "error": "patron not found"
}

Note: Some routes might offer additional attributes in their error responses but that's subject to change and thus not documented.

The API allows for some advanced response filtering using a JSON based query syntax. The query can be added to the requests:

• as a query parameter q=
• in the request body
• in a special header x-koha-query

For simple field equality matches we can use { "fieldname": "value" } where the fieldname matches one of the fields as described in the particular endpoints response object.

We can refine that with more complex matching clauses by nesting a the clause into the object; { "fieldname": { "clause": "value" } }.

Available matching clauses include ">", "<", ">=", "<=", "-like", and "-not_like".

We can filter on multiple fields by adding them to the JSON respresentation. Adding at HASH level will result in an 'AND' query, whilst combinding them in an ARRAY wilth result in an 'OR' query: { "field1": 'value2', "field2": "value2" } will filter the response to only those results with both field1 containing value2 AND field2 containing value2 for example.

Examples

The following request would return any patron with firstname "Henry" and lastname "Acevedo";

curl -u koha:koha --request GET 'http://127.0.0.1:8081/api/v1/patrons/' --data-raw '{ "surname": "Acevedo", "firstname": "Henry" }'

The following request would return any patron whose lastname begins with "Ace";

curl -u koha:koha --request GET 'http://127.0.0.1:8081/api/v1/patrons/' --data-raw '{ "surname": { "-like": "Ace%" }'

The following request would return any patron whilse lastname is 'Acevedo' OR 'Bernardo'

curl -u koha:koha --request GET 'http://127.0.0.1:8081/api/v1/patrons/' --data-raw '{ "surname": [ "Acevedo", "Bernardo" ] }'

x-koha-library

This optional header should be passed to give your api request a library context; If it is not included in the request, then the request context will default to using your api comsumer's assigned home library.

Manage article requests

Manage bibliographic records

Manage cash register cashups

Manage checkouts

Manage circulation rules

Manage cities

Manage patron clubs

Manage funds for the acquisitions module

Manage holds