List business members

Request

Get all members of a business. Use pagination parameters (page & limit) for optimal performance. Legacy support: returns array without params (deprecated - will be removed in future). Requires BUSINESS auth (min role: VIEWER) or TENANT admin.

Security

projectKey or authJWT

Path

businessIdstringrequired

Query

pagenumber

Page number (1-based)

limitnumber

Items per page

includeArray of strings

Include related entities (comma-separated). Valid options: user, business

curl -i -X GET \
  'https://docs.pers.ninja/_mock/swagger/businesses/{businessId}/members?page=0&limit=0&include=string' \
  -H 'x-project-key: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json

Array [

idstringrequired

Unique identifier for this membership

userIdstringrequired

The user ID who has access to this business

businessIdstringrequired

The business ID this membership belongs to

rolestringrequired

The role the user has in this business. Permissions are derived from role.

Enum:"OWNER""ADMIN""EDITOR""VIEWER"

Example:"OWNER"

createdAtstring, (date-time)

When the membership was created

updatedAtstring, (date-time)

When the membership was last updated

includedobject

Included related entities. Only populated when include parameter is specified.

]

Response

[
  {
    "id": "string",
    "userId": "string",
    "businessId": "string",
    "role": "OWNER",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "included": { … }
  }
]