Get Users List

get user list

get
/v1/user/list

get user list

Authorizations
AuthorizationstringRequired
Query parameters
keywordstringOptional

search user by name or email

cityIdintegerOptional

filter by city id (fill blank if not filtering)

schoolIdintegerOptional

filter by school id (fill blank if not filtering)

kindinteger · enumOptional

filter by roles (1: admin, 2: mentor, 4: student, 7: lead program, 9: lead region) (fill blank if not filtering)

Possible values:
pageintegerOptional

page number, default: 1

pageSizeintegerOptional

page size, default: 10

Responses
200

Response

application/json
get
/v1/user/list
GET /v1/user/list HTTP/1.1
Host: services.alkamedia.id
Authorization: YOUR_API_KEY
Accept: */*
200

Response

{
  "data": {
    "page": 1,
    "perPage": 1,
    "totalItems": 1,
    "totalPages": 1,
    "items": [
      {
        "created_at": "text",
        "kind": 1,
        "status": 0,
        "updated_at": "text",
        "city": "text",
        "id": 1,
        "name": "text",
        "phone": "text",
        "school": "text",
        "email": "text",
        "gender": "string",
        "photo": "text",
        "verified": 0
      }
    ]
  },
  "message": "success",
  "status": true
}

Last updated