Sensibill Rest API/com.getsensibill.rest.generated.v2.api/LookupsApi/getDocumentCategories

getDocumentCategories

@GET(value = "lookups/documentcategories")

abstract suspend fun getDocumentCategories(@Query(value = "scale") scale: String? = "3x", @Query(value = "locale") locale: String? = null): Response<GetLookupCategoryListResponseDto>

Document categories This API call allows for retrieval of a list of document categories. To call this endpoint, you can use either a client-token or a user-token. Responses:

200: Success
401: Unauthorized. This will occur if you do not supply an access-token to this endpoint, or if you provide an expired or invalid access token.

Return

GetLookupCategoryListResponseDto

Parameters

scale

This provides the scale factor to use for the images returned from the endpoint. Can either be '2x' or '3x'. Defaults to '3x' for higher resolution images. (optional, default to "3x")

locale

Allows you to specify the locale in which the response should be returned. It must be a supported value from the list of locale-codes, which can be obtained by going to `/lookups/locales`. It defaults to the user's locale. (optional)