People

Get person details

Returns details for a specific person

GET /api/3/people/{id}

Authentication

This endpoint requires authentication:

OAuth 2.0 Recommended

Use an OAuth 2.0 access token in the Authorization header. This is the recommended authentication method for all integrations. OAuth provides automatic token expiration, granular permission scopes, detailed usage tracking, and per-integration revocation. Learn how to obtain an access token.

Header Format:

Authorization: Bearer YOUR_ACCESS_TOKEN

Required Scopes:

account.person.readonly

Parameters

Path Parameters

id integer
Required

Person ID

Responses

200

Person details retrieved successfully

Response Fields

id integer required

Unique identifier for the person

eg. 12345
first_name string required

First name (required)

eg. John
last_name string required

Last name (required)

eg. Doe
salutation string | null

Salutation or title (Mr., Ms., Dr., etc.)

eg. Mr.
job_title string | null

Job title

eg. Software Engineer
email string | null

Email address (must be unique within account if provided)

eg. john.doe@example.com
organisation_id integer | null

Organisation ID

system_id string | null

External system identifier

eg. EMP-12345
department string | null

Department name

eg. Engineering
enabled boolean required

Whether the person is currently enabled for access

eg. true
valid_from string | null

Access valid from this date/time

valid_to string | null

Access valid until this date/time

image_url string | null

URL to person's full-size photo

image_thumbnail_url string | null

URL to person's thumbnail photo

telephone string | null

Telephone number

mobile string | null

Mobile number (E.164 format required if passport enabled)

eg. +14155551234
notes string | null

Additional notes

barcode string | null

Barcode identifier

custom_1 string | null

Custom field 1

custom_2 string | null

Custom field 2

custom_3 string | null

Custom field 3

custom_4 string | null

Custom field 4

custom_5 string | null

Custom field 5

created_at string

Timestamp of creation

updated_at string

Timestamp of last update

groups array<integer> required

Array of group IDs this person belongs to

eg. [1, 3, 5]
roles array<integer> required

Array of role IDs assigned to this person

eg. [2, 4]
401

Unauthorized - Invalid or missing authentication

Response Fields

error string
eg. unauthorized
error_description string
eg. The access token is invalid
403

Forbidden - User does not have permission

Response Fields

error string
eg. forbidden
error_description string
eg. You are not authorized to access this resource
404

Not Found - Resource does not exist or is not an admission request event

Response Fields

error string
eg. not_found
error_description string
eg. The requested resource was not found
500

Internal Server Error

Response Fields

error string
eg. internal_server_error
error_description string
eg. An unexpected error occurred

Mentioned in Guides

This endpoint is used in the following guides:

Core Resources Reference

Quick reference for People, Credentials, Channels, Groups, and Roles

Core Concepts • 5 min • Beginner

Employee Onboarding Workflow

Complete code to onboard new employees with card and PIN in 7 minutes

Common Workflows • 7 min • Intermediate

Employee Offboarding Workflow

Revoke access when employees leave while maintaining audit trail in 5 minutes

Common Workflows • 5 min • Beginner

HTTP Status Codes

Understanding API response codes and error formats in 5 minutes

API Best Practices • 5 min • Beginner

Error Handling & Retries

Handle errors gracefully with complete error code reference and retry strategies

API Best Practices • 15 min • Intermediate

Request

curl -X GET \
  "https://api.doorflow.com/api/3/people/{id}" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Responses

Person details retrieved successfully

{
  "id": 12345,
  "first_name": "John",
  "last_name": "Doe",
  "salutation": "Mr.",
  "job_title": "Software Engineer",
  "email": "john.doe@example.com",
  "organisation_id": 0,
  "system_id": "EMP-12345",
  "department": "Engineering",
  "enabled": true,
  "valid_from": "string",
  "valid_to": "string",
  "image_url": "string",
  "image_thumbnail_url": "string",
  "telephone": "string",
  "mobile": "+14155551234",
  "notes": "string",
  "barcode": "string",
  "custom_1": "string",
  "custom_2": "string",
  "custom_3": "string",
  "custom_4": "string",
  "custom_5": "string",
  "created_at": "string",
  "updated_at": "string",
  "groups": [
    0
  ],
  "roles": [
    0
  ]
}