REST API Overview

From XING Events Developer Documentation


Due to PCI compliant reasons, all our servers only support https with the minimum TLS version 1.2.

The version 1 REST URLs have the following format:

POST /api/<object>/create

Creates a new object. The data should be form encoded.

GET /api/<object>/<id>

Reads an object. You can specify the format you would like to get.

POST /api/<object>/<id>

Updates properties of an object.

DELETE /api/<object>/<id>

Deletes an object.

GET /api/<object>/find

Searches for objects. A list of ids will be returned. Use these calls for searches only, if you want to receive all objects look for a "enumerate..." call.


When you create your API key you will get a secret key (50-digit) which will be used to authorize your requests.

This key has to be send to with each call in the authorization header:

--header 'Authorization: ApiKey <yourApiKey>'

We also support adding the API key as a query parameter to the URL (?apikey=<yourApiKey>). This may be used for simple testing but is not recommended in production systems since it bares some security risks.

See How to get your API key if you do not have an API key yet.

HTTP Status Codes

The REST API uses the standard HTTP status codes:

200 OK for a successfull GET or update request
201 CREATED for a newly created object
400 BAD REQUEST if your query was malformed (see below)
403 FORBIDDEN if you tried to access an object without the permission to do so
404 NOT FOUND if you used an invalid url or the object is not known
405 METHOD NOT ALLOWED if you requested a function that is not supported for that object
500 INTERNAL SERVER ERROR if an error occurred on our server

See Errorcodes for detailed error handling.

Standard JSON Response

Regardless of the http status code you will always get a JSON object in return which has at least the "success" field set.

If "success" is true, the request has been successfully performed. Additional information is always available depending on the type of your request.


{"success":true, "id":254804312}

if "success" is false, an "errors" array will always be present describing the errors.


{"success":  false,
 "errors":  ["com.amiando.User.LanguageRequired",

See Errorcodes for detailed information.

POST Parameters

The parameters for POST requests have to be specified in the request body. In the request header, Content-Type has to be set to application/x-www-form-urlencoded.