API Explorer: /accounts/{accountId}/invitations

To list the account invitations, you need the accountId of the account you want to get the list of invitations and use an API key that has account admin access. For the sample code on the right, a list of invitations for accountId 123456 is provided. To get a list of invitations for your account, replace the accountId 123456 with the accountId of your account.

If you do not know the accountId of the account, use view the accountId glossary section for the details on where to find this value.

curl 'https://a.blazemeter.com/api/v4/accounts/123456/invitations' \
	--user 'api_key_id:api_key_secret'
		

All timestamps are in UNIX Epoch time.

Attributes

• idstring

  The unique identifier of the invitation

• inviteeEmailstring

  The email of the invitee of the invitation (the person being invited)

• tokenstring

  The token for the invitation

• accountRolesarray

  The account role being assigned to the invited user. The following are the available roles:
  admin - Account admin role
  billing - Account billing role
  standard - Account standard role
  user_manager - Account user manager role

• workspacesRolesarray

  The workspace role being assigned to the invited user. The following are the available roles:
  tester - Workspace tester role
  manager - Workspace manager role
  viewer - Workspace viewer role

• attachAutomaticallyboolean

  Denotes if the use will be added automatically without the need to click the accept link in the invitation email

• createdinteger

  The timestamp for when the invitation was created

• updatedinteger

  The timestamp for when the invitation was updated

• accountNamestring

  The account name of the account for the invitation

• acceptUrlstring

  The URL for accepting the invitation. Must be used by the user invited

• rejectUrlstring

  The URL for rejecting the invitation. Must be used by the user invited

• invitingEmailstring

  The email of the user who created the invitation

• invitingNamestring

  The name of the user who created the invitation

• workspaceNamesarray

  The name of the workspaces the invitee was invited to

Add User to Account Response Attributes

Response200 OK

{
    "limit": 10,
    "skip": 0,
    "total": 1,
    "hidden": 0,
    "api_version": 4,
    "error": null,
    "result": [{
        "id": "5eea89603e7ad67f5d35cbf7",
        "inviteeEmail": "somebody@example.com",
        "token": "4p8M0gseEpHr",
        "accountRoles": [
            "standard"
        ],
        "workspacesRoles": [
            "tester"
        ],
        "attachAutomatically": false,
        "created": 1592428896,
        "updated": 1592428896,
        "accountName": "Travis's Account",
        "acceptUrl": "https://a.blazemeter.com/api/v4/accounts/130010/invitations/5eea89603e7ad67f5d35cbf7/accept/4p8M0gseEpHr",
        "rejectUrl": "https://a.blazemeter.com/api/v4/accounts/130010/invitations/5eea89603e7ad67f5d35cbf7/reject/4p8M0gseEpHr",
        "invitingEmail": "somebody@example.com",
        "invitingName": "Travis Lloyd",
        "workspaceNames": [
            "Default workspace"
        ]
    }],
    "request_id": "5eea8978ea87b"
}