ReferencePasses

Holders

8 operations. Send Authorization: Bearer $PASSBOOK_KEY. Markdown

GET/api/v1/holders
passes:readSDK pb.holders.list

Query

emailstring · max 254
state"unassigned" | "waiting" | "owned"
cursorstring
limitinteger · ≥ 1 · ≤ 200

Returns

200

Errors

CodeStatusFix
BLOCK_NOT_FOUNDCheck the block id and send the request again.
EMAIL_INVALIDSend a valid address in the email field.
FORBIDDENUse a key with the scope the operation lists, or ask an org admin.
HOLDER_CHANGEDFetch the pass with GET /api/v1/passes/{id} and send the request again.
HOLDER_OWNEDUse POST /api/v1/holders/reassign to move it.
HOLDER_TRANSFER_PENDINGWait for the transfer to finish, then send the request again.
INVALID_API_KEYCreate a new key in the console and update PASSBOOK_KEY.
MISSING_SCOPECreate a key with the scope the operation lists under security.
PASS_CONFLICTFetch the pass with GET /api/v1/passes/{id} and send the request again.
PASS_NOT_FOUNDCheck the id with GET /api/v1/passes and the key's mode.
RATE_LIMITEDWait for Retry-After seconds, then retry. Back off on repeats.
UNAUTHENTICATEDSend Authorization: Bearer $PASSBOOK_KEY.
VALIDATIONFix each field in issues and resend.
GET/api/v1/holders/{id}
passes:readSDK pb.holders.retrieve

Path

idstring · max 64Required

Returns

200

Errors

CodeStatusFix
BLOCK_NOT_FOUNDCheck the block id and send the request again.
EMAIL_INVALIDSend a valid address in the email field.
FORBIDDENUse a key with the scope the operation lists, or ask an org admin.
HOLDER_CHANGEDFetch the pass with GET /api/v1/passes/{id} and send the request again.
HOLDER_OWNEDUse POST /api/v1/holders/reassign to move it.
HOLDER_TRANSFER_PENDINGWait for the transfer to finish, then send the request again.
INVALID_API_KEYCreate a new key in the console and update PASSBOOK_KEY.
MISSING_SCOPECreate a key with the scope the operation lists under security.
NOT_FOUNDCheck the id, and that the key's mode (test or live) matches the object.
PASS_CONFLICTFetch the pass with GET /api/v1/passes/{id} and send the request again.
PASS_NOT_FOUNDCheck the id with GET /api/v1/passes and the key's mode.
RATE_LIMITEDWait for Retry-After seconds, then retry. Back off on repeats.
UNAUTHENTICATEDSend Authorization: Bearer $PASSBOOK_KEY.
VALIDATIONFix each field in issues and resend.
POST/api/v1/holders/assign
holders:writeSDK pb.holders.assign

Body

passIdstring · max 64Required
emailstring · max 254Required

Returns

200

Errors

CodeStatusFix
BLOCK_NOT_FOUNDCheck the block id and send the request again.
EMAIL_INVALIDSend a valid address in the email field.
FORBIDDENUse a key with the scope the operation lists, or ask an org admin.
HOLDER_CHANGEDFetch the pass with GET /api/v1/passes/{id} and send the request again.
HOLDER_OWNEDUse POST /api/v1/holders/reassign to move it.
HOLDER_TRANSFER_PENDINGWait for the transfer to finish, then send the request again.
INVALID_API_KEYCreate a new key in the console and update PASSBOOK_KEY.
MISSING_SCOPECreate a key with the scope the operation lists under security.
PASS_CONFLICTFetch the pass with GET /api/v1/passes/{id} and send the request again.
PASS_NOT_FOUNDCheck the id with GET /api/v1/passes and the key's mode.
RATE_LIMITEDWait for Retry-After seconds, then retry. Back off on repeats.
UNAUTHENTICATEDSend Authorization: Bearer $PASSBOOK_KEY.
VALIDATIONFix each field in issues and resend.
POST/api/v1/holders/assign-bulk
holders:writeSDK pb.holders.bulkAssign

Body

itemsobject[]Required

Returns

200

Errors

CodeStatusFix
BLOCK_NOT_FOUNDCheck the block id and send the request again.
EMAIL_INVALIDSend a valid address in the email field.
FORBIDDENUse a key with the scope the operation lists, or ask an org admin.
HOLDER_CHANGEDFetch the pass with GET /api/v1/passes/{id} and send the request again.
HOLDER_OWNEDUse POST /api/v1/holders/reassign to move it.
HOLDER_TRANSFER_PENDINGWait for the transfer to finish, then send the request again.
INVALID_API_KEYCreate a new key in the console and update PASSBOOK_KEY.
MISSING_SCOPECreate a key with the scope the operation lists under security.
PASS_CONFLICTFetch the pass with GET /api/v1/passes/{id} and send the request again.
PASS_NOT_FOUNDCheck the id with GET /api/v1/passes and the key's mode.
RATE_LIMITEDWait for Retry-After seconds, then retry. Back off on repeats.
UNAUTHENTICATEDSend Authorization: Bearer $PASSBOOK_KEY.
VALIDATIONFix each field in issues and resend.
POST/api/v1/holders/reassign
holders:writeSDK pb.holders.reassign

Body

passIdstring · max 64Required
emailstring | null · max 254Required

Returns

200

Errors

CodeStatusFix
BLOCK_NOT_FOUNDCheck the block id and send the request again.
EMAIL_INVALIDSend a valid address in the email field.
FORBIDDENUse a key with the scope the operation lists, or ask an org admin.
HOLDER_CHANGEDFetch the pass with GET /api/v1/passes/{id} and send the request again.
HOLDER_OWNEDUse POST /api/v1/holders/reassign to move it.
HOLDER_TRANSFER_PENDINGWait for the transfer to finish, then send the request again.
INVALID_API_KEYCreate a new key in the console and update PASSBOOK_KEY.
MISSING_SCOPECreate a key with the scope the operation lists under security.
PASS_CONFLICTFetch the pass with GET /api/v1/passes/{id} and send the request again.
PASS_NOT_FOUNDCheck the id with GET /api/v1/passes and the key's mode.
RATE_LIMITEDWait for Retry-After seconds, then retry. Back off on repeats.
UNAUTHENTICATEDSend Authorization: Bearer $PASSBOOK_KEY.
VALIDATIONFix each field in issues and resend.
POST/api/v1/holders/unassign
holders:writeSDK pb.holders.unassign

Body

passIdstring · max 64Required

Returns

200

Errors

CodeStatusFix
BLOCK_NOT_FOUNDCheck the block id and send the request again.
EMAIL_INVALIDSend a valid address in the email field.
FORBIDDENUse a key with the scope the operation lists, or ask an org admin.
HOLDER_CHANGEDFetch the pass with GET /api/v1/passes/{id} and send the request again.
HOLDER_OWNEDUse POST /api/v1/holders/reassign to move it.
HOLDER_TRANSFER_PENDINGWait for the transfer to finish, then send the request again.
INVALID_API_KEYCreate a new key in the console and update PASSBOOK_KEY.
MISSING_SCOPECreate a key with the scope the operation lists under security.
PASS_CONFLICTFetch the pass with GET /api/v1/passes/{id} and send the request again.
PASS_NOT_FOUNDCheck the id with GET /api/v1/passes and the key's mode.
RATE_LIMITEDWait for Retry-After seconds, then retry. Back off on repeats.
UNAUTHENTICATEDSend Authorization: Bearer $PASSBOOK_KEY.
VALIDATIONFix each field in issues and resend.
POST/api/v1/holders/clear-block
holders:writeSDK pb.holders.clearBlock

Body

passIdstring · max 64Required
userIdstring · max 64Required

Returns

200

Errors

CodeStatusFix
BLOCK_NOT_FOUNDCheck the block id and send the request again.
EMAIL_INVALIDSend a valid address in the email field.
FORBIDDENUse a key with the scope the operation lists, or ask an org admin.
HOLDER_CHANGEDFetch the pass with GET /api/v1/passes/{id} and send the request again.
HOLDER_OWNEDUse POST /api/v1/holders/reassign to move it.
HOLDER_TRANSFER_PENDINGWait for the transfer to finish, then send the request again.
INVALID_API_KEYCreate a new key in the console and update PASSBOOK_KEY.
MISSING_SCOPECreate a key with the scope the operation lists under security.
PASS_CONFLICTFetch the pass with GET /api/v1/passes/{id} and send the request again.
PASS_NOT_FOUNDCheck the id with GET /api/v1/passes and the key's mode.
RATE_LIMITEDWait for Retry-After seconds, then retry. Back off on repeats.
UNAUTHENTICATEDSend Authorization: Bearer $PASSBOOK_KEY.
VALIDATIONFix each field in issues and resend.
POST/api/v1/offboard
passes:writeSDK pb.holders.offboard

Body

holderEmailstring · max 254
externalIdstring · max 200
passes"void" | "remove"
tags"spare" | "lost"
dryRunboolean

Returns

200

Errors

CodeStatusFix
BRAND_IMAGE_NOT_FOUNDUpload the image with PUT /api/v1/orgs/{id}/branding/{slot} and use the URL it returns.
BRAND_MARK_NOT_ALLOWEDRemove the setting, or ask the platform owner to enable it for the organization.
ENTITLEMENTS_CHANGEDFetch them with GET /api/v1/orgs/{id}/entitlements and send your change again.
FORBIDDENUse a key with the scope the operation lists, or ask an org admin.
IDENTITY_NOT_FOUNDCheck the id with GET /api/v1/identities.
IMAGE_BYTESCompress the image and upload it again.
IMAGE_INVALIDExport a standard PNG and upload it again.
IMAGE_NOT_FOUNDUpload one with PUT /api/v1/orgs/{id}/branding/{slot}.
IMAGE_SCALEResize so the @2x image is two thirds of the @3x, then upload both.
IMAGE_SIZEResize to the size named in issues and upload it again.
INVALID_API_KEYCreate a new key in the console and update PASSBOOK_KEY.
INVITATION_INVALIDAsk an organization admin to send a new invitation with POST /api/v1/orgs/{id}/invitations.
INVITATION_PENDINGRevoke it to send a new one.
LAST_ORG_ADMINMake someone else an org admin first.
MEMBERSHIP_CONFLICTFetch it with GET /api/v1/orgs/{id}/memberships and send the change again.
MISSING_SCOPECreate a key with the scope the operation lists under security.
ORG_CONFLICTFetch it with GET /api/v1/orgs/{id} and send the change again.
ORG_NOT_FOUNDCheck orgId with GET /api/v1/orgs.
ORG_PERSONAL_SINGLE_MEMBERUse a regular organization to work with others.
ORG_SLUG_RESERVEDChoose a different slug.
ORG_SLUG_TAKENChoose a different slug.
ORG_STATUS_ALONESend the status change in its own request, then the other edits.
RATE_LIMITEDWait for Retry-After seconds, then retry. Back off on repeats.
SETTINGS_CHANGEDFetch them with GET /api/v1/settings and send your change again.
UNAUTHENTICATEDSend Authorization: Bearer $PASSBOOK_KEY.
VALIDATIONFix each field in issues and resend.