Skip to main content
GET
/
v1
/
user
/
{id}
Get platform user details
curl --request GET \
  --url https://connect.provisionapp.io/v1/user/{id} \
  --header 'x-api-key: <api-key>'
{
  "id": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "email": "jsmith@example.com",
  "isActive": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "phoneNumber": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z",
  "conversationAssigneeGroups": [
    {
      "conversationAssigneeGroupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    }
  ]
}

Authorizations

x-api-key
string
header
required

Send the API key in the x-api-key header.

Path Parameters

id
string
required
Pattern: ^ovuid-.*$
Example:

"ovuid-aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa"

Response

User details

id
string
required
Pattern: ^ovuid-.*$
firstName
string
required
lastName
string
required
email
string<email>
required
isActive
boolean
required
createdAt
string<date-time>
required
phoneNumber
string
updatedAt
string<date-time>
conversationAssigneeGroups
(object | null)[]