ManagementUsersUsers company level

Get a list of users

GET
/companies/{companyId}/users

Returns the list of users for the companyId identified in the path.

To make this request, your API credential must have the following role:

  • Management API—Users read and write

Authorization

AuthorizationBasic <token>

In: header

Path Parameters

companyId*string

The unique identifier of the company account.

Query Parameters

pageNumber?integer

The number of the page to return.

Formatint32
pageSize?integer

The number of items to have on a page. Maximum value is 100. The default is 10 items on a page.

Formatint32
username?string

The partial or complete username to select all users that match.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/companies/string/users"
{  "_links": {    "first": {      "href": "string"    },    "last": {      "href": "string"    },    "next": {      "href": "string"    },    "prev": {      "href": "string"    },    "self": {      "href": "string"    }  },  "data": [    {      "_links": {        "self": {          "href": "string"        }      },      "accountGroups": [        "string"      ],      "active": true,      "apps": [        "string"      ],      "associatedMerchantAccounts": [        "string"      ],      "email": "string",      "id": "string",      "name": {        "firstName": "string",        "lastName": "string"      },      "roles": [        "string"      ],      "timeZoneCode": "string",      "username": "string"    }  ],  "itemsTotal": 0,  "pagesTotal": 0}