Sign in

v3

latestSwagger 2.02026-08-067506752.0 MB
allocation

Get the allocations to a group on a date -- one entry per allocated job

get/v1/org/{orgId}/allocation/group/{groupId}

Path parameters

orgIdstring required

Org identifier (either id or slug)

groupIdstring required

Group id

Query parameters

datestring date

Date to read allocations as-of (defaults to today)

Response

successful operation

idstring required

globally unique id

orgIdstring required

parent organization id

jobIdstring required

job that is allocated -- may be an open job

groupIdstring required

group the job is allocated to

groupTypeIdstring required

group type of the group this allocation is for

allocationnumber required

portion of the job's capacity allocated to the group, as a decimal (0.25 means 25%)

effectiveDatestring date required

first date this allocation applies

endDatestring date

last date this allocation applies, or null if it is open-ended

notesstring

free-text note about this allocation

derivedFromTeamAllocationboolean

true when this record was derived by dividing a team-level allocation across team members

createIdstring

created by user id

createBehalfIdstring

created on behalf of user id

createAtstring

created timestamp

updateIdstring

last updated by user id

updateBehalfIdstring

last updated on behalf of user id

updateAtstring

last updated timestamp

deleteIdstring

deleted by user id

deleteBehalfIdstring

deleted on behalf of user id

deleteAtstring

deleted timestamp

Example response

[
  {
    "id": "588f7ee98f138b19220041a7",
    "orgId": "588f7ee98f138b19220041a7",
    "jobId": "588f7ee98f138b19220041a7",
    "groupId": "588f7ee98f138b19220041a7",
    "groupTypeId": "588f7ee98f138b19220041a7",
    "createId": "588f7ee98f138b19220041a7",
    "createBehalfId": "588f7ee98f138b19220041a7",
    "createAttribution": {
      "principalUserId": "588f7ee98f138b19220041a7",
      "agentUserIds": [
        "588f7ee98f138b19220041a7"
      ],
      "eventId": "588f7ee98f138b19220041a7",
      "aiChatId": "588f7ee98f138b19220041a7"
    },
    "createAt": "2017-01-24T13:57:52Z",
    "updateId": "588f7ee98f138b19220041a7",
    "updateBehalfId": "588f7ee98f138b19220041a7",
    "updateAttribution": {
      "principalUserId": "588f7ee98f138b19220041a7",
      "agentUserIds": [
        "588f7ee98f138b19220041a7"
      ],
      "eventId": "588f7ee98f138b19220041a7",
      "aiChatId": "588f7ee98f138b19220041a7"
    },
    "updateAt": "2017-01-24T13:57:52Z",
    "deleteId": "588f7ee98f138b19220041a7",
    "deleteBehalfId": "588f7ee98f138b19220041a7",
    "deleteAttribution": {
      "principalUserId": "588f7ee98f138b19220041a7",
      "agentUserIds": [
        "588f7ee98f138b19220041a7"
      ],
      "eventId": "588f7ee98f138b19220041a7",
      "aiChatId": "588f7ee98f138b19220041a7"
    },
    "deleteAt": "2017-01-24T13:57:52Z"
  }
]