Sits Endpoints

Interface with our Sits Tracking module within your own scripts or applications

CONTENTS

Increment Sits Count

POST v1/sits/increment

Decrement Sits Count

POST v1/sits/decrement

Get Sits Count

GET v1/sits/count

Reset Sits Count

POST v1/sits/reset

Suggesting Endpoints

We ❤️ developers, so dont be afraid to suggest new endpoints.

---

Increment Sits Count

POST api.elyxir.dev/v1/sits/increment

Increases the number of sits of a specified user by one.

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>

Body

Name	Type	Description
user_id	string	Discord ID of the staff member

Response

200

{
  "user_id": "501777482282958850",
  "sits": 12
}

400

{
  "error": "Invalid request"
}

Decrement Sits Count

POST api.elyxir.dev/v1/sits/decrement

Decreases the number of sits of a specified user by one.

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>

Body

Name	Type	Description
user_id	string	Discord ID of the staff member

Response

200

{
  "user_id": "501777482282958850",
  "sits": 12
}

400

{
  "error": "Invalid request"
}

Get Sits Count

GET api.elyxir.dev/v1/sits/count

Gets the number of sits held by a specified user

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>

Body

Name	Type	Description
user_id	string	Discord ID of the staff member

Response

200

{
  "user_id": "501777482282958850",
  "sits": 12
}

400

{
  "error": "Invalid request"
}

Reset Sits Count

POST api.elyxir.dev/v1/sits/reset

Resets the number of sits for a specified user

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>

Body

Name	Type	Description
user_id	string	Discord ID of the staff member

Response

200

{
  "user_id": "501777482282958850",
  "sits": 0
}

400

{
  "error": "Invalid request"
}

Suggest an additional endpoint

At Elyxir we ❤️ developers. That's why we're open to hearing any suggestions for extending our API for use within your FiveM scripts and/or applications.

Contact us within our Discord server to suggest endpoints.