BizCARE MyInvois
Shopify Integration/User Management

Get User

Retrieve detailed information about a specific user

Get User

Retrieve detailed information about a specific user, including their organization memberships and relationships.

Endpoint

GET /api/integrations/users/{id}

Path Parameters

ParameterTypeRequiredDescription
idstringYesThe unique identifier of the user

Response Format

{
  "id": "user-123",
  "name": "John Doe",
  "firstName": "John",
  "lastName": "Doe",
  "email": "john@example.com",
  "phone": "+1234567890",
  "dob": "1990-05-15",
  "role": "customer",
  "members": [
    {
      "id": "member-456",
      "organizationId": "org-789",
      "role": "admin",
      "createdAt": "2024-01-15T10:30:00Z"
    }
  ],
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z"
}

Examples

Basic Request

curl -X GET "https://api.example.com/api/integrations/users/user-123" \
  -H "X-Invois-Key: your-api-key-here"

JavaScript Example

const response = await fetch('https://api.example.com/api/integrations/users/user-123', {
  method: 'GET',
  headers: {
    'X-Invois-Key': 'your-api-key-here',
    'Content-Type': 'application/json'
  }
});

const user = await response.json();
console.log(user);

Error Responses

  • 401 Unauthorized - Invalid or missing API key
  • 404 Not Found - User not found
  • 429 Too Many Requests - Rate limit exceeded

User Roles

Users can have one of the following roles:

  • super-admin - Full system access
  • admin - Administrative access
  • customer - Standard user access

Organization Memberships

The members array contains information about the user's organization memberships, including:

  • Organization ID
  • Role within the organization
  • Membership creation date

Next Steps