Skip to navigation

Get One Person's Role at a Company

View as Markdown
Returns one person's role at a company.

Authentication

AuthorizationBearer

Your aVenture API key (https://aventure.vc/settings/api-keys) or OAuth access token

Path parameters

entityIdstringRequiredformat: "uuid"
Entity UUID
associationIdintegerRequired
Association id

Query parameters

searchstringOptional
Search term filter
rolestringOptional

Match titleName containing this text as a whole-word phrase, ignoring case: founder matches Co-Founder, Founder & CEO, and CEO and Co-Founder, but not Founding Partner. 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

Writes only: the person’s slug when the body omits personId. List reads ignore it; use search to narrow listed people.

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

Response headers

X-RateLimit-LimitintegerOptional

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

X-RateLimit-RemainingintegerOptional

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

X-RateLimit-ResetintegerOptional

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

The entity’s addresses. Person detail includes 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
Lowercase URL slug that identifies the record.
personAddresslist of objects
The person's addresses.
personIdstringformat: "uuid"
Associated person id
personImageobject
The person's image fields.
personNamestring
personSlugstringformat: "^[a-z0-9_-]+$"<=255 characters
Lowercase URL slug that identifies the record.
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

entityIsPublicboolean or nullOptional

Whether the employer page is readable; false: show name unlinked

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

Job function of the title (read-only).

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

Seniority level of the title (read-only).

titleNamestring or nullOptional

Job title text for this role (read-only).

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden 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