API Reference
Timerise © 2022
Getting started
Here you will find all the most important information about using our API.
GraphQL
The GraphQL API is available at a single GraphQL endpoint. You can access the GraphQL API using the Apollo Explorer, curl, or any HTTP client. LIVE ENDPOINT
POST https://api.timerise.io/v1
SANDBOX ENDPOINT
POST https://sandbox-api.timerise.io/v1
POST
requests. Other HTTP methods, such as GET
or PUT
, will return a 400 (Bad request) or 406 (Not acceptable) response.Authentication
The GraphQL API require bearer token for making authenticated requests.
You will get the token by logging in via email and password using the login link.
login(
email: EmailAddress!
password: NonEmptyString!
): TOKEN
mutation {
login(email: "user@timerise.io", password: "secretpassword")
}
me(
projectId: ID!
): User
{"Authorization": "Bearer TOKEN"}
Learn more about Login
, Me
and User
on:
Status and error codes
All API queries return HTTP status codes that contain more information about the response.
200 OK
GraphQL HTTP status codes are different from REST API status codes. Most importantly, the GraphQL API can return a 200 OK
response code in cases that would typically produce 4xx
or 5xx
errors in REST.
4xx and 5xx
For GraphQL, the 4xx
and 5xx
errors occur infrequently. They are often related to network communications, your account, or an issue with Timerise services.
Many errors that would typically return a 4xx
or 5xx
status code, return an HTTP 200 errors response instead.
- 400 Bad Request The server will not process the request.
- 403 Forbidden The project is forbidden.
- 404 Not Found The resource isn’t available. This is often caused by querying for something that’s been deleted.
- 423 Locked The shop isn’t available. This can happen when project exceed API rate limits or due to fraud risk.
- 5xx Errors An internal error occurred in Timerise