Get one person's role at a company

View as Markdown

Returns one entity-scoped association detail. Public results hide associations to hidden entities; callers with private-visibility authority can include them.

Path parameters

entityIdstringRequiredformat: "uuid"
Entity UUID
associationIdintegerRequired
Association id

Query parameters

searchstringOptional
Search term filter
rolestringOptional

Match the complete titleName, ignoring case (for example, Co-Founder & CEO). Omit to include all titles; this does not filter titleFunction or titleLevel.

isCurrentbooleanOptional
Current association filter
includeUrlbooleanOptional
Include person URL records
includeAddressbooleanOptional
Include person address records
personSlugstringOptional

Person slug fallback for entity-keyed writes

countOnlybooleanOptional
Return count metadata without full content
permitMonogrambooleanOptional
Permit generated monogram fallback
includePrivatebooleanOptional

Includes associations on hidden entities when the caller has private-visibility authority. Omit to use the caller’s default visibility.

Response headers

X-RateLimit-Limitinteger

Requests allowed per client IP in the current rate-limit window.

X-RateLimit-Remaininginteger

Requests left before the tightest applicable rate-limit bucket rejects.

X-RateLimit-Resetinteger

Seconds until the exhausted rate-limit bucket admits another request; 0 when none is exhausted.

Response

OK
associationIdinteger

Integer person-entity association join row id, not a person or entity UUID

entityAddresslist of objects
Entity addresses carried on the association projection
entityIdstringformat: "uuid"
Associated entity id
entitySlugstringformat: "^[a-z0-9_-]+$"<=255 characters
Canonical lowercase URL slug for the resource
personAddresslist of objects
Person addresses carried on the association projection
personIdstringformat: "uuid"
Associated person id
personImageobject
Person image projection
personNamestring
personSlugstringformat: "^[a-z0-9_-]+$"<=255 characters
Canonical lowercase URL slug for the resource
endDatedatetime or nullOptional
Association period end timestamp
entityNamestring or nullOptional
entityOperatingStatusstring or nullOptional
entityTypeenum or nullOptional
Entity type classification
isCurrentboolean or nullOptional
scoreinteger or nullOptional
startDatedatetime or nullOptional
Association period start timestamp
titleFunctionstring or nullOptional

Read-side corporate title function for the association row

titleIdinteger or nullOptional
Corporate title id for the association row
titleLevelstring or nullOptional

Read-side corporate title level for the association row

titleNamestring or nullOptional

Read-side corporate title text for the association row

Errors

400
Bad Request Error
404
Not Found Error
406
Not Acceptable Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error