Skip to content

The event's jobs

GET
/groups/{groupId}/events/{eventId}/jobs
curl --request GET \
--url https://app.grouperly.com/api/v2/groups/example/events/example/jobs \
--header 'Authorization: Bearer <token>'

Its shifts, each with its own date and time, and their jobs; its jobs for any time; who’s on each; and what’s asked of each family or person (added in 2.60.0). Once members see the jobs; before that, only for those leading the event (a key reads as a leader). An app acting as a person also gets the jobs they and their family hold (mine). Without roster.youth.read a youth on a job is counted but not named.

groupId
required
string

The credential’s group

eventId
required
string

An event in the group

OK

Media typeapplication/json
object
jobsOn
required

Whether members see the jobs. Off, only those leading the event (and a key) read them

boolean
closesAt
required

When taking jobs closes; those leading it still put people on after

string | null format: date-time
ask
required

What each family or person is asked to take; null when nobody is

object
count
required
integer
unit
required
string
Allowed values: JOBS HOURS
per
required
string
Allowed values: FAMILY PERSON
who
required

Whose, when it is per person

string
Allowed values: ADULTS YOUTH ANYONE
mode
required

Asked and tracked, or part of the RSVP

string
Allowed values: TRACKED WITH_RSVP
shifts
required

By day and time

Array<object>
object
id
required
string
name
required
string | null
location
required
string | null
startsAt
required

Its own date and time, which may be before or after the event’s (setup the night before)

string format: date-time
endsAt
required
string format: date-time
isAllDay
required
boolean
jobs
required
Array<object>
object
id
required
string
name
required
string
description
required
string | null
location
required

Where in the shift’s place (“Table 1”)

string | null
slots
required

Adults fill their own slots first, then anyone’s; youth the same

object
adults
required
integer
youth
required
integer
anyone
required

Null: as many as want to

integer | null
minYouthAge
required
integer | null
notePrompt
required

What it asks whoever takes it (“What are you bringing?”)

string | null
noteRequired
required
boolean
countsAsMinutes
required

What a job for any time counts as when the event asks for hours

integer | null
fundraiserJob
required

Taking it gives this job on the event’s fundraiser, on its shift’s day or days only

string | null
Allowed values: CASHIER INTAKE
keptTo
required

Only those holding one of these roles, or in one of these subgroups, take it

Array<object>
object
kind
required
string
Allowed values: role subgroup
name
required
string
taken
required

Who’s on it, youth counted whether or not they’re listed

object
adults
required
integer
youth
required
integer
open
required

The slots still open to each; null for no limit

object
adults
required
integer | null
youth
required
integer | null
people
required

Who’s on it, by the name the roster gives them, in the order they took it. Without roster.youth.read, youth are counted in taken but not listed.

Array<object>
object
name
required
string
note
required

What they said when they took it (“Caesar salad, serves 12”)

string | null
youth
required

On a youth slot. Listed only for an app with roster.youth.read

boolean
anyTime
required

Jobs not in a shift: one for the whole event, or something to bring

Array<object>
object
id
required
string
name
required
string
description
required
string | null
location
required

Where in the shift’s place (“Table 1”)

string | null
slots
required

Adults fill their own slots first, then anyone’s; youth the same

object
adults
required
integer
youth
required
integer
anyone
required

Null: as many as want to

integer | null
minYouthAge
required
integer | null
notePrompt
required

What it asks whoever takes it (“What are you bringing?”)

string | null
noteRequired
required
boolean
countsAsMinutes
required

What a job for any time counts as when the event asks for hours

integer | null
fundraiserJob
required

Taking it gives this job on the event’s fundraiser, on its shift’s day or days only

string | null
Allowed values: CASHIER INTAKE
keptTo
required

Only those holding one of these roles, or in one of these subgroups, take it

Array<object>
object
kind
required
string
Allowed values: role subgroup
name
required
string
taken
required

Who’s on it, youth counted whether or not they’re listed

object
adults
required
integer
youth
required
integer
open
required

The slots still open to each; null for no limit

object
adults
required
integer | null
youth
required
integer | null
people
required

Who’s on it, by the name the roster gives them, in the order they took it. Without roster.youth.read, youth are counted in taken but not listed.

Array<object>
object
name
required
string
note
required

What they said when they took it (“Caesar salad, serves 12”)

string | null
youth
required

On a youth slot. Listed only for an app with roster.youth.read

boolean
mine
required

The jobs the person and their family hold: only for an app acting as a person. A youth’s only with roster.youth.read

Array<object>
object
jobId
required
string
name
required
string
you
required
boolean
note
required
string | null
Example
{
"ask": {
"unit": "JOBS",
"per": "FAMILY",
"who": "ADULTS",
"mode": "TRACKED"
},
"shifts": [
{
"jobs": [
{
"fundraiserJob": "CASHIER",
"keptTo": [
{
"kind": "role"
}
]
}
]
}
],
"anyTime": [
{
"fundraiserJob": "CASHIER",
"keptTo": [
{
"kind": "role"
}
]
}
]
}
X-RateLimit-Limit
integer

Requests allowed per minute for this credential

X-RateLimit-Remaining
integer

Requests left in this window

X-RateLimit-Reset
integer

When the window ends (Unix seconds)

Missing, unknown, revoked or expired credential (unauthorized)

Media typeapplication/json
object
error
required
object
code
required

Stable and machine-readable: unauthorized, forbidden, insufficient_scope, key_owner_not_leader, app_not_installed, scope_not_allowed, app_suspended, rate_limited, not_found, invalid_parameter, invalid_body, invalid_profile, invalid_descriptor, no_profile, already_exists, not_a_member, wrong_holder, role_inactive, role_full, already_assigned, assignment_ended, version_not_current, nothing_to_pay, payments_not_ready, payload_too_large, first_party_only, terms_required, child_account, assistant_off, not_for_assistant, assistant_failed, not_a_draft, storage_full, made_from_roles, type_removed, invalid_reporting, led_by_role, unavailable, internal_error. New codes may be added.

string
message
required

For people; wording may change.

string
parameter

The query parameter (invalid_parameter) or body field (invalid_body, not_a_member, wrong_holder, invalid_reporting) at fault.

string
Examplegenerated
{
"error": {
"code": "example",
"message": "example",
"parameter": "example"
}
}

A key: wrong group (forbidden), missing scope (insufficient_scope), or its creator no longer leads the group (key_owner_not_leader). An app’s token: missing scope (insufficient_scope), the group hasn’t installed the app (app_not_installed) or allowed the scope (scope_not_allowed, the message has the consent link), the person may not do this in the group (forbidden), Grouperly paused the app (app_suspended), the person hasn’t accepted Grouperly’s current Terms (terms_required: refresh their token, then send them to the hub’s /account/welcome), or it’s a child’s account (child_account). A viewer token: the same, and forbidden in any group but its own

Media typeapplication/json
object
error
required
object
code
required

Stable and machine-readable: unauthorized, forbidden, insufficient_scope, key_owner_not_leader, app_not_installed, scope_not_allowed, app_suspended, rate_limited, not_found, invalid_parameter, invalid_body, invalid_profile, invalid_descriptor, no_profile, already_exists, not_a_member, wrong_holder, role_inactive, role_full, already_assigned, assignment_ended, version_not_current, nothing_to_pay, payments_not_ready, payload_too_large, first_party_only, terms_required, child_account, assistant_off, not_for_assistant, assistant_failed, not_a_draft, storage_full, made_from_roles, type_removed, invalid_reporting, led_by_role, unavailable, internal_error. New codes may be added.

string
message
required

For people; wording may change.

string
parameter

The query parameter (invalid_parameter) or body field (invalid_body, not_a_member, wrong_holder, invalid_reporting) at fault.

string
Examplegenerated
{
"error": {
"code": "example",
"message": "example",
"parameter": "example"
}
}
X-RateLimit-Limit
integer

Requests allowed per minute for this credential

X-RateLimit-Remaining
integer

Requests left in this window

X-RateLimit-Reset
integer

When the window ends (Unix seconds)

Not found (not_found)

Media typeapplication/json
object
error
required
object
code
required

Stable and machine-readable: unauthorized, forbidden, insufficient_scope, key_owner_not_leader, app_not_installed, scope_not_allowed, app_suspended, rate_limited, not_found, invalid_parameter, invalid_body, invalid_profile, invalid_descriptor, no_profile, already_exists, not_a_member, wrong_holder, role_inactive, role_full, already_assigned, assignment_ended, version_not_current, nothing_to_pay, payments_not_ready, payload_too_large, first_party_only, terms_required, child_account, assistant_off, not_for_assistant, assistant_failed, not_a_draft, storage_full, made_from_roles, type_removed, invalid_reporting, led_by_role, unavailable, internal_error. New codes may be added.

string
message
required

For people; wording may change.

string
parameter

The query parameter (invalid_parameter) or body field (invalid_body, not_a_member, wrong_holder, invalid_reporting) at fault.

string
Examplegenerated
{
"error": {
"code": "example",
"message": "example",
"parameter": "example"
}
}
X-RateLimit-Limit
integer

Requests allowed per minute for this credential

X-RateLimit-Remaining
integer

Requests left in this window

X-RateLimit-Reset
integer

When the window ends (Unix seconds)

Rate limited (rate_limited)

Media typeapplication/json
object
error
required
object
code
required

Stable and machine-readable: unauthorized, forbidden, insufficient_scope, key_owner_not_leader, app_not_installed, scope_not_allowed, app_suspended, rate_limited, not_found, invalid_parameter, invalid_body, invalid_profile, invalid_descriptor, no_profile, already_exists, not_a_member, wrong_holder, role_inactive, role_full, already_assigned, assignment_ended, version_not_current, nothing_to_pay, payments_not_ready, payload_too_large, first_party_only, terms_required, child_account, assistant_off, not_for_assistant, assistant_failed, not_a_draft, storage_full, made_from_roles, type_removed, invalid_reporting, led_by_role, unavailable, internal_error. New codes may be added.

string
message
required

For people; wording may change.

string
parameter

The query parameter (invalid_parameter) or body field (invalid_body, not_a_member, wrong_holder, invalid_reporting) at fault.

string
Examplegenerated
{
"error": {
"code": "example",
"message": "example",
"parameter": "example"
}
}
X-RateLimit-Limit
integer

Requests allowed per minute for this credential

X-RateLimit-Remaining
integer

Requests left in this window

X-RateLimit-Reset
integer

When the window ends (Unix seconds)

Retry-After
integer

Seconds to wait

An app’s token for someone new, while Grouperly’s sign-in can’t be reached (unavailable); try again

Media typeapplication/json
object
error
required
object
code
required

Stable and machine-readable: unauthorized, forbidden, insufficient_scope, key_owner_not_leader, app_not_installed, scope_not_allowed, app_suspended, rate_limited, not_found, invalid_parameter, invalid_body, invalid_profile, invalid_descriptor, no_profile, already_exists, not_a_member, wrong_holder, role_inactive, role_full, already_assigned, assignment_ended, version_not_current, nothing_to_pay, payments_not_ready, payload_too_large, first_party_only, terms_required, child_account, assistant_off, not_for_assistant, assistant_failed, not_a_draft, storage_full, made_from_roles, type_removed, invalid_reporting, led_by_role, unavailable, internal_error. New codes may be added.

string
message
required

For people; wording may change.

string
parameter

The query parameter (invalid_parameter) or body field (invalid_body, not_a_member, wrong_holder, invalid_reporting) at fault.

string
Examplegenerated
{
"error": {
"code": "example",
"message": "example",
"parameter": "example"
}
}