API documentation | API docs for agents | OpenAPI 3.1
GET /api/v1/people/{personId}
ark.get_person
Returns one carrier driver or dispatcher contact by underlying ARK person ID.
- Availability
- Core preview
- Scopes
people:read- ARK permissions
canViewPeople- Team visibility
- Not entity-scoped
- Idempotency-Key
- Not required
- Approval
- No MCP approval on REST API-token calls
- Rate limit
- API credential and organization budgets
Parameters
personIdpathstringrequired- Underlying ARK person ID.
- format: uuid
typequeryPersonType
Request body
None.
Example request
Shell
curl 'https://arktms.com/api/v1/people/<personId>' \
-H "Authorization: Bearer $ARK_API_TOKEN"Success response
Person detail
objectstringrequiredone of: api_response
okbooleanrequiredone of: true
api_versionstringrequiredone of: 2026-05-31
request_idstringrequireddataobjectrequireddata.typestringrequiredone of: driver, dispatcher
data.recordIdstringrequiredDriver or dispatcher table record ID.
format: uuid
data.personIdstringrequiredUnderlying ARK person ID used for get/update/delete.
format: uuid
data.firstNamestring | nullrequireddata.lastNamestring | nullrequireddata.emailstring | nullrequireddata.phonestring | nullrequireddata.notesstring | nullrequireddata.carrierobject | nullrequireddata.hasAppAccountboolean | nullrequiredDriver mobile-app account flag. Null for dispatchers.
data.userIdstring | nullrequiredformat: uuid
data.createdAtstring | nullrequiredformat: date-time
data.modifiedAtstring | nullrequiredformat: date-time
Errors
HTTP 400- Invalid request
HTTP 401- Authentication required
HTTP 403- Permission, scope, team, or entitlement denied
HTTP 404- Resource not found