API Reference
Timerise © 2024
Here you will find all the most important information about using our API.
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>
<aside> 🔑 You can register free sandbox account at: https://sandbox.timerise.io
</aside>
<aside>
đź’ˇ GraphQL API only accept POST
requests. Other HTTP methods, such as GET
or PUT
, will return a 400 (Bad request) or 406 (Not acceptable) response.
</aside>
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: "[email protected]", password: "secretpassword")
}
me(
projectId: ID!
): User
{"Authorization": "Bearer TOKEN"}
Learn more about Login
, Me
and User
on:
All API queries return HTTP status codes that contain more information about the response.
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.
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.