Retrieving Users
Retrieving All Users
Using the GET method, you can retrieve your Users.
- Retrieve All - GET https://edgeapi.marchex.io/marketingedge/v5/api/users
Results will be paged given the possibility of a large result set, so paging options can also be added to the request. For additional information please see our Paging Documentation
{
"paging": {
"pageNumber": 1,
"pageSize": 3,
"total": 165
},
"results": [
{
"user_id": "627b4c86-1ff1-4ca7-8827-95c214666636",
"username": "rsmith",
"name": "Rob Smith",
"email": "[email protected]",
"phone": "",
"call_detail_level": "full",
"restrict_recording_download": false,
"status": "deactivated",
"last_login_date": "2016-03-03T16:13:59.1917141",
"last_updated_date": "2015-12-03T20:06:02.083",
"deactivation_date": "2016-08-24T13:39:03.937",
"roles": [
"call_record_listen",
"reporting",
"administrator",
"ordering"
],
"access": {
"billing_groups": [
"1234"
]
}
},
{
"user_id": "9cb5bf2a-ed88-4b63-a76e-bfdb92b2121a",
"username": "mhopper",
"name": "Mike Hopper",
"email": "[email protected]",
"phone": "",
"call_detail_level": "full",
"restrict_recording_download": false,
"status": "deactivated",
"last_login_date": "2015-07-07T12:24:54.423",
"last_updated_date": "2015-07-07T12:25:16.42",
"deactivation_date": "2022-05-02T13:45:59.937",
"roles": [
"call_record_listen",
"reporting",
"administrator",
"ordering"
],
"access": {
"billing_groups": [
"1234"
]
}
},
{
"user_id": "fe3949c2-b3f5-46f8-9377-05568c748dbc",
"username": "ewoods",
"name": "Edward Woods",
"email": "[email protected]",
"phone": "705-722-4398",
"call_detail_level": "full",
"restrict_recording_download": false,
"status": "activated",
"last_login_date": "2011-08-15T13:16:42.283",
"last_updated_date": "2015-11-17T14:23:53.643",
"roles": [
"call_record_listen",
"reporting",
"administrator",
"ordering"
],
"access": {
"billing_groups": [
"5555"
]
}
}
]
}
Retrieving a User by ID or Username
Using the GET method, you can retrieve a User by username.
- Retrieve a User by username - GET https://edgeapi.marchex.io/marketingedge/v5/api/users/<username>
Using the GET method, you can retrieve a User by user_id.
- Retrieve a User by user_id - GET https://edgeapi.marchex.io/marketingedge/v5/api/users/<user_id>
{
"user_id": "00f12ba7-b26a-4503-9ab4-0ec04914f71f",
"username": "test1",
"name": "test1",
"email": "[email protected]",
"phone": "",
"call_detail_level": "full",
"restrict_recording_download": false,
"status": "activated",
"last_login_date": "2022-05-02T14:38:49.5177442",
"last_updated_date": "2021-08-03T16:14:45.8890787",
"roles": [
"call_record_listen",
"browse_inventory",
"reporting",
"administrator",
"view_stop_call_data",
"ordering"
],
"access": {
"billing_groups": [
"4444"
]
}
}
Searching for a User
Using the GET method, you can retrieve Users by specifying search parameters are part of the request
- Search for User - **GET https://edgeapi.marchex.io/marketingedge/v5/api/users?<query_string_params>
When searching for users the following options are available as query string parameters:
- username
- name
- status
- role
- billing_group
- group_owner
GET https://edgeapi.marchex.io/marketingedge/v5/api/users?username=abc&name=xyz&[email protected]&status=active&role=reporting&billing_group=12345&group_owner=12345
The username and name parameters will use the input as a sub-string when searching, so all values that contains the input value will be returned
The remainder of the search parameters will use the input as an exact match.
Updated 10 months ago