HiringCenter
HiringCenter API

Account

Endpoint:https://api.hiringcenterpro.com/v2

Account configuration and dropdown metadata


Get Account Configuration

GET
https://api.hiringcenterpro.com/v2
/account

Accepts an optional include query string to request specific account sections, loads account configuration for the authenticated tenant, and returns it in item.

Get Account Configurationquery Parameters

  • includestring

    Comma-separated list of sections to include

    Example: branding,notifications

Get Account Configuration Responses

OK

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

List Account Stages (for dynamic dropdowns)

GET
https://api.hiringcenterpro.com/v2
/account/stages

Accepts an optional pipelineId filter, lists stage options available to the authenticated account, and returns them using the standard list envelope.

List Account Stages (for dynamic dropdowns)query Parameters

  • pipelineIdstring
    Example: 3d9a1c7e4b2f46d8a5c0e1f9b7d2a348

List Account Stages (for dynamic dropdowns) Responses

OK

  • 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

List Account Pipelines (for dynamic dropdowns)

GET
https://api.hiringcenterpro.com/v2
/account/pipelines

Accepts authenticated account context, loads configured prospect pipelines, and returns them using the standard list envelope.

List Account Pipelines (for dynamic dropdowns) Responses

OK

  • 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

List Account Sources (for dynamic dropdowns)

GET
https://api.hiringcenterpro.com/v2
/account/sources

Accepts authenticated account context, fetches configured lead/prospect sources, and returns them using the standard list envelope.

List Account Sources (for dynamic dropdowns) Responses

OK

  • 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

List Account Offices (for dynamic dropdowns)

GET
https://api.hiringcenterpro.com/v2
/account/offices

Accepts authenticated account context, retrieves configured office values, and returns them using the standard list envelope.

List Account Offices (for dynamic dropdowns) Responses

OK

  • 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