v1
latestOpenAPI 3.0.12026-07-245752052.0 MBshifts
find one shift
Find one shift by its unique identifier.
get/api/serviceattendance/shifts/{identifier}
Path parameters
identifierstring uuid required
shift unique identifier
Response
One shift document found. Wrapped in a JsonAPI root response with document as data.
Example response
{
"data": {
"uuid": "f4428d27-c089-40c4-aa83-ce02e1ee1426",
"createdAt": "2021-05-05T01:02:03.924Z",
"createdBy": "1e4e9128-fbb2-4b0a-97fc-f65bb1efee55",
"lastUpdatedAt": "2021-05-05T04:05:06.924Z",
"lastUpdatedBy": "7097bb82-61bd-4724-82ac-eab598190e47",
"lastUpdatedByAudience": "employer",
"lastUpdatedByAudienceUuid": "68df4316-590a-4081-9f24-9d9311977c9d",
"lastUpdatedByImpersonatedBy": "3462e1d4-0e27-4798-b4a2-76412ab21892",
"lastUpdatedByCompanyUuid": "d310aada-b1ad-4e9a-b822-b90c3cdb65bb",
"lastUpdatedByEnterpriseUuid": "a6420cdc-285a-4f75-8ccc-8edff6d60c0a",
"workerUuid": "79b30b2b-eea5-410f-b994-b01be9fa4f40",
"companyUuid": "cf8fc0c8-b8e7-4337-992e-8f71d67bdf5b",
"locationUuid": "4e177905-352c-41e6-9c57-2e2bba6d23ee",
"startTime": "2017-07-21T17:32:28Z",
"endTime": "2017-07-21T17:32:28Z",
"jobUuid": "84d596aa-d93d-4779-9725-231d6b1f756f",
"breaks": [
{
"uuid": "9513a50f-412a-4a83-a2cb-e74f0d9389be",
"startTime": "2017-07-21T17:32:28Z",
"endTime": "2017-07-21T17:32:28Z",
"type": "automatic_break",
"automaticBreakRuleUuid": "a1b2c3d4-e5f6-7890-abcd-1234567890ef",
"removedAt": "2021-05-05T01:02:03.924Z",
"removedBy": "a1b2c3d4-e5f6-7890-abcd-1234567890ef"
}
],
"state": "draft",
"seenAt": "1995-12-05T20:32:28Z",
"nextVersion": {
"workerUuid": "79b30b2b-eea5-410f-b994-b01be9fa4f40",
"startTime": "2017-07-21T17:32:28Z",
"endTime": "2017-07-21T17:32:28Z",
"jobUuid": "84d596aa-d93d-4779-9725-231d6b1f756f",
"locationUuid": "b3704000-a9b7-4138-ac00-d2541cf3e39f",
"breaks": [
{
"uuid": "9513a50f-412a-4a83-a2cb-e74f0d9389be",
"startTime": "2017-07-21T17:32:28Z",
"endTime": "2017-07-21T17:32f:28Z"
}
],
"state": "draft",
"virtualWorker": {
"uuid": "f4428d27-c089-40c4-aa83-ce02e1ee1426",
"createdAt": "2021-05-05T01:02:03.924Z",
"createdBy": "1e4e9128-fbb2-4b0a-97fc-f65bb1efee55",
"lastUpdatedAt": "2021-05-05T04:05:06.924Z",
"lastUpdatedBy": "7097bb82-61bd-4724-82ac-eab598190e47",
"lastUpdatedByAudience": "employer",
"lastUpdatedByAudienceUuid": "68df4316-590a-4081-9f24-9d9311977c9d",
"lastUpdatedByImpersonatedBy": "3462e1d4-0e27-4798-b4a2-76412ab21892",
"lastUpdatedByCompanyUuid": "d310aada-b1ad-4e9a-b822-b90c3cdb65bb",
"lastUpdatedByEnterpriseUuid": "a6420cdc-285a-4f75-8ccc-8edff6d60c0a",
"firstname": "Alice",
"lastname": "Doe",
"middlename": "Elizabeth",
"displayFullName": "Alice Doe",
"dashboardUrl": {
"slug": "alice-doe-2002",
"baseUrl": "https://employees.mcdonalds.com/"
},
"personalEmail": {
"email": "alice.doe@gmail.com",
"verified": true,
"verifiedAt": "2023-03-24T00:00:00.000Z"
},
"workEmail": {
"email": "alice.doe@fountain.com",
"verified": true,
"verifiedAt": "2023-03-24T00:00:00.000Z"
},
"mobilePhone": {
"number": "+331234567890",
"countryCode": "FR",
"verified": true,
"verifiedAt": "2023-03-24T00:00:00.000Z"
},
"whatsAppPhone": {
"number": "+521234567890",
"countryCode": "MX",
"verified": true,
"verifiedAt": "2025-03-09T00:00:00.000Z"
},
"homePhone": {
"number": "+331234567890",
"countryCode": "FR",
"verified": true,
"verifiedAt": "2023-03-24T00:00:00.000Z"
},
"homeAddress": {
"address1": "55 rue du Faubourg-Saint-Honoré",
"address2": "Palais de l'Elysée",
"city": "Paris",
"zip": "75008",
"state": "Île-de-France",
"country": "France"
},
"timezone": "Europe/Paris",
"locale": "fr-FR",
"companyUuid": "2ac58bbf-1e6c-4ab8-a614-350acea0e945",
"company": {
"uuid": "2ac58bbf-1e6c-4ab8-a614-350acea0e945",
"name": "My Company",
"slug": "my-company-a650bcf2"
},
"jobUuid": "0387e696-0285-4b6b-8ffc-04d85c13d547",
"job": {
"uuid": "0387e696-0285-4b6b-8ffc-04d85c13d547",
"name": "Candle Sniffer",
"description": "Sniffer of Candles"
},
"jobIdentifiers": [
{
"jobUuid": "e1e3da43-915e-4ed9-97dc-175f458821ac",
"relationship": "primary"
}
],
"jobs": [
{
"uuid": "0387e696-0285-4b6b-8ffc-04d85c13d547",
"name": "Candle Sniffer",
"description": "Sniffer of Candles",
"allowUnscheduledShift": true
}
],
"brand": {
"name": "Pizza Hut"
},
"einUuid": "815deb86-f758-449f-87cd-81a3d7699296",
"ein": {
"uuid": "12-3456789",
"label": "Cool Company - Paris"
},
"locationUuid": "e3425972-86df-4384-9f40-8de005ba30b0",
"locationUuids": [
"e3425972-86df-4384-9f40-8de005ba30b0"
],
"locations": [
{
"uuid": "f4428d27-c089-40c4-aa83-ce02e1ee1426",
"createdAt": "2021-05-05T01:02:03.924Z",
"createdBy": "1e4e9128-fbb2-4b0a-97fc-f65bb1efee55",
"lastUpdatedAt": "2021-05-05T04:05:06.924Z",
"lastUpdatedBy": "7097bb82-61bd-4724-82ac-eab598190e47",
"lastUpdatedByAudience": "employer",
"lastUpdatedByAudienceUuid": "68df4316-590a-4081-9f24-9d9311977c9d",
"lastUpdatedByImpersonatedBy": "3462e1d4-0e27-4798-b4a2-76412ab21892",
"lastUpdatedByCompanyUuid": "d310aada-b1ad-4e9a-b822-b90c3cdb65bb",
"lastUpdatedByEnterpriseUuid": "a6420cdc-285a-4f75-8ccc-8edff6d60c0a",
"name": "San Francisco",
"description": "Nostrud est ea aliqua laborum nostrud magna ipsum sunt quis mollit nisi fugiat ipsum.",
"street_address": "275 Sacramento St",
"address_2": "Unit 2",
"city": "San Francisco",
"state_code": "California",
"postal_code": "94105",
"country_code": "US",
"locationNotes": "Locker code: 21ABBS",
"timezone": "America/San_Francisco",
"language": "en_US",
"externalLocation": {
"source": "hire",
"externalCreatedAt": "2021-05-05T01:02:03.924Z"
}
}
],
"tags": [
{
"uuid": "7dcf6728-adf5-4c8c-b098-334b68b64ebe",
"name": "some tag"
}
],
"people": {
"uuid": "6d5d014f-f118-4fbd-83f1-7baac578c123",
"index": 1,
"reasons": [
"ssn"
]
},
"rehire": {
"isRehire": true,
"uuid": "6d5d014f-f118-4fbd-83f1-7baac578c123",
"reasons": [
"forcedFromAttribute"
]
},
"externalId": "6d5d014f-f118-4fbd-83f1-7baac578c123",
"externalSource": "UKG",
"externalSourceAccount": "fountain-sandbox",
"applicantId": "6d5d014f-f118-4fbd-83f1-7baac578c123",
"applicantSource": "Fountain Hire",
"backgroundCheckYardstikCandidateId": "6d5d014f-f118-4fbd-83f1-7baac578c123",
"dateOfBirth": "1987-12-24",
"startDate": "2023-04-26",
"hireDate": "2023-04-24",
"terminationDate": "2023-04-30",
"firstSeenAt": "2023-04-24T00:00:00.000Z",
"lastSeenAt": "2023-04-25T00:00:00.000Z",
"employmentStatus": {
"type": "inactive",
"subtype": "furloughed",
"lastStatusUpdateDate": "2023-04-25T00:00:00.000Z"
},
"avatar": "https://i.pravatar.cc/500",
"manager": {
"uuid": "887436c5-47f4-43cc-963a-1d1d4e21f665",
"displayFullName": "Bob LeBoss"
},
"customAttributes": [
{
"customAttributeUuid": "887436c5-47f4-43cc-963a-1d1d4e21f665",
"value": "wanna work",
"customAttribute": {
"uuid": "8223636c5-47f4-43cc-963a-1d1d4e22b665",
"createdAt": "2021-05-05T01:02:03.924Z",
"createdBy": "1e4e9128-fbb2-4b0a-97fc-f65bb1efee55",
"lastUpdatedAt": "2021-05-05T04:05:06.924Z",
"lastUpdatedBy": "7097bb82-61bd-4724-82ac-eab598190e47",
"lastUpdatedByAudience": "employer",
"lastUpdatedByAudienceUuid": "68df4316-590a-4081-9f24-9d9311977c9d",
"lastUpdatedByImpersonatedBy": "3462e1d4-0e27-4798-b4a2-76412ab21892",
"lastUpdatedByCompanyUuid": "d310aada-b1ad-4e9a-b822-b90c3cdb65bb",
"lastUpdatedByEnterpriseUuid": "a6420cdc-285a-4f75-8ccc-8edff6d60c0a",
"companyUuid": "d310aada-b1ad-4e9a-b822-b90c3cdb65bb",
"label": "Important Attr",
"key": "can_u_work",
"dataType": "string",
"description": "Important Attr",
"resource": "ComplianceCheckTemplate",
"resourceIdentifier": "38e7869d-6c42-406f-93e4-5fa687d7f09a",
"hireDataKeyId": 1
}
}
],
"segmentEnabled": true,
"segmentUuids": [
"uuidSegment1",
"uuidSegment2"
],
"messagingEnabled": true,
"importProvider": "hire",
"technicalOptions": {
"lockEin": true
},
"ssn": "123-45-6789",
"securityGroupUuids": [
"887436c5-47f4-43cc-963a-1d1d4e21f665"
],
"openingUuid": "f4428d27-c089-40c4-aa83-ce02e1ee1426",
"forceRecordSessionReplayUntil": "2023-04-24T00:00:00.000Z",
"smsOptOut": {
"optedOutAt": "2023-04-24T00:00:00.000Z",
"optedOutByAudience": "worker",
"optedOutByAudienceUuid": "887436c5-47f4-43cc-963a-1d1d4e21f665",
"optedOutOverrideByAudienceUuid": "admin-user-uuid",
"optedOutOverrideAt": "2023-04-24T00:00:00.000Z"
},
"whatsAppOptOut": {
"optedOutAt": "2023-04-24T00:00:00.000Z",
"optedOutByAudience": "worker",
"optedOutByAudienceUuid": "887436c5-47f4-43cc-963a-1d1d4e21f665",
"optedOutOverrideByAudienceUuid": "admin-user-uuid",
"optedOutOverrideAt": "2023-04-24T00:00:00.000Z"
},
"opening": {
"uuid": "0387e696-0285-4b6b-8ffc-04d85c13d547",
"title": "Opening 1"
}
}
},
"shiftTagUuid": "b3d596aa-d9aa-4779-9725-231d6b1f756f",
"shiftTagNote": "This is a note about the shift tag",
"virtualLocation": {
"uuid": "f4428d27-c089-40c4-aa83-ce02e1ee1426",
"createdAt": "2021-05-05T01:02:03.924Z",
"createdBy": "1e4e9128-fbb2-4b0a-97fc-f65bb1efee55",
"lastUpdatedAt": "2021-05-05T04:05:06.924Z",
"lastUpdatedBy": "7097bb82-61bd-4724-82ac-eab598190e47",
"lastUpdatedByAudience": "employer",
"lastUpdatedByAudienceUuid": "68df4316-590a-4081-9f24-9d9311977c9d",
"lastUpdatedByImpersonatedBy": "3462e1d4-0e27-4798-b4a2-76412ab21892",
"lastUpdatedByCompanyUuid": "d310aada-b1ad-4e9a-b822-b90c3cdb65bb",
"lastUpdatedByEnterpriseUuid": "a6420cdc-285a-4f75-8ccc-8edff6d60c0a",
"name": "San Francisco",
"description": "Nostrud est ea aliqua laborum nostrud magna ipsum sunt quis mollit nisi fugiat ipsum.",
"street_address": "275 Sacramento St",
"address_2": "Unit 2",
"city": "San Francisco",
"state_code": "California",
"postal_code": "94105",
"country_code": "US",
"locationNotes": "Locker code: 21ABBS",
"timezone": "America/San_Francisco",
"language": "en_US",
"externalLocation": {
"source": "hire",
"externalCreatedAt": "2021-05-05T01:02:03.924Z"
}
},
"virtualWorker": {
"uuid": "f4428d27-c089-40c4-aa83-ce02e1ee1426",
"createdAt": "2021-05-05T01:02:03.924Z",
"createdBy": "1e4e9128-fbb2-4b0a-97fc-f65bb1efee55",
"lastUpdatedAt": "2021-05-05T04:05:06.924Z",
"lastUpdatedBy": "7097bb82-61bd-4724-82ac-eab598190e47",
"lastUpdatedByAudience": "employer",
"lastUpdatedByAudienceUuid": "68df4316-590a-4081-9f24-9d9311977c9d",
"lastUpdatedByImpersonatedBy": "3462e1d4-0e27-4798-b4a2-76412ab21892",
"lastUpdatedByCompanyUuid": "d310aada-b1ad-4e9a-b822-b90c3cdb65bb",
"lastUpdatedByEnterpriseUuid": "a6420cdc-285a-4f75-8ccc-8edff6d60c0a",
"firstname": "Alice",
"lastname": "Doe",
"middlename": "Elizabeth",
"displayFullName": "Alice Doe",
"dashboardUrl": {
"slug": "alice-doe-2002",
"baseUrl": "https://employees.mcdonalds.com/"
},
"personalEmail": {
"email": "alice.doe@gmail.com",
"verified": true,
"verifiedAt": "2023-03-24T00:00:00.000Z"
},
"workEmail": {
"email": "alice.doe@fountain.com",
"verified": true,
"verifiedAt": "2023-03-24T00:00:00.000Z"
},
"mobilePhone": {
"number": "+331234567890",
"countryCode": "FR",
"verified": true,
"verifiedAt": "2023-03-24T00:00:00.000Z"
},
"whatsAppPhone": {
"number": "+521234567890",
"countryCode": "MX",
"verified": true,
"verifiedAt": "2025-03-09T00:00:00.000Z"
},
"homePhone": {
"number": "+331234567890",
"countryCode": "FR",
"verified": true,
"verifiedAt": "2023-03-24T00:00:00.000Z"
},
"homeAddress": {
"address1": "55 rue du Faubourg-Saint-Honoré",
"address2": "Palais de l'Elysée",
"city": "Paris",
"zip": "75008",
"state": "Île-de-France",
"country": "France"
},
"timezone": "Europe/Paris",
"locale": "fr-FR",
"companyUuid": "2ac58bbf-1e6c-4ab8-a614-350acea0e945",
"company": {
"uuid": "2ac58bbf-1e6c-4ab8-a614-350acea0e945",
"name": "My Company",
"slug": "my-company-a650bcf2"
},
"jobUuid": "0387e696-0285-4b6b-8ffc-04d85c13d547",
"job": {
"uuid": "0387e696-0285-4b6b-8ffc-04d85c13d547",
"name": "Candle Sniffer",
"description": "Sniffer of Candles"
},
"jobIdentifiers": [
{
"jobUuid": "e1e3da43-915e-4ed9-97dc-175f458821ac",
"relationship": "primary"
}
],
"jobs": [
{
"uuid": "0387e696-0285-4b6b-8ffc-04d85c13d547",
"name": "Candle Sniffer",
"description": "Sniffer of Candles",
"allowUnscheduledShift": true
}
],
"brand": {
"name": "Pizza Hut"
},
"einUuid": "815deb86-f758-449f-87cd-81a3d7699296",
"ein": {
"uuid": "12-3456789",
"label": "Cool Company - Paris"
},
"locationUuid": "e3425972-86df-4384-9f40-8de005ba30b0",
"locationUuids": [
"e3425972-86df-4384-9f40-8de005ba30b0"
],
"locations": [
{
"uuid": "f4428d27-c089-40c4-aa83-ce02e1ee1426",
"createdAt": "2021-05-05T01:02:03.924Z",
"createdBy": "1e4e9128-fbb2-4b0a-97fc-f65bb1efee55",
"lastUpdatedAt": "2021-05-05T04:05:06.924Z",
"lastUpdatedBy": "7097bb82-61bd-4724-82ac-eab598190e47",
"lastUpdatedByAudience": "employer",
"lastUpdatedByAudienceUuid": "68df4316-590a-4081-9f24-9d9311977c9d",
"lastUpdatedByImpersonatedBy": "3462e1d4-0e27-4798-b4a2-76412ab21892",
"lastUpdatedByCompanyUuid": "d310aada-b1ad-4e9a-b822-b90c3cdb65bb",
"lastUpdatedByEnterpriseUuid": "a6420cdc-285a-4f75-8ccc-8edff6d60c0a",
"name": "San Francisco",
"description": "Nostrud est ea aliqua laborum nostrud magna ipsum sunt quis mollit nisi fugiat ipsum.",
"street_address": "275 Sacramento St",
"address_2": "Unit 2",
"city": "San Francisco",
"state_code": "California",
"postal_code": "94105",
"country_code": "US",
"locationNotes": "Locker code: 21ABBS",
"timezone": "America/San_Francisco",
"language": "en_US",
"externalLocation": {
"source": "hire",
"externalCreatedAt": "2021-05-05T01:02:03.924Z"
}
}
],
"tags": [
{
"uuid": "7dcf6728-adf5-4c8c-b098-334b68b64ebe",
"name": "some tag"
}
],
"people": {
"uuid": "6d5d014f-f118-4fbd-83f1-7baac578c123",
"index": 1,
"reasons": [
"ssn"
]
},
"rehire": {
"isRehire": true,
"uuid": "6d5d014f-f118-4fbd-83f1-7baac578c123",
"reasons": [
"forcedFromAttribute"
]
},
"externalId": "6d5d014f-f118-4fbd-83f1-7baac578c123",
"externalSource": "UKG",
"externalSourceAccount": "fountain-sandbox",
"applicantId": "6d5d014f-f118-4fbd-83f1-7baac578c123",
"applicantSource": "Fountain Hire",
"backgroundCheckYardstikCandidateId": "6d5d014f-f118-4fbd-83f1-7baac578c123",
"dateOfBirth": "1987-12-24",
"startDate": "2023-04-26",
"hireDate": "2023-04-24",
"terminationDate": "2023-04-30",
"firstSeenAt": "2023-04-24T00:00:00.000Z",
"lastSeenAt": "2023-04-25T00:00:00.000Z",
"employmentStatus": {
"type": "inactive",
"subtype": "furloughed",
"lastStatusUpdateDate": "2023-04-25T00:00:00.000Z"
},
"avatar": "https://i.pravatar.cc/500",
"manager": {
"uuid": "887436c5-47f4-43cc-963a-1d1d4e21f665",
"displayFullName": "Bob LeBoss"
},
"customAttributes": [
{
"customAttributeUuid": "887436c5-47f4-43cc-963a-1d1d4e21f665",
"value": "wanna work",
"customAttribute": {
"uuid": "8223636c5-47f4-43cc-963a-1d1d4e22b665",
"createdAt": "2021-05-05T01:02:03.924Z",
"createdBy": "1e4e9128-fbb2-4b0a-97fc-f65bb1efee55",
"lastUpdatedAt": "2021-05-05T04:05:06.924Z",
"lastUpdatedBy": "7097bb82-61bd-4724-82ac-eab598190e47",
"lastUpdatedByAudience": "employer",
"lastUpdatedByAudienceUuid": "68df4316-590a-4081-9f24-9d9311977c9d",
"lastUpdatedByImpersonatedBy": "3462e1d4-0e27-4798-b4a2-76412ab21892",
"lastUpdatedByCompanyUuid": "d310aada-b1ad-4e9a-b822-b90c3cdb65bb",
"lastUpdatedByEnterpriseUuid": "a6420cdc-285a-4f75-8ccc-8edff6d60c0a",
"companyUuid": "d310aada-b1ad-4e9a-b822-b90c3cdb65bb",
"label": "Important Attr",
"key": "can_u_work",
"dataType": "string",
"description": "Important Attr",
"resource": "ComplianceCheckTemplate",
"resourceIdentifier": "38e7869d-6c42-406f-93e4-5fa687d7f09a",
"hireDataKeyId": 1
}
}
],
"segmentEnabled": true,
"segmentUuids": [
"uuidSegment1",
"uuidSegment2"
],
"messagingEnabled": true,
"importProvider": "hire",
"technicalOptions": {
"lockEin": true
},
"ssn": "123-45-6789",
"securityGroupUuids": [
"887436c5-47f4-43cc-963a-1d1d4e21f665"
],
"openingUuid": "f4428d27-c089-40c4-aa83-ce02e1ee1426",
"forceRecordSessionReplayUntil": "2023-04-24T00:00:00.000Z",
"smsOptOut": {
"optedOutAt": "2023-04-24T00:00:00.000Z",
"optedOutByAudience": "worker",
"optedOutByAudienceUuid": "887436c5-47f4-43cc-963a-1d1d4e21f665",
"optedOutOverrideByAudienceUuid": "admin-user-uuid",
"optedOutOverrideAt": "2023-04-24T00:00:00.000Z"
},
"whatsAppOptOut": {
"optedOutAt": "2023-04-24T00:00:00.000Z",
"optedOutByAudience": "worker",
"optedOutByAudienceUuid": "887436c5-47f4-43cc-963a-1d1d4e21f665",
"optedOutOverrideByAudienceUuid": "admin-user-uuid",
"optedOutOverrideAt": "2023-04-24T00:00:00.000Z"
},
"opening": {
"uuid": "0387e696-0285-4b6b-8ffc-04d85c13d547",
"title": "Opening 1"
}
}
},
"meta": {
"timestamp": "2021-05-05T09:47:58.924Z",
"verb": "GET",
"path": "/api/structure/resources/5949cf7c-fec6-4b31-947c-3aceabff58c5",
"jti": "%cQN3RIGp",
"rid": "$2d2zkHZ5",
"count": 1,
"status": "200",
"duration": 17,
"size": 1234
}
}