Specialized APIsSensor InsightsAPI Reference
Retrieve all user profiles
Get a Summary of User Profile Records
POST /dm/v1/users/actions/query
Use this endpoint to retrieve the user profile records that have been created.
Header Parameters
The request header must set the content-type to JSON, contain a current ThingSpace authorization token and a current VZ-M2M session token. For more details on how to get these tokens, visit Getting Started.
| Parameter Name | Data Type | Description |
|---|---|---|
| Authorization (required) | string | HTTP Authorization request header containing a valid Bearer token: Authorization: Bearer {token} |
| VZ-M2M-Token (required) | string | A valid session token returned by a Connectivity Management POST /session/login request. |
| Content-Type (required) | string | Must be application/json. |
HTTP Request
POST https://thingspace.verizon.com/api/dm/v1/users/actions/query
Request Parameters
Note: All parameters are required unless marked (optional)
| Parameter | Data Type | Description |
|---|---|---|
| accountname | string | The numeric name of the account and must include leading zeros. |
| filter | object | Optional filter data to narrow the search. |
| $expand (optional) | string | Use to provide device details to filter on. |
| $limitnumber (optional) | integer | Limits the number of results returned. |
| $nopagination (optional) | boolean | A flag to indicate if pagination is requested ( false ) or not ( true ). |
| $page (optional) | string | The number of pages in the response. |
| $pagenumber (optional) | integer | The page number requested (if known). |
| $projection (optional) | array | Limits results to the fields of the device that the user is interested in rather than all of the fields. |
| $selection (optional) | object | Filters results based on user defined criteria. |
Request Body
Example Request:
{
"accountname": "0000123456-00001",
"filter": {
"$expand": "device detail(s)",
"$limitnumber": 100,
"$nopagination": true,
"$page": "The number of pages",
"$pagenumber": 100,
"$projection": [
"details requested"
],
"$selection": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
}
}Success Response
Status 200 This is a synchronous response, so the user records will be returned. Example Response:
{
"accountclientid": "null",
"ackterms": true,
"acktermson": "2023-10-02T15:46:34.562Z",
"billingaccountid": "The billing account ID",
"createdon": "2023-10-02T15:46:34.562Z",
"credentialsid": "email@domain.com",
"credentialstype": "email",
"customdata": {
"additionalProp1": [
100
],
"additionalProp2": [
100
],
"additionalProp3": [
100
]
},
"description": "a short description",
"displayname": "user name displayed",
"email": "email@domain.com",
"firstname": "First name",
"foreignid": "c1f178d3-eeee-ffff-gggg-0d6b7ae6022a",
"id": "a record UUID",
"lastname": "Last name or Surname",
"lastupdated": "2023-10-02T15:46:34.562Z",
"mdn": "908-555-1234",
"middlename": "Middle name or initial",
"name": "the assigned name of the record",
"number": "908-555-1234",
"requestedon": "2023-10-02T15:46:34.562Z",
"secondarybillingaccountids": [
null
],
"state": "success",
"version": "1.0",
"versionid": "337bd2e8-eeee-ffff-gggg-5207992fd395"
}Success Parameters
| Parameter | Data Type | Description |
|---|---|---|
| accountclientid | string | Future functionality. This value will be "null". |
| ackterms | boolean | A flag indicating if the user has accepted the terms of use ( true ) or not ( false ). |
| acktermson | string ($date-time) | A timestamp of when terms were accepted. |
| billingaccountid | string | The numeric name of the account and must include leading zeros. This value matches the accountname. |
| createdon | string ($date-time) | The timestamp of when the record was created. |
| credentialsid | string | An email address used for user credentials. Currently, only email addresses are valid values. |
| credentialstype | string | The type of credential represented by the ID. This will be email. |
| customdata | object | This is free form JSON, any thing in the form of JSON can be stored. |
| description | string | A description of the record. |
| displayname | string | The name of the user to be displayed. |
| string | An email address for the user, in the format "email@domain.com". | |
| firstname | string | The user's first name |
| foreignid | string | The UUID value of the user's Enterprise Customer Profile Database (ECPD) account. A UUID is a 32 to 36-bit alphanumeric string. |
| id | string | The UUID of the resource. A UUID is a 34 or 36-bit alphanumeric value. |
| lastname | string | The user's last name or Surname. |
| lastupdated | string ($date-time) | The timestamp of when the last update to the record was made. |
| mdn | string | The Mobile Directory Number of the user. This is a 10-digit phone number. |
| middlename | string | The middle name or initial of the user. |
| name | string | The name of the record assigned by the creator of the record. |
| number | string | A phone number for the user. |
| requestedon | string ($date-time) | The timestamp of when the record was requested. |
| secondarybillingaccountids | array | This is a virtual field not used in this release. The value will be "null". |
| state | string | The status of the request made. |
| version | string | The resource version. |
| versionid | string | The UUID of the resource version. A UUID is a 32 to 36-bit alphanumeric string. |
Failure Responses
Example Response:
{
"error": "Error name or code",
"error_description": "A longer error description.",
"cause": "A cause for the error"
}