Skip to navigation
aVenture APICompaniesEntity Person Associations

Get One of a Person's Roles at a Company

View as Markdown

Returns one person-scoped association join row.

Path parameters

personIdstringRequiredformat: "uuid"
Person UUID
associationIdintegerRequired
Association id

Query parameters

includeUrlbooleanOptional
Include entity URL records
includeAddressbooleanOptional

Include entity address records (pass false to omit)

permitMonogrambooleanOptional
Permit generated monogram logo fallback

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. Person detail carries at most one: the entity’s current headquarters, else its most recently updated current address; GET /v1/entities/{entityId}/addresses lists them all

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
endDatestring or nullOptionalformat: "^(?!0000)[0-9]{4}(?:-(?:0[1-9]|1[0-2])(?:-(?:0[1-9]|[12][0-9]|3[01])(?:T(?:[01][0-9]|2[0-3]):[0-5][0-9](?::[0-5][0-9](?:\.[0-9]{1,9})?)?(?:Z|[+-](?:(?:0[0-9]|1[0-7]):[0-5][0-9]|18:00)))?)?)?$"

Association period end, preserving source precision; any value means the association ended and isCurrent is false. Absent only while not terminated

entityNamestring or nullOptional
entityOperatingStatusstring or nullOptional
entityTypeenum or nullOptional
Entity type classification
isCurrentboolean or nullOptional

True only while the association has no endDate; any endDate means it ended

scoreinteger or nullOptional
startDatestring or nullOptionalformat: "^(?!0000)[0-9]{4}(?:-(?:0[1-9]|1[0-2])(?:-(?:0[1-9]|[12][0-9]|3[01])(?:T(?:[01][0-9]|2[0-3]):[0-5][0-9](?::[0-5][0-9](?:\.[0-9]{1,9})?)?(?:Z|[+-](?:(?:0[0-9]|1[0-7]):[0-5][0-9]|18:00)))?)?)?$"
Association period start, preserving source precision
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