Agendize Developers API

Applications

{ "id": {string}, "name": {string}, "clientId": {string}, "clientSecret": {string}, "redirectUris": [ {string} ], "websiteLink": {string}, "mode": {string}, "httpOrigins: [ {string} ], "contact": { "emailAddress": {string}, "privacyLink": {string}, "termsLink": {string}, }, "description": {string}, "logging": { "enabled": {boolean}, "methods: [ {string} ] } }


`id`	`string`	Identifier of the application.	read-only.
`name`	`string`	Name of the application. Max length 127.	writable.
`clientId`	`string`	client identifier of the application.	read-only.
`clientSecret`	`string`	client secret of the application.	read-only.
`redirectUris`	`list`	List of string for each redirect uri allowed.	writable.
`websiteLink`	`string`	Website url of the application.	writable.
`mode`	`string`	Type of application. Values: "client", "application", "backoffice".	writable.
`httpOrigins`	`list`	List of string for each origin allowed.	writable.
`contact`	`object`	Location of the conference	writable.
`contact.emailAddress`	`string`	Email address of the contact.	writable.
`contact.privacyLink`	`string`	Privacy policy url.	writable.
`contact.termsLink`	`string`	Terms and conditions url.	writable.
`description`	`string`	Description of the application.	writable.
`logging`	`object`	Logging enabled or not. Logged HTTP Methods	writable.
`logging.methods`	`list`	List of http methods to log. Values: "GET", "POST", "PUT", "DELETE", "PATCH"	writable.

Delete

Deletes an entry on the application list.

Authentication is required to execute this request. Please refer to Authentication for more.

Request

HTTP Request

DELETE https://api.agendize.com/api/2.3/developers/applications/{applicationId}

Parameters

Parameter name	Value	Description
Path parameters
`applicationId`	`string`	Application identifier.

Request body

Do not supply a request body with this method.

Response

If successful, this method returns an empty response body.

Get

Returns an entry of the application list.>

Authentication is required to execute this request. Please refer to Authentication for more.

Request

HTTP Request

GET https://api.agendize.com/api/2.3/developers/applications/{applicationId}

Parameters

Parameter name	Value	Description
Path parameters
`applicationId`	`string`	Application identifier.

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a Application resource in the response body.

List

Returns entries on the application list.

Authentication is required to execute this request. Please refer to Authentication for more.

Request

HTTP Request

GET https://api.agendize.com/api/2.3/developers/applications

Parameters

Parameter name	Value	Description
Optional query parameters
`fields`	`string`	Specify the fields returned. Comma separated field names (ex: "id,name").

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response body with the following structure:

{ items: [Application Resource] }

Insert

Adds an entry to the application list.

Authentication is required to execute this request. Please refer to Authentication for more.

Request

HTTP Request

POST https://api.agendize.com/2.3/developers/applications

Parameters

Parameter name	Value	Description
Optional query parameters
`fields`	`string`	Specify the fields returned. Comma separated field names (ex: "id,title").

Request body

In the request body, supply a Application resource with the following properties:

Parameter name	Value	Description
Required Properties
`name`	`string`	Name of the application. Max length 127.	writable.
Optional Properties
`redirectUris`	`list`	List of string for each redirect uri allowed.	writable.
`websiteLink`	`string`	Website url of the application.	writable.
`mode`	`string`	Type of application. Values: "client", "application", "backoffice".	writable.
`httpOrigins`	`list`	List of string for each origin allowed.	writable.
`contact`	`object`	Location of the conference	writable.
`contact.emailAddress`	`string`	Email address of the contact.	writable.
`contact.privacyLink`	`string`	Privacy policy url.	writable.
`contact.termsLink`	`string`	Terms and conditions url.	writable.
`description`	`string`	Description of the application.	writable.
`logging`	`object`	Logging enabled or not. Logged HTTP Methods	writable.
`logging.methods`	`list`	List of http methods to log. Values: "GET", "POST", "PUT", "DELETE", "PATCH"	writable.

Response

If successful, this method returns a Application resource in the response body.

Update

Updates an entry on the application list.

Authentication is required to execute this request. Please refer to Authentication for more.

Request

HTTP Request

PUT https://api.agendize.com/api/2.3/developers/applications/{applicationId}

Parameters

Parameter name	Value	Description
Path parameters
`applicationId`	`string`	Application identifier.
Optional query parameters
`fields`	`string`	Specify the fields returned. Comma separated field names (ex: "id,title").

Request body

In the request body, supply a Conference resource with the following properties:

Parameter name	Value	Description
Optional Properties
`name`	`string`	Name of the application. Max length 127.	writable.
`redirectUris`	`list`	List of string for each redirect uri allowed.	writable.
`websiteLink`	`string`	Website url of the application.	writable.
`mode`	`string`	Type of application. Values: "client", "application", "backoffice".	writable.
`httpOrigins`	`list`	List of string for each origin allowed.	writable.
`contact`	`object`	Location of the conference	writable.
`contact.emailAddress`	`string`	Email address of the contact.	writable.
`contact.privacyLink`	`string`	Privacy policy url.	writable.
`contact.termsLink`	`string`	Terms and conditions url.	writable.
`description`	`string`	Description of the application.	writable.
`logging`	`object`	Logging enabled or not. Logged HTTP Methods	writable.
`logging.methods`	`list`	List of http methods to log. Values: "GET", "POST", "PUT", "DELETE", "PATCH"	writable.

Response

If successful, this method returns a Application resource in the response body.