v1

latestOpenAPI 3.1.02026-07-24770322.0 KB

Retrieve Internal User

This API endpoint retrieves a specific internal user.

get/v1/internal-users/{id}

Path parameters

idstring required

The unique ID of the internal user to retrieve.

Response

200

idstring

objectstring

createdAtstring

givenNamestring

familyNamestring

emailstring

rolestring

fallbackColorstring

isClientAccessLimitedboolean

companyAccessListstring[]

avatarImageUrlstring

updatedAtstring

Example response

{
  "id": "a34b3206-c567-4185-aad5-124ef6ea2b0b",
  "object": "internalUser",
  "createdAt": "2023-06-23T14:40:29.632217267Z",
  "givenName": "Ari",
  "familyName": "Quinones",
  "email": "ari@copilot.app",
  "role": "admin",
  "fallbackColor": "#3294AE",
  "isClientAccessLimited": true,
  "companyAccessList": [
    "00d31640-a863-44a1-a844-5b3a16f72bb0"
  ],
  "avatarImageUrl": "https://lightout-portal.s3-accelerate.amazonaws.com/public/us-east-1_5EDZq5vNS/images/profile_pictures/512452-9524"
}