Skip to content

Endpoints for your team information

List all team members

v1GEThttps://id.amiqus.co/api/team/members
v2GEThttps://id.amiqus.co/api/v2/team/members

Added:

  • object of type paginated_list
  • object of type team_member

Changed:

  • Enum values for role have changed: guest is now replaced with read-only. Two additional roles are available: assigned-only assumed.

Removed:

  • two_factor_enabled

Below are examples of responses:

json
{
    "data": [
        {
            "id": 4,
            "name": "David Adams",
            "email": "david@example.com",
            "two_factor_enabled": false,
            "role": "owner"
        },
        {
            "id": 5,
            "name": "Dale Patel",
            "email": "dp@example.com",
            "two_factor_enabled": false,
            "role": "member"
        },
        {
            "id": 6,
            "name": "Henry Watson",
            "email": "henry@example.com",
            "two_factor_enabled": false,
            "role": "guest"
        },
        {
            "id": 7,
            "name": "Yvonne Ross",
            "email": "yr@example.com",
            "two_factor_enabled": false,
            "role": "assigned-only"
        }
    ],
    "meta": {
        "pagination": {
            "total": 4,
            "count": 4,
            "per_page": 25,
            "current_page": 1,
            "total_pages": 1,
            "links": {}
        }
    }
}
json
{
    "object": "paginated_list",
    "data": [
        {
            "object": "team_member",
            "id": 4,
            "name": "David Adams",
            "email": "david@example.com",
            "role": "owner"
        },
        {
            "object": "team_member",
            "id": 5,
            "name": "Dale Patel",
            "email": "dp@example.com",
            "role": "member"
        },
        {
            "object": "team_member",
            "id": 6,
            "name": "Henry Watson",
            "email": "henry@example.com",
            "role": "read-only"
        },
        {
            "object": "team_member",
            "id": 7,
            "name": "Yvonne Ross",
            "email": "yr@example.com",
            "role": "assigned-only"
        }
    ],
    "total": 4,
    "count": 4,
    "limit": 25,
    "current_page": 1,
    "total_pages": 1,
    "links": null
}

INFO

📌 Please refer to List all team members for more information.