Generated go sdk for the vikunja api
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 

6.2 KiB

\ListApi

All URIs are relative to https://localhost/api/v1

Method HTTP request Description
ListsGet Get /lists Get all lists a user has access to
ListsIdDelete Delete /lists/{id} Deletes a list
ListsIdGet Get /lists/{id} Gets one list
ListsIdListusersGet Get /lists/{id}/listusers Get users
ListsIdPost Post /lists/{id} Updates a list
NamespacesNamespaceIDListsPut Put /namespaces/{namespaceID}/lists Creates a new list

ListsGet

[]ModelsList ListsGet(ctx, optional) Get all lists a user has access to

Returns all lists a user has access to.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
p int32 The page number. Used for pagination. If not provided, the first page of results is returned.
s string Search lists by title.

Return type

**[]ModelsList**

Authorization

JWTKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListsIdDelete

ModelsMessage ListsIdDelete(ctx, id) Deletes a list

Delets a list

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
id int32 List ID

Return type

ModelsMessage

Authorization

JWTKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListsIdGet

ModelsList ListsIdGet(ctx, id) Gets one list

Returns a list by its ID.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
id int32 List ID

Return type

ModelsList

Authorization

JWTKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListsIdListusersGet

[]ModelsUser ListsIdListusersGet(ctx, id, optional) Get users

Lists all users (without emailadresses). Also possible to search for a specific user.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
id int32 List ID
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
id int32 List ID
s string Search for a user by its name.

Return type

**[]ModelsUser**

Authorization

JWTKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListsIdPost

ModelsList ListsIdPost(ctx, id, list) Updates a list

Updates a list. This does not include adding a task (see below).

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
id int32 List ID
list ModelsList The list with updated values you want to update.

Return type

ModelsList

Authorization

JWTKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

NamespacesNamespaceIDListsPut

ModelsList NamespacesNamespaceIDListsPut(ctx, namespaceID, list) Creates a new list

Creates a new list in a given namespace. The user needs write-access to the namespace.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
namespaceID int32 Namespace ID
list ModelsList The list you want to create.

Return type

ModelsList

Authorization

JWTKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]