Skip to main content
POST
GetCrewProfile

Authorizations

Authorization
string
header
required

Personal API key, sent as Authorization: Bearer <key>.

Headers

Connect-Protocol-Version
number
required

Define the version of the Connect protocol

Example:

1

Connect-Timeout-Ms
number

Define the timeout, in ms

Example:

1000

Body

application/json

Request to get a crew profile

crewProfileId
string<uuid>

ID of the crew profile to retrieve

Response

Success

Response for retrieving a single crew profile

id
string

ID of the crew profile

organizationId
string

ID of the organization the crew profile belongs to

primaryEmail
string

Primary email address of the crew member

givenName
string | null

Given name (first name) of the crew member

familyName
string | null

Family name (last name) of the crew member

createdAt
string<date-time>

Timestamp when the profile was created

Example:

"2023-01-15T01:30:15.01Z"

updatedAt
string<date-time>

Timestamp when the profile was updated

Example:

"2023-01-15T01:30:15.01Z"

printInfo
print_info · object

print info field

isArchived
boolean

whether the crew profile is archived

archivedAt
string<date-time> | null

A point in time in RFC 3339 format, with up to nanosecond precision. Output uses UTC (Z); input may use an offset from UTC.

Example:

"2023-01-15T01:30:15.01Z"

submissionCount
string<int64> | null

number of times the candidate submitted for this job

primaryPhoneE164
string | null

primary phone number in E.164 format, if known

tags
CrewTag · object[]

tags assigned to this crew profile

emailFrom
enum<string>

how primary_email was determined for this profile

Available options:
CREW_PROFILE_EMAIL_SOURCE_UNSPECIFIED,
CREW_PROFILE_EMAIL_SOURCE_FROM_DOCUMENTS,
CREW_PROFILE_EMAIL_SOURCE_FROM_LATEST_APPLICATION,
CREW_PROFILE_EMAIL_SOURCE_PLACEHOLDER
source
enum<string>

how this candidate first entered the system

Available options:
ENTRY_SOURCE_UNSPECIFIED,
ENTRY_SOURCE_CAREER_SITE,
ENTRY_SOURCE_MANUAL,
ENTRY_SOURCE_EMAIL
sourceId
string | null

id of the originating record: job application, email receipt or manual upload. empty when there is no such record

proposalIds
string[]

ids of the proposals this crew profile is already part of