Skip to main content

API

The GraphQL endpoint

The legacy REST API has numerous endpoints; the GraphQL API v1 has a single endpoint:

https://api.event1.io/graphql

The endpoint remains constant no matter what operation you perform.

Authentication

Most queries require authentication, or will only return public data when authentication is not provided. For those cases where it is not required, this will be mentioned in the documentation for each query.

There are two ways to authenticate with the eventOne API:

If authentication information is invalid or omitted, an error message will be returned with status code 401:

{
"message": "401 Unauthorized"
}

JWT tokens

You can use a JWT token to authenticate with the API by passing it in the Authorization header.

Example of using the JWT token in a header:

curl --header "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" https://api.event1.io/graphql

JWT tokens expire in 30 days so they are not good for external applications. For long lived tokens, see personal access tokens.

Personal access tokens

You can use a personal access token to authenticate with the API by passing it in the Private-Token header.

Example of using the personal access token in a header:

curl --header "Private-Token: nY0mqSjNT.2bb5895e-f205-4e9a-a93a-283cc8c65e69" https://api.event1.io/graphql

You can create personal access tokens on you account page.

Authorization

See Permissions.

Data Models

See Voyager.