Skip to content

Query Organization Members ​

Endpoint Path ​

http
GET /api/open/organization/:id/members

Request Parameters ​

FieldTypeRequiredDescriptionConstraintsExample
idintYesOrganization (department) IDPath parameter; must be > 02001
pintNoPage numberDefault 11
page_sizeintNoPage sizeDefault 10; max 100020

Request Example ​

json
GET 'https://neolink.com/backend/api/open/organization/2001/members?p=1&page_size=20'

Return Information ​

FieldTypeRequiredDescriptionRemarks
successboolYesRequest success indicatorFixed value
messagestringYesError message (empty if successful)Fixed value
dataPageInfoYesPaginated data objectSee table below

PageInfo Object

FieldTypeRequiredDescriptionRemarks
pageintYesCurrent page number
page_sizeintYesItems per page
totalintYesTotal item count
items[]MemberItemYesMember listSee table below

MemberItem Object

FieldTypeRequiredDescriptionRemarks
member_idintYesMember IDFor member_id input of log and related APIs
organization_idintYesOrganization IDSame as path id
usernamestringYesUsername
mobilestringYesMobile numberMasked, e.g. 138****0000

Response Example ​

json
Success
{
  "success": true,
  "message": "",
  "data": {
    "page": 1,
    "page_size": 20,
    "total": 2,
    "items": [
      {
        "member_id": 5001,
        "organization_id": 2001,
        "username": "alice",
        "mobile": "138****0000"
      },
      {
        "member_id": 5002,
        "organization_id": 2001,
        "username": "bob",
        "mobile": "139****1234"
      }
    ]
  }
}
Failure (organization not found / no permission, etc.)
{
  "success": false,
  "message": "Department not found"
}