HiringCenter
HiringCenter API

Schemas

Error

  • successboolean

    Optional legacy field. Some endpoints may include success=false on errors.

  • errorstring
  • messagestring
  • retryAfterinteger | null
  • missingFieldsarray | null
  • details | null

    Optional safe validation details (shape varies by endpoint)

Additional properties are allowed

ApiKeyResponse

  • successboolean · required
  • idstring · required
  • namestring · required
  • accountIdstring · required
  • permissionsstring[] · required
  • createdAtinteger · int64 · required

    Unix timestamp in milliseconds

  • activeboolean · required

NoteResponse

  • idstring
  • bodystring
  • createdAtinteger · int64

    Unix timestamp in milliseconds

  • prospectIdstring
  • userIdstring | null
  • createdByApiboolean

    True when the note was created without a userId via API.

  • createdByApiKeyIdstring | null

    API key document id used to create the note when authenticated via API key.

  • createdByApiKeyNamestring | null

    API key display name used to create the note when authenticated via API key.

  • mentionsobject[]
  • pinboolean
  • fileUrlstring | null · uri
  • successboolean
Additional properties are allowed

Prospect

  • idstring
  • messagestring | null

    Optional success message. Can include a warning when submitted phone data is invalid (for example, NANP area code/exchange starts with 0 or 1) and the prospect is still created/updated.

  • firstNamestring
  • lastNamestring
  • emailstring | null · email
  • phonestring | null
  • currentStagestring | null
  • currentStageIdstring | null
  • pipelineIdstring | null
  • labelsstring[]
  • titlestring | null
  • companystring | null
  • createdAtinteger | null · int64

    Unix timestamp in milliseconds

  • updatedAtinteger | null · int64

    Unix timestamp in milliseconds

Additional properties are allowed

Note

  • idstring
  • bodystring
  • createdAtinteger · int64

    Unix timestamp in milliseconds

  • prospectIdstring
  • userIdstring | null
  • createdByApiboolean

    True when the note was created without a userId via API.

  • createdByApiKeyIdstring | null

    API key document id used to create the note when authenticated via API key.

  • createdByApiKeyNamestring | null

    API key display name used to create the note when authenticated via API key.

  • mentionsobject[]
  • pinboolean
  • fileUrlstring | null · uri
Additional properties are allowed

Task

  • idstring
  • prospectIdstring
  • taskstring
  • assignedTostring
  • assignedBystring | null
  • createdBystring | null
  • createdAtinteger · int64

    Unix timestamp in milliseconds

  • updatedAtinteger | null · int64

    Unix timestamp in milliseconds

  • dueAtinteger | null · int64

    Unix timestamp in milliseconds

  • completedAtinteger | null · int64

    Unix timestamp in milliseconds

  • completedBystring | null
  • createdByApiboolean

    True when the task was created without a userId via API.

  • createdByApiKeyIdstring | null

    API key document id used to create the task when authenticated via API key.

  • createdByApiKeyNamestring | null

    API key display name used to create the task when authenticated via API key.

Additional properties are allowed

MeetingReview

  • statusstring | null
  • nextStepsstring | null
  • ratinginteger | null
  • feedbackstring | null
  • reviewedBystring | null
  • reviewedAtinteger | null · int64

    Unix timestamp in milliseconds

Additional properties are allowed

Meeting

  • idstring
  • prospectIdstring
  • meetingDateinteger · int64

    Unix timestamp in milliseconds

  • timeZonestring
  • meetingTypestring
  • ownerIdstring
  • locationstring | null
  • notesstring | null
  • createdBystring | null
  • createdByApiboolean

    True when the meeting was created without a userId via API.

  • createdByApiKeyIdstring | null

    API key document id used to create the meeting when authenticated via API key.

  • createdByApiKeyNamestring | null

    API key display name used to create the meeting when authenticated via API key.

  • createdAtinteger · int64

    Unix timestamp in milliseconds

  • updatedAtinteger · int64

    Unix timestamp in milliseconds

  • reviewobject | null
Additional properties are allowed

KeyName

  • keystring · required
  • namestring · required

IdName

  • idstring · required
  • namestring · required