Please note: the Shifts API is now in beta. Some functionalities may not yet be available at that time. Please note that the API may be subject to change.

List Shifts

Returns a paginated list of Shifts.

GET

https://api.piggy.eu/api//shifts

Headers

Authorization

Bearer {{ access_token | api_key }}

application/json

Body

shop_uuidstring

REQUIRED

The UUID of the Shop you want to create the Shift for.

statusstring

REQUIRED

The Status for this Shift.

team_uuidstring

OPTIONAL

The UUID of the Team you want to create the Shift for.

pageinteger

OPTIONAL

The page number.

limitinteger

OPTIONAL

The maximum number of Shifts to retrieve (default: 30, max: 100).

Response Example

{
    "data": [
        {
            "uuid": "69fa84f5-1270-4479-a9f9-75737d6739bf",
            "contact": [
                'uuid': "33630ed6-fd17-455a-b1ed-7494c3503ab3",
                'email': "spongebob@bikinibottom.sea",
            ],
            "external_id": "ABC-123",
            "team_uuid": "d37b1e30-23a2-40b6-ad4c-fa30ab0e9aa7",
            "shift_type_uuid": "1d1bf619-b097-4461-96a2-f8e7a5249519",
            "status": "approved",
            "break_in_minutes": 30,
            "net_duration_in_minutes": 480,
            "started_at": "2024-12-01T09:00:00+00:00",
            "ended_at": "2024-12-01T17:30:00+00:00",
            "created_at": "2024-12-08T09:00:00+00:00",
        },
        {
            "uuid": "bf7e6de4-13d7-444d-bf90-a4b68cb71f11",
            "contact": {
                "uuid": "bf12c2bb-8ba9-49fd-aa76-a7aa35f07280",
                "email": "sandy@bikinibottom.sea"
            },
            "external_id": "XYZ-789",
            "team_uuid": "4e13e25d-74da-443c-adb6-3826199de000",
            "shift_type_uuid": "b5701f1b-5e31-49b6-b94f-2f388e72730a",
            "status": "pending",
            "break_in_minutes": 45,
            "net_duration_in_minutes": 420,
            "started_at": "2024-12-02T08:00:00+00:00",
            "ended_at": "2024-12-02T15:30:00+00:00",
            "created_at": "2024-12-08T09:15:00+00:00"
        },
    ],
    "meta": {
        "page": 1,
        "per_page": 30,
        "last_page": 10,
        "total": 300
    }
}

Code

Message

1008

Shop not found.

80531

Shift status not found.

80540

Shift team not found.

Create Shift

Creates a new Shift.

POST

https://api.piggy.eu/api//shifts

Headers

Authorization

Bearer {{ access_token | api_key }}

application/json

Body

contact_uuidstring

REQUIRED

The UUID of the Contact you want to create the Shift for.

shop_uuidstring

REQUIRED

The UUID of the Shop you want to create the Shift for.

started_atstring

REQUIRED

The start date and time of the Shift in ISO 8601 format.

ended_atstring

REQUIRED

The end date and time of the Shift in ISO 8601 format.

statusstring

REQUIRED

The Status for this Shift.

external_idstring

OPTIONAL

An external identifier for the Shift.

team_uuidstring

OPTIONAL

The UUID of the Team you want to create the Shift for.

shift_type_uuidstring

OPTIONAL

The UUID of the Shift Team you want to create the Shift for.

break_in_minutesinteger

OPTIONAL

The break in a minutes for this Shift.

Response Example

{
    "data": {
        "uuid": "69fa84f5-1270-4479-a9f9-75737d6739bf",
        "contact": [
            'uuid': "33630ed6-fd17-455a-b1ed-7494c3503ab3",
            'email': "spongebob@bikinibottom.sea",
        ],
        "external_id": "ABC-123",
        "team_uuid": "d37b1e30-23a2-40b6-ad4c-fa30ab0e9aa7",
        "shift_type_uuid": "1d1bf619-b097-4461-96a2-f8e7a5249519",
        "status": "approved",
        "break_in_minutes": 30,
        "net_duration_in_minutes": 480,
        "started_at": "2024-12-01T09:00:00+00:00",
        "ended_at": "2024-12-01T17:30:00+00:00",
        "created_at": "2024-12-08T09:00:00+00:00",
    },
    "meta": {}
}

Code

Message

1003

Invalid input.

55031

Contact not found.

1008

Shop not found.

80530

Shift not found.

80531

Shift status not found.

80540

Shift team not found.

80550

Shift type not found.

80531

Shift with external id already exists for this account.

Find Shift by External ID

Returns all relevant information for a Shift.

GET

https://api.piggy.eu/api//shifts/find

Headers

Authorization

Bearer {{ access_token | api_key }}

application/json

Body

external_idstring

REQUIRED

The external identifier for this Shift.

Response Example

{
    "data": {
        "uuid": "69fa84f5-1270-4479-a9f9-75737d6739bf",
        "contact": [
            'uuid': "33630ed6-fd17-455a-b1ed-7494c3503ab3",
            'email': "spongebob@bikinibottom.sea",
        ],
        "external_id": "ABC-123",
        "team_uuid": "d37b1e30-23a2-40b6-ad4c-fa30ab0e9aa7",
        "shift_type_uuid": "1d1bf619-b097-4461-96a2-f8e7a5249519",
        "status": "approved",
        "break_in_minutes": 30,
        "net_duration_in_minutes": 480,
        "started_at": "2024-12-01T09:00:00+00:00",
        "ended_at": "2024-12-01T17:30:00+00:00",
        "created_at": "2024-12-08T09:00:00+00:00",
    },
    "meta": {}
}

Code

Message

80530

Shift not found.

Get Shift

Retrieve a Shift using its UUID.

GET

https://api.piggy.eu/api//shifts/{{uuid}}

Headers

Authorization

Bearer {{ access_token | api_key }}

application/json

Params

uuidstring

REQUIRED

The UUID for this Shift.

Response Example

{
    "data": {
        "uuid": "69fa84f5-1270-4479-a9f9-75737d6739bf",
        "contact": [
            'uuid': "33630ed6-fd17-455a-b1ed-7494c3503ab3",
            'email': "spongebob@bikinibottom.sea",
        ],
        "external_id": "ABC-123",
        "team_uuid": "d37b1e30-23a2-40b6-ad4c-fa30ab0e9aa7",
        "shift_type_uuid": "1d1bf619-b097-4461-96a2-f8e7a5249519",
        "status": "approved",
        "break_in_minutes": 30,
        "net_duration_in_minutes": 480,
        "started_at": "2024-12-01T09:00:00+00:00",
        "ended_at": "2024-12-01T17:30:00+00:00",
        "created_at": "2024-12-08T09:00:00+00:00",
    },
    "meta": {}
}

Code

Message

80530

Shift not found.

Update Shift

Updates the attributes of a Shift. Shop and contact cannot be updated.

PUT

https://api.piggy.eu/api//shifts/{{uuid}}

Headers

Authorization

Bearer {{ access_token | api_key }}

application/json

Params

uuidstring

REQUIRED

The UUID for this Shift.

Body

contact_uuidstring

OPTIONAL

The UUID of the Contact.

team_uuidstring

OPTIONAL

The UUID of the Team.

started_atstring

REQUIRED

The start date and time of the Shift in ISO 8601 format.

ended_atstring

REQUIRED

The end date and time of the Shift in ISO 8601 format.

statusstring

REQUIRED

The Status for this Shift.

break_in_minutesinteger

OPTIONAL

The break in a minutes for this Shift.

Response Example

{
    "data": {
        "uuid": "69fa84f5-1270-4479-a9f9-75737d6739bf",
        "contact": [
            'uuid': "33630ed6-fd17-455a-b1ed-7494c3503ab3",
            'email': "spongebob@bikinibottom.sea",
        ],
        "external_id": "ABC-123",
        "team_uuid": "d37b1e30-23a2-40b6-ad4c-fa30ab0e9aa7",
        "shift_type_uuid": "1d1bf619-b097-4461-96a2-f8e7a5249519",
        "status": "approved",
        "break_in_minutes": 30,
        "net_duration_in_minutes": 480,
        "started_at": "2024-12-01T09:00:00+00:00",
        "ended_at": "2024-12-01T17:30:00+00:00",
        "created_at": "2024-12-08T09:00:00+00:00",
    },
    "meta": {}
}

Code

Message

80530

Shift not found.

80531

Shift status not found.

1003

Invalid input.

Delete Shift

Deletes an existing Shift.

DELETE

https://api.piggy.eu/api//shifts/{{shift_uuid}}

Headers

Authorization

Bearer {{ access_token | api_key }}

application/json

Params

shift_uuidstring

REQUIRED

The Shift's UUID

Code

Message

80530

Shift not found.

Teams

Create or Update Teams for Shifts

Shift Types

Create or Update Shift Types

List Shifts

Create Shift

Find Shift by External ID

Get Shift

Update Shift

Delete Shift

Related

Teams

Shift Types