List Members

GEThttps://api.confident-ai.com/v2/projects/{projectId}/members

Lists the members of one project a page at a time, each with the project role that decides what they can do inside it. Project members are drawn from the organization's members: someone can belong to the organization and not appear here, and being here is what gives them access to this project's data. Removing a member from the organization removes them from every project in it, this one included.

GET/v2/projects/{projectId}/members

curl -X GET "https://api.confident-ai.com/v2/projects/{projectId}/members" \
  -H "CONFIDENT_API_KEY: <ORGANIZATION-API-KEY>"

200

{
  "success": true,
  "data": {
    "members": [
      {
        "id": "<USER-ID>",
        "email": "jane@acme.com",
        "name": "Jane Doe",
        "image": null,
        "projectRole": {
          "id": "<ROLE-ID>",
          "name": "Admin"
        }
      }
    ],
    "totalProjectMembers": 3,
    "page": 1,
    "pageSize": 25
  },
  "deprecated": false
}

Headers

CONFIDENT_API_KEYstringRequired
The organization API key for your Confident AI organization.

Path parameters

projectIdstringRequired
The id of the project, which must belong to your organization.

Query parameters

pageintegerdefault: 1
The page to return. Defaults to 1.
pageSizeintegerdefault: 25
The number of members per page, at most 100. Defaults to 25.

Response

List Members succeeded.

successboolean
Indicates if the request was successful.
dataobject
One page of project members, with the total across all pages.
Show 4 propertiesHide 4 properties
- memberslist of objects
  The project's members for the current page.
  Show 5 propertiesHide 5 properties
  - idstring
    This is the id of the user.
  - emailstring
    This is the email address of the user.
  - namestring | null
    This is the display name of the user, or null when they have not set one.
  - imagestring | null
    This is the URL of the user's avatar, or null when they have none.
  - projectRoleobject | null
    The role a member holds, as referenced from the member. Retrieve the role by id from the roles endpoint of the same scope to see the policies behind it.
    Show 2 propertiesHide 2 properties
    idstring
    The id of the role.
    namestring
    The name of the role.
- totalProjectMembersinteger
  The total number of members in the project, across every page.
- pageinteger
  The page this response covers.
- pageSizeinteger
  The number of members per page.
deprecatedboolean
Indicates if this endpoint is deprecated.

Built byConfident AI