Search Available Members
List the members that are available to be assigned to DECT handset lines.
This requires a full or read-only administrator auth token with a scope of spark-admin:telephony_config_read.
Query Parameters
Search members in this organization.
Specifies the offset from the first result that you want to fetch.
Specifies the maximum number of records that you want to fetch.
Search (Contains) numbers based on member name.
Search (Contains) based on number.
Search (Contains) based on extension.
Sort the list of available members on the device in ascending order by name, using either last name lname or first name fname. Default sort is the last name in ascending order.
List members for the location ID.
If true, search results will exclude virtual lines in the member list. NOTE: Virtual lines cannot be assigned as the primary line.
Search for members eligible to become the owner of the device, or share line on the device.
Response Properties
Unique identifier for the member.
First name of the member.
Last name of the member.
Phone Number of the member.
Extension of the member.
Line type indicates if the associated line is a primary line or a shared line.
Primary line for the member.
Shared line for the member.
Indicates the type of the member.
Indicates the associated member is a person.
Indicates the associated member is a workspace.
Indicates the associated member is a virtual profile.
Location object having a unique identifier for the location and its name.
Location identifier associated with the member.
Location name associated with the member.
Response Codes
The list below describes the common success and error responses you should expect from the API.
| Code | Status | Description |
|---|---|---|
| 200 | OK | Successful request with body content. |
| 201 | Created | The request has succeeded and has led to the creation of a resource. |
| 202 | Accepted | The request has been accepted for processing. |
| 204 | No Content | Successful request without body content. |
| 400 | Bad Request | The request was invalid or cannot be otherwise served. An accompanying error message will explain further. |
| 401 | Unauthorized | Authentication credentials were missing or incorrect. |
| 403 | Forbidden | The request is understood, but it has been refused or access is not allowed. |
| 404 | Not Found | The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method. |
| 405 | Method Not Allowed | The request was made to a resource using an HTTP request method that is not supported. |
| 409 | Conflict | The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once. |
| 410 | Gone | The requested resource is no longer available. |
| 415 | Unsupported Media Type | The request was made to a resource without specifying a media type or used a media type that is not supported. |
| 423 | Locked | The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again. |
| 428 | Precondition Required | File(s) cannot be scanned for malware and need to be force downloaded. |
| 429 | Too Many Requests | Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made. |
| 500 | Internal Server Error | Something went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team. |
| 502 | Bad Gateway | The server received an invalid response from an upstream server while processing the request. Try again later. |
| 503 | Service Unavailable | Server is overloaded with requests. Try again later. |
| 504 | Gateway Timeout | An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it. |
Header
Query Parameters
- Search members in this organization.
- Specifies the offset from the first result that you want to fetch.
- Specifies the maximum number of records that you want to fetch.
- Search (Contains) numbers based on member name.
- Search (Contains) based on number.
- Search (Contains) based on extension.
- Sort the list of available members on the device in ascending order by name, using either last name `lname` or first name `fname`. Default sort is the last name in ascending order.
- List members for the location ID.
- If true, search results will exclude virtual lines in the member list. NOTE: Virtual lines cannot be assigned as the primary line.
- Search for members eligible to become the owner of the device, or share line on the device.
{
"members": [
{
"id":"Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jODhiZGIwNC1jZjU5LTRjMjMtODQ4OC00NTNhOTE3ZDFlMjk",
"firstName": "John",
"lastName": "Smith",
"phoneNumber": "+12055552221",
"extension": "1234",
"lineType": "PRIMARY",
"memberType": "PEOPLE",
"location": {
"id": "Y2lzY29zcGFyazovL3VzL0RFQ1RfREVWX05FVC81NmRiMjRkMy03YTdhLTQwYTItOWFjOS1iMjMzMjc3OTIxTrd",
"name": "MainOffice"
}
}
]
}