Endpoints for current status

Get current user

v1	GET	https://id.amiqus.co/api/users/me
v2	GET	https://id.amiqus.co/api/v2/me

“Get current user” endpoint has been replaced with “User account → Retrieve user account”

Added

• object the value of this property is always "user" indicating this is a user object
• is_verified
• is_disabled

Removed

• email_change_to
• is_assumed
• verified
• disabled
• has_access
• is_admin
• last_notification_open_at
• two_factor_enabled
• role

Note

Information previously contained in the role or is_admin fields can now be found in Retrieve team membership.

INFO

📌 Please refer to Retrieve user account for more information.

Below are examples of responses:

v1

{
    "id": 3,
    "name": "Helena Harrison",
    "email": "owner@amiqus.co",
    "email_change_to": null,
    "is_assumed": false,
    "verified": true,
    "disabled": false,
    "has_access": true,
    "is_admin": false,
    "role": "owner",
    "last_notification_open_at": "2022-03-23T10:28:38+00:00",
    "two_factor_enabled": false,
    "created_at": "2022-02-02T16:37:30+00:00",
    "updated_at": "2022-02-02T16:39:44+00:00"
}

v2

{
    "object": "user",
    "id": 3,
    "name": "Helena Harrison",
    "email": "owner@amiqus.co",
    "is_verified": true,
    "is_disabled": false,
    "created_at": "2022-02-02T16:37:30Z",
    "updated_at": "2022-02-02T16:39:44Z"
}

Get current team

v1	GET	https://id.amiqus.co/api/team/current
v2	GET	https://id.amiqus.co/api/v2/team

“Get current team” endpoint has been replaced with “Your Team → Retrieve current team”.

Added:

• object this is always of type team
• identifier
• is_support_enabled
• limit
• archived_at

Removed:

• credits
• low_credits
• organisation_group
• account_credits
• available_credits
• archived (see archived_at for an alternative)
• members_count
• tier_name_short
• using_sso
• can_enable_sso
• charged_per_seat
• features
• feature_badges
• integrations
• support_access
• live_at
• archived_at
• logo
• object of type pivot (and nested properties: user_id, team_id, role, default, last_activity_at)

Below are examples of responses:

v1

{
    "id": 1,
    "uuid": "1234-22re-555yyy-09nn-87unnn",
    "name": "ABC Ltd",
    "identifier": "33ff-gg67-hh99900",
    "organisation_group": "234opo-45dfgf-32r234gdfg-sdfds",
    "credits": 472,
    "credits_in_use": 0,
    "account_credits": 472,
    "available_credits": 472,
    "archived": false,
    "contact": "jane@example.com",
    "telephone": "02990123123",
    "members_count": null,
    "support_access": false,
    "tier": "enterprise_2021",
    "tier_name_short": "enterprise_2021",
    "created_at": "2023-03-23T11:00:01+00:00",
    "updated_at": "2023-08-03T16:24:13+00:00",
    "live_at": null,
    "using_sso": false,
    "can_enable_sso": false,
    "charged_per_seat": true,
    "can_use_assigned_only": false,
    "features": [],
    "feature_badges": [],
    "integrations": {
        "data": []
    }
}

v2

{
    "object": "team",
    "id": 1,
    "identifier": "33ff-gg67-hh99900",
    "uuid": "1234-22re-555yyy-09nn-87unnn",
    "name": "ABC Ltd",
    "contact": "jane@example.com",
    "telephone": "02990123123",
    "tier": "enterprise_2021",
    "logo": null,
    "is_support_enabled": false,
    "created_at": "2023-03-23T11:00:01Z",
    "updated_at": "2023-08-03T16:24:13Z",
    "archived_at": null
}

INFO

📌 Please refer to Retrieve current team for more information.