Users

Planhat Users API

Sync permissioned users data with Planhat through Apideck's unified API. One integration, instant access to the governed data your team needs.

Supported Operations for Planhat Users

Full CRUD support available through our unified API

list

get

create

update

delete

Supported Fields

8 fields

Fields available for Planhat Users

idusernamefirst_namelast_nameimagestatusemailscreated_at

API Model Preview

Sample response structure for users

{
  "id": "12345",
  "username": "Example Username",
  "first_name": "Example First Name",
  "last_name": "Example Last Name",
  "image": "string",
  "status": "active",
  "emails": [
    {
      "id": "12345",
      "email": "contact@example.com",
      "type": "primary"
    }
  ],
  "created_at": "2024-01-15T10:30:00.000Z"
}

Quick Start Example

Start syncing Planhat users in minutes

Node.js

import { Apideck } from '@apideck/unify'

const apideck = new Apideck({
  apiKey: process.env.APIDECK_API_KEY,
  appId: 'YOUR_APP_ID',
  consumerId: 'YOUR_CONSUMER_ID'
})

// List users from Planhat
const result = await apideck.crm.users.list({
  serviceId: 'planhat'
})

for await (const page of result) {
  console.log(page)
}
// Returns unified users data

View full SDK documentation