Substy Developers
Team

Get team schedule

Read one AI or employee work schedule by its schedule ID.

GET/v1/agencies/{agencyId}/team/schedules/{scheduleId}

Read one AI or employee work schedule by its schedule ID.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

agencyId*string
Length1 <= length
scheduleId*string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/agencies/string/team/schedules/string" \  -H "Authorization: Bearer YOUR_API_KEY"
{  "data": {    "timeSlots": [      {        "id": "string",        "createdAt": "2019-08-24T14:15:22Z",        "updatedAt": "2019-08-24T14:15:22Z",        "startTime": "string",        "endTime": "string",        "position": 0,        "dayOfWeek": null,        "scheduleId": "string"      }    ],    "creators": [      {        "creator": {          "platform": "ONLYFANS",          "id": "string",          "name": "string"        },        "creatorId": "string",        "scheduleId": "string",        "assignedAt": "2019-08-24T14:15:22Z"      }    ],    "employees": [      {        "agencyEmployee": {          "id": "string",          "color": null,          "employeeId": "string"        },        "scheduleId": "string",        "assignedAt": "2019-08-24T14:15:22Z",        "agencyEmployeeId": "string"      }    ],    "scheduleDates": [      {        "date": "2019-08-24T14:15:22Z",        "id": "string",        "createdAt": "2019-08-24T14:15:22Z",        "scheduleId": "string"      }    ],    "shiftReports": [      {        "creatorReports": [          {            "creatorId": "string",            "id": "string",            "createdAt": "2019-08-24T14:15:22Z",            "revenue": "string",            "paidMessages": 0,            "paidMessageValue": "string",            "shiftReportId": "string",            "tips": 0,            "tipAmount": "string"          }        ],        "employeeReports": [          {            "id": "string",            "createdAt": "2019-08-24T14:15:22Z",            "revenue": "string",            "agencyEmployeeId": "string",            "avgResponseTime": null,            "shiftReportId": "string",            "hoursWorked": 0,            "messagesHandled": 0          }        ],        "id": "string",        "createdAt": "2019-08-24T14:15:22Z",        "updatedAt": "2019-08-24T14:15:22Z",        "conversionRate": null,        "scheduleId": "string",        "shiftDate": "2019-08-24T14:15:22Z",        "actualStart": "2019-08-24T14:15:22Z",        "actualEnd": "2019-08-24T14:15:22Z",        "totalMessages": 0,        "totalRevenue": "string",        "totalTips": 0,        "totalTipAmount": "string",        "paidMessages": 0,        "paidMessageValue": "string",        "avgResponseTime": null      }    ],    "id": "string",    "createdAt": "2019-08-24T14:15:22Z",    "status": "COMPLETED",    "timezone": "string",    "updatedAt": "2019-08-24T14:15:22Z",    "scheduledFor": "AI",    "isAllDay": true,    "isRecurring": true,    "recurrenceType": null,    "recurrenceEnd": null,    "color": null,    "isCompleted": true,    "completedAt": null,    "lastOccurrenceStart": null  },  "meta": {    "requestId": "string"  }}

Create team schedule POST

Create AI or employee work schedules for the selected creators, dates and time slots. Specify the intended timezone and recurrence settings.

Update team schedule PATCH

Update a work schedule's assigned creators or employees, dates, time slots, timezone, recurrence or completion state.