11 $ref: x-primitives.json
17 url: http://www.gnu.org/licenses/gpl.txt
19 name: Koha Development Team
20 url: https://koha-community.org/
24 This API is documented in **OpenAPI format**.
28 The API supports the following authentication mechanisms
30 * HTTP Basic authentication
31 * OAuth2 (client credentials grant)
34 Both _Basic authentication_ and the _OAuth2_ flow, need to be enabled
35 by system preferences.
39 The API uses standard HTTP status codes to indicate the success or failure
40 of the API call. The body of the response will be JSON in the following format:
44 "error": "patron not found"
48 Note: Some routes might offer additional attributes in their error responses but that's
49 subject to change and thus not documented.
55 This optional header should be passed to give your api request a library
56 context; If it is not included in the request, then the request context
57 will default to using your api comsumer's assigned home library.
59 - name: "article_requests"
60 x-displayName: Article requests
62 Manage article requests
64 x-displayName: Biblios
66 Manage bibliographic records
68 x-displayName: Cashups
70 Manage cash register cashups
72 x-displayName: Checkouts
75 - name: "circulation_rules"
76 x-displayName: Circulation rules
78 Manage circulation rules
90 Manage funds for the acquisitions module
96 x-displayName: ILL backends
98 Manage ILL module backends
100 x-displayName: ILL requests
108 x-displayName: Libraries
112 x-displayName: Macros
116 x-displayName: Orders
118 Manage acquisition orders
120 x-displayName: "OAuth"
124 x-displayName: Patrons
128 x-displayName: Quotes
131 - name: "return_claims"
132 x-displayName: Return claims
139 - name: "smtp_servers"
140 x-displayName: SMTP servers
142 Manage SMTP servers configurations
144 x-displayName: Transfer limits
146 Manage transfer limits
147 - name: "suggestions"
148 x-displayName: "Purchase suggestions"
150 Manage purchase suggestions
152 x-displayName: "Vendors"
154 Manage vendors for the acquisitions module
155 - name: "batch_import_profiles"
156 x-displayName: Batch import profiles
158 Manage batch import profiles