API is in Alpha and may change at any time.

API Resources > Civilian

Get Civilians

This endpoint allows you to get all civilians for a user.

Get Civilians

POST api/v1/civilian/get_civilians

Request Body

Name Type Description Default
user_id number Discord ID of the user. Required

Example Request Body

{
    "user_id": 123456789123456789
}

Responses

200 A successful call.

{
    "success": true,
    "message": "",
    "data": [
        {
            "id": 123456789,
            "user_id": 123456789123456789,
            "first_name": "Zaki",
            "last_name": "Bakir",
            "full_name": "Zaki Bakir",
            "picture": "https://cdn.discordapp.com/attachments/...",
            "date_of_birth": "03/19/1993",
            "gender": "Male",
            "race": "Other",
            "postal": 653,
            "street": "Lake Vinewood East",
            "city": "Sacramento",
            "full_address": "653 Lake Vinewood East Sacramento",
            "occupation": null,
            "height": "77",
            "weight": "205",
            "status": 1,
            "status_name": "Alive",
            "active_persona": 1,
            "created_at": "04/03/2024 21:45:21",
            "updated_at": "05/05/2024 21:19:18",
            "is_violent": 0,
            "is_weapon": 0,
            "is_ill": 0,
            "is_swat": 0,
            "is_ciu": 0,
            "is_warrant": 0
        }, ...
    ]
}

200 with validation errors.

{
    "success": false,
    "message": "Validation errors",
    "data": {
        "user_id": [
            "The user id field is required.",
            "The user id must be a number."
        ]
    }
}

200 with no civilian found.

{
    "success": false,
    "message": "No civilian found.",
    "data": []
}

Still have questions?

Still have questions? Talk to support.