v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB
Jobs

Get Job Activity Types

Returns a list of available job activities that can be logged for a talent and their details.

get/v1/job-activity/types

Headers

RequestIdstring uuid

The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.

Unique request identifier (UUID) used to correlate request data with log entries and events.

FrontOfficeTenantIdinteger

An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.

Tenantstring

Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.

Response

A list of job activity types.

act_type_idinteger

The identifier for the activity type.

act_type_namestring

The name of the activity type.

act_type_subtypestring

The subtype of the activity type.

build_idinteger

The identifier for the build.

act_type_orderinteger

Numeric order for the activity type in the list.

is_nomboolean

An indication of whether the activity type is a talent job nomination stage (Talent Stage) or not.

is_pipeboolean

An indication of whether the activity type is a talent job pipeline stage or not.

is_webboolean

An indication of whether the activity type is for a web application or not.

manager_viewboolean

An indication of whether the hiring manager can view the activity type or not.

create_datestring date-time

The date the job activity type was created. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats and also supports fractional seconds, such as YYYY-MM-DDTHH:mm:ss.sss. For example, 2024-12-01, 2024-12-01T14:30:00, and 2024-12-01T14:30:00.546.

stage_archiveboolean

An indication of whether an activity type has been archived or not.

is_vendboolean

An indication of whether the activity type is for a vendor or not.

is_declineboolean

An indication of whether the type represents a "declined" activity or not.

is_falloutboolean

An indication of whether it is an Early Termination Reason activity type or not.

is_extensionboolean

An indication of whether it is a job extension activity or not.

is_convertToPermboolean

An indication of whether the activity is to convert a job to a permanent job or not.

old_idinteger

This property should be ignored.

Example response

[
  {
    "act_type_id": 12345,
    "act_type_name": "Submitted",
    "act_type_subtype": "General",
    "build_id": 796,
    "act_type_order": 1,
    "is_nom": true,
    "manager_view": true
  }
]