HiringCenter
HiringCenter API

Schemas

Error

  • errorstring

    Short machine-readable category or reason phrase for the failure.

  • messagestring

    Human-readable explanation of what went wrong.

  • retryAfterinteger | null

    Seconds to wait before retrying, typically returned for rate limiting.

  • missingFieldsarray | null

    Request field names that must be provided for the request to succeed.

  • 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
  • accountNamestring | null

    Human-readable account name when available.

ApiListPagination

  • nextPageTokenstring | null

    Opaque pagination token for the next page when cursor pagination is supported.

  • totalCountinteger

    Total matching items when available for this resource.

ProspectResponse

  • successboolean · required
  • itemobject · required
    Example: {"id":"c1a7e9d34b8f4c2aa6d15e0f7b3c9d42","message":null,"firstName":"Avery","lastName":"Coleman","email":"avery.coleman@example.com","phone":"+15551234567","currentStage":"New Lead","currentStageId":"9a3d7c1e4b2f48d6a5c0e1f9b7d2a346","pipelineId":"3d9a1c7e4b2f46d8a5c0e1f9b7d2a348","labels":["Hot","Inbound"],"title":"Sales Manager","company":"Northwind Health","createdAt":1717000000000,"updatedAt":1717003600000}
Additional properties are allowed

NoteResponse

  • successboolean · required
  • itemobject · required
    Example: {"id":"d8b2c7a14e9f4d3ab6c05e1f9a7d2c48","body":"<p>Left voicemail and sent a follow-up email.</p>","createdAt":1717007200000,"prospectId":"c1a7e9d34b8f4c2aa6d15e0f7b3c9d42","userId":"b2e7a1d94c3f4a8eb6d05c1f9a7e2d45","createdByApi":false,"createdByApiKeyId":null,"createdByApiKeyName":null,"mentions":[{"userId":"b2e7a1d94c3f4a8eb6d05c1f9a7e2d45","displayName":"Jamie Lee"}],"pin":true,"fileUrl":null}
Additional properties are allowed

TaskResponse

  • successboolean · required
  • itemobject · required
    Example: {"id":"e3f9a1c74b2d4e8aa6d05c1f7b9e2d43","prospectId":"c1a7e9d34b8f4c2aa6d15e0f7b3c9d42","task":"Call prospect after webinar","assignedTo":"b2e7a1d94c3f4a8eb6d05c1f9a7e2d45","assignedBy":"b2e7a1d94c3f4a8eb6d05c1f9a7e2d45","createdBy":"b2e7a1d94c3f4a8eb6d05c1f9a7e2d45","createdAt":1717010800000,"updatedAt":1717010900000,"dueAt":1717097200000,"completedAt":null,"completedBy":null,"createdByApi":false,"createdByApiKeyId":null,"createdByApiKeyName":null}
Additional properties are allowed

ProspectListResponse

  • successboolean · required
  • itemsobject[] · required
  • paginationobject · required

    Pagination metadata. Fields are included only when that resource supports them.

    Example: {"nextPageToken":"eyJpZCI6InRhc2tfMDFIVjZXNldSNU44SzJNNFQ3WTlQMUMifQ==","totalCount":125}
Additional properties are allowed

NoteListResponse

  • successboolean · required
  • itemsobject[] · required
  • paginationobject · required

    Pagination metadata. Fields are included only when that resource supports them.

    Example: {"nextPageToken":"eyJpZCI6InRhc2tfMDFIVjZXNldSNU44SzJNNFQ3WTlQMUMifQ==","totalCount":125}
Additional properties are allowed

TaskListResponse

  • successboolean · required
  • itemsobject[] · required
  • paginationobject · required

    Pagination metadata. Fields are included only when that resource supports them.

    Example: {"nextPageToken":"eyJpZCI6InRhc2tfMDFIVjZXNldSNU44SzJNNFQ3WTlQMUMifQ==","totalCount":125}
Additional properties are allowed

MeetingResponse

  • successboolean · required
  • itemobject · required
    Example: {"id":"f4d8a2c17b9e4f3aa6c01d5e7b2f9c44","prospectId":"c1a7e9d34b8f4c2aa6d15e0f7b3c9d42","meetingDate":1717170000000,"timeZone":"America/New_York","meetingType":"virtual","ownerId":"b2e7a1d94c3f4a8eb6d05c1f9a7e2d45","location":"Zoom","notes":"Review benefits package and next interview steps.","createdBy":"b2e7a1d94c3f4a8eb6d05c1f9a7e2d45","createdByApi":false,"createdByApiKeyId":null,"createdByApiKeyName":null,"createdAt":1717014400000,"updatedAt":1717014400000,"review":null}
Additional properties are allowed

MeetingListResponse

  • successboolean · required
  • itemsobject[] · required
  • paginationobject · required

    Pagination metadata. Fields are included only when that resource supports them.

    Example: {"nextPageToken":"eyJpZCI6InRhc2tfMDFIVjZXNldSNU44SzJNNFQ3WTlQMUMifQ==","totalCount":125}
Additional properties are allowed

Account

  • idstring
  • namestring | null
  • timeZonestring | null
Additional properties are allowed

AccountResponse

  • successboolean · required
  • itemobject · required
    Example: {"id":"6b3e1a9d4c7f42e8a5d0c1f9b2e7a4c6","name":"Northwind Recruiting","timeZone":"America/New_York"}
Additional properties are allowed

KeyNameListResponse

  • successboolean · required
  • itemsobject[] · required
  • paginationobject · required

    Pagination metadata. Fields are included only when that resource supports them.

    Example: {"nextPageToken":"eyJpZCI6InRhc2tfMDFIVjZXNldSNU44SzJNNFQ3WTlQMUMifQ==","totalCount":125}
Additional properties are allowed

IdNameListResponse

  • successboolean · required
  • itemsobject[] · required
  • paginationobject · required

    Pagination metadata. Fields are included only when that resource supports them.

    Example: {"nextPageToken":"eyJpZCI6InRhc2tfMDFIVjZXNldSNU44SzJNNFQ3WTlQMUMifQ==","totalCount":125}
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

ZapierProspectPollRecord

  • idstring
  • first_namestring
  • last_namestring
  • emailstring | null
  • phonestring | null
  • titlestring | null
  • companystring | null
  • street_addressstring
  • citystring
  • statestring
  • postal_codestring
  • countrystring
  • latitudenumber | null
  • longitudenumber | null
  • time_zonestring
  • stage_idstring
  • stage_namestring
  • pipeline_idstring
  • pipeline_namestring
  • office_idstring
  • office_namestring
  • source_idstring
  • source_namestring
  • owner_idstring
  • owner_namestring
  • owner_emailstring
  • labelsstring[]
  • license_statusstring
  • created_atstring | null · date-time
  • updated_atstring | null · date-time
  • starredboolean
  • completed_meetingboolean
  • incomplete_meetingboolean
  • past_meetingboolean
  • upcoming_meetingboolean
  • due_taskboolean
  • future_taskboolean
  • urlstring
  • account_idstring
  • has_emailboolean
  • has_phoneboolean
Additional properties are allowed

KeyName

  • keystring · required
  • namestring · required

IdName

  • idstring · required
  • namestring · required