v1/external_record_mappings

get

https://shyftplan.com/api/v1/external_record_mappings

List all external record mappings. A mapping links the object's ID from a foreign system with the ID in shyftplan

Query Params

user_email

string

required

This is a testing sandbox. We advise against using credentials for production accounts here.

E-mail address of the API user.

authentication_token

string

required

This is a testing sandbox. We advise against using credentials for production accounts here.

Authentication token - can be fetched by login action.

company_id

int32

required

≥ 1

ID of a shyftplan account.

foreign_ids[]

array of strings

Collection of foreign IDs that shall be retrieved (filter)

foreign_ids[]

foreign_types[]

array of objects

Collection of foreign types for which mappings shall be retrieved (filter). Currently, the available options are 'shyftconnect', 'personio' and 'success_factors'.

foreign_types[]

Allowed:

shyftplan_ids[]

array of int32s

Collection of shyftplan IDs that shall be retrieved (filter). Each ID must belong to a shyftplan object of one of these resource types: Absence, AbsenceReason, AdminEvaluation, Employment, EmploymentsRotationGroup, Evaluation, EvaluationBreak, Location, LocationsPosition, Position, Qualification, QualificationCategory, Shift, ShiftBreak, ShiftPreset, ShiftRotation, ShiftRotationGroup, StaffShift, Tag.

shyftplan_ids[]

shyftplan_types[]

array of strings

Collection of object types in shyftplan for which mappings shall be retrieved. Available types are: Absence, AbsenceReason, AdminEvaluation, Employment, EmploymentsRotationGroup, Evaluation, EvaluationBreak, Location, LocationsPosition, Position, Qualification, QualificationCategory, Shift, ShiftBreak, ShiftPreset, ShiftRotation, ShiftRotationGroup, StaffShift, Tag.

shyftplan_types[]

Responses

200Successfully listed

401Unauthorized

403Forbidden

404Company not found

422Invalid request