Admin people and stores

12 operations.

GET/api/v1/admin/plans

Plan grants

AdminBeta: may change

Live grants (default), past ones (ended or revoked), or one person’s history (?user=).

SDK: collector.listAdminPlanGrants()
Key scopes: admin:users:read(API keys are coming soon)
Headers: If-None-MatchX-Request-Id

Parameters

Name	In	Type	About
`status`required	query	enum	active (live and scheduled, the default) or past (ended or revoked).One of `active`, `past`default "active"
`user`optional	query	string (uuid)	One person’s grants.

Responses

200Grants.
AdminPlanGrantPage
- grantsarray of AdminPlanGrantrequired
- countsobjectrequired
  Fields of counts
  activenumberrequired
  pastnumberrequired
304Not modified: your copy (the ETag in If-None-Match) is current.

Errors (400, 404, 500)

400invalid_request
invalid_request: The query or body doesn’t match the schema (see errors[]).
404not_found
not_found: Not an admin (moderator): the same 404 as a missing route.
500internal
internal: Something went wrong on our side (quote the requestId).

curl

curl 'https://collection.id/api/v1/admin/plans' \
  -H "Authorization: Bearer $COLLECTOR_TOKEN"

TypeScript SDK

await collector.listAdminPlanGrants({ query: { … } });

POST/api/v1/admin/plans

Give someone a plan

AdminBeta: may changeIdempotent

Collector or Pro until a date (or indefinitely), with a reason. Audited; replaces their live grant.

SDK: collector.grantAdminPlan()
Key scopes: admin:users:write(API keys are coming soon)
Headers: Idempotency-KeyX-Request-Id

Request body (required, application/json)

object

userIdstring (uuid)required
planenumrequired
One ofcollectorpro
endsAtstring (date-time) or nullrequired
reasonstringrequired3–500 characters

Responses

201The grant.
object
- grantobjectrequired
  Fields of grant
  idstringrequired
  planstringrequired
  ends_atstring or nullrequired
  replacedarray of stringrequired
  Grants this one replaced.

Errors (400, 404, 409, 422, 500)

400invalid_request invalid_json invalid_idempotency_key
invalid_request: The query or body doesn’t match the schema (see errors[]).
invalid_json: The body isn’t JSON.
invalid_idempotency_key: The Idempotency-Key isn’t 1–255 visible ASCII characters.
404not_found
not_found: Not an admin (moderator): the same 404 as a missing route.
409idempotency_in_progress
idempotency_in_progress: The first request with this key is still running.
422idempotency_key_reused
idempotency_key_reused: This key was used for a different request.
500internal
internal: Something went wrong on our side (quote the requestId).

curl

curl -X POST 'https://collection.id/api/v1/admin/plans' \
  -H "Authorization: Bearer $COLLECTOR_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H 'Content-Type: application/json' \
  -d @body.json

TypeScript SDK

await collector.grantAdminPlan({ body: { … } });

POST/api/v1/admin/plans/{id}/revoke

End a plan grant now

AdminBeta: may change

Audited; the collector is told.

SDK: collector.revokeAdminPlanGrant()
Key scopes: admin:users:write(API keys are coming soon)
Headers: X-Request-Id

Parameters

Name	In	Type	About
`id`required	path	string (uuid)

Request body (required, application/json)

object

reasonstringoptionalat most 500 characters

Responses

200The ended grant.
object
- grantobjectrequired
  Fields of grant
  idstringrequired
  revoked_atstringrequired

Errors (400, 404, 500)

400invalid_request invalid_json
invalid_request: The query or body doesn’t match the schema (see errors[]).
invalid_json: The body isn’t JSON.
404not_found
not_found: Not an admin (moderator): the same 404 as a missing route.
500internal
internal: Something went wrong on our side (quote the requestId).

curl

curl -X POST 'https://collection.id/api/v1/admin/plans/<id>/revoke' \
  -H "Authorization: Bearer $COLLECTOR_TOKEN" \
  -H 'Content-Type: application/json' \
  -d @body.json

TypeScript SDK

await collector.revokeAdminPlanGrant({ path: { id }, body: { … } });

GET/api/v1/admin/reports

Abuse reports

AdminBeta: may change

By status (oldest open first), with what was reported and who is responsible.

SDK: collector.listAdminReports()
Key scopes: admin:users:read(API keys are coming soon)
Headers: If-None-MatchX-Request-Id

Parameters

Name	In	Type	About
`status`optional	query	enum	Which items (default open).One of `open`, `dismissed`, `actioned`default "open"

Responses

200Reports.
AdminReportPage
- reportsarray of AdminReportrequired
- countsmap of numberrequired
304Not modified: your copy (the ETag in If-None-Match) is current.

Errors (400, 404, 500)

400invalid_request
invalid_request: The query or body doesn’t match the schema (see errors[]).
404not_found
not_found: Not an admin (moderator): the same 404 as a missing route.
500internal
internal: Something went wrong on our side (quote the requestId).

curl

curl 'https://collection.id/api/v1/admin/reports' \
  -H "Authorization: Bearer $COLLECTOR_TOKEN"

TypeScript SDK

await collector.listAdminReports({ query: { … } });

POST/api/v1/admin/reports/{id}

Decide a report

AdminBeta: may change

Dismiss it, hide the content, suspend the store or disable the account. Audited.

SDK: collector.resolveAdminReport()
Key scopes: admin:users:write(API keys are coming soon)
Headers: X-Request-Id

Parameters

Name	In	Type	About
`id`required	path	string (uuid)

Request body (required, application/json)

object

actionenumrequired
One ofdismisshide_contentsuspend_storedisable_account
notestringoptionalat most 1000 characters

Responses

200The report, decided.
object
- reportAdminReportrequired

Errors (400, 404, 409, 500)

400invalid_request invalid_json unsupported_action
invalid_request: The query or body doesn’t match the schema (see errors[]).
invalid_json: The body isn’t JSON.
unsupported_action: That action doesn’t apply to this kind of report.
404not_found
not_found: Not an admin (moderator): the same 404 as a missing route.
409already_resolved self_disable target_is_admin
already_resolved: It was already handled.
self_disable: Admins can’t disable their own account.
target_is_admin: The account is an admin; remove admin access first.
500internal
internal: Something went wrong on our side (quote the requestId).

curl

curl -X POST 'https://collection.id/api/v1/admin/reports/<id>' \
  -H "Authorization: Bearer $COLLECTOR_TOKEN" \
  -H 'Content-Type: application/json' \
  -d @body.json

TypeScript SDK

await collector.resolveAdminReport({ path: { id }, body: { … } });

POST/api/v1/admin/reports/{id}/restore

Undo “hide content” for a report

AdminBeta: may change

Audited.

SDK: collector.restoreAdminReportedContent()
Key scopes: admin:users:write(API keys are coming soon)
Headers: X-Request-Id

Parameters

Name	In	Type	About
`id`required	path	string (uuid)

Responses

200The report.
object
- reportAdminReportrequired

Errors (404, 500)

404not_found
not_found: Not an admin (moderator): the same 404 as a missing route.
500internal
internal: Something went wrong on our side (quote the requestId).

curl

curl -X POST 'https://collection.id/api/v1/admin/reports/<id>/restore' \
  -H "Authorization: Bearer $COLLECTOR_TOKEN"

TypeScript SDK

await collector.restoreAdminReportedContent({ path: { id } });

GET/api/v1/admin/stores

Stores

AdminBeta: may change

With verification and fee overrides. ?filter=unverified lists active shops awaiting review.

SDK: collector.listAdminStores()
Key scopes: admin:users:read(API keys are coming soon)
Headers: If-None-MatchX-Request-Id

Parameters

Name	In	Type	About
`q`optional	query	string
`filter`optional	query	enum	One of `all`, `unverified`default "all"

Responses

200Stores.
AdminStorePage
- storesarray of AdminStorerequired
- platformFeeBpsnumberrequired
304Not modified: your copy (the ETag in If-None-Match) is current.

Errors (400, 404, 500)

400invalid_request
invalid_request: The query or body doesn’t match the schema (see errors[]).
404not_found
not_found: Not an admin (moderator): the same 404 as a missing route.
500internal
internal: Something went wrong on our side (quote the requestId).

curl

curl 'https://collection.id/api/v1/admin/stores' \
  -H "Authorization: Bearer $COLLECTOR_TOKEN"

TypeScript SDK

await collector.listAdminStores({ query: { … } });

PATCH/api/v1/admin/stores/{id}

Verify, suspend or set a store’s fee

AdminBeta: may change

Verify or unverify a shop, suspend or reinstate it, set or clear its seller-fee override. Audited.

SDK: collector.updateAdminStore()
Key scopes: admin:users:write(API keys are coming soon)
Headers: X-Request-Id

Parameters

Name	In	Type	About
`id`required	path	string (uuid)

Request body (required, application/json)

object

isVerifiedbooleanoptional
feeBpsinteger or nulloptional0–3000
statusenumoptional
One ofactivesuspended

Responses

200The store’s settings now.
object
- storeobjectrequired
  Fields of store
  isVerifiedbooleanrequired
  feeBpsnumber or nullrequired
  statusstringoptional

Errors (400, 404, 500)

400invalid_request invalid_json
invalid_request: The query or body doesn’t match the schema (see errors[]).
invalid_json: The body isn’t JSON.
404not_found
not_found: Not an admin (moderator): the same 404 as a missing route.
500internal
internal: Something went wrong on our side (quote the requestId).

curl

curl -X PATCH 'https://collection.id/api/v1/admin/stores/<id>' \
  -H "Authorization: Bearer $COLLECTOR_TOKEN" \
  -H 'Content-Type: application/json' \
  -d @body.json

TypeScript SDK

await collector.updateAdminStore({ path: { id }, body: { … } });

GET/api/v1/admin/support

Support messages

AdminBeta: may change

From the Help/Contact form, newest first.

SDK: collector.listAdminSupportMessages()
Key scopes: admin:support:write(API keys are coming soon)
Headers: If-None-MatchX-Request-Id

Parameters

Name	In	Type	About
`status`optional	query	enum	Which items (default open).One of `open`, `closed`, `all`default "open"

Responses

200Messages.
AdminSupportPage
- messagesarray of AdminSupportMessagerequired
- countsobjectrequired
  Fields of counts
  opennumberrequired
  closednumberrequired
304Not modified: your copy (the ETag in If-None-Match) is current.

Errors (400, 404, 500, 503)

400invalid_request
invalid_request: The query or body doesn’t match the schema (see errors[]).
404not_found
not_found: Not an admin (moderator): the same 404 as a missing route.
500internal
internal: Something went wrong on our side (quote the requestId).
503not_migrated
not_migrated: The tool needs a database update that hasn’t been applied yet.

curl

curl 'https://collection.id/api/v1/admin/support' \
  -H "Authorization: Bearer $COLLECTOR_TOKEN"

TypeScript SDK

await collector.listAdminSupportMessages({ query: { … } });

PATCH/api/v1/admin/support/{id}

Close or reopen a support message

AdminBeta: may change

Set a support message to closed or back to open.

SDK: collector.updateAdminSupportMessage()
Key scopes: admin:support:write(API keys are coming soon)
Headers: X-Request-Id

Parameters

Name	In	Type	About
`id`required	path	string (uuid)

Request body (required, application/json)

object

statusenumrequired
One ofopenclosed

Responses

200The message.
object
- messageAdminSupportMessagerequired

Errors (400, 404, 500, 503)

400invalid_request invalid_json
invalid_request: The query or body doesn’t match the schema (see errors[]).
invalid_json: The body isn’t JSON.
404not_found
not_found: Not an admin (moderator): the same 404 as a missing route.
500internal
internal: Something went wrong on our side (quote the requestId).
503not_migrated
not_migrated: The tool needs a database update that hasn’t been applied yet.

curl

curl -X PATCH 'https://collection.id/api/v1/admin/support/<id>' \
  -H "Authorization: Bearer $COLLECTOR_TOKEN" \
  -H 'Content-Type: application/json' \
  -d @body.json

TypeScript SDK

await collector.updateAdminSupportMessage({ path: { id }, body: { … } });

GET/api/v1/admin/users

Search people

AdminBeta: may changePaginated (page)

By email, username, display name or id, newest first.

SDK: collector.searchAdminUsers()
Key scopes: admin:users:read(API keys are coming soon)
Headers: If-None-MatchX-Request-Id

Parameters

Name	In	Type	About
`q`optional	query	string
`offset`optional	query	integer	0–100000 · default 0

Responses

200A page of people.
AdminUserPage
- usersarray of AdminUserrequired
- totalnumberrequired
- offsetnumberrequired
- limitnumberrequired
304Not modified: your copy (the ETag in If-None-Match) is current.

Errors (400, 404, 500)

400invalid_request
invalid_request: The query or body doesn’t match the schema (see errors[]).
404not_found
not_found: Not an admin (moderator): the same 404 as a missing route.
500internal
internal: Something went wrong on our side (quote the requestId).

curl

curl 'https://collection.id/api/v1/admin/users' \
  -H "Authorization: Bearer $COLLECTOR_TOKEN"

TypeScript SDK

await collector.searchAdminUsers({ query: { … } });

PATCH/api/v1/admin/users/{id}

Change someone’s role or access

AdminBeta: may change

Grant or remove the admin or moderator role; disable or enable the account. Audited.

SDK: collector.updateAdminUser()
Key scopes: admin:users:write(API keys are coming soon)
Headers: X-Request-Id

Parameters

Name	In	Type	About
`id`required	path	string (uuid)

Request body (required, application/json)

object

adminbooleanoptional
moderatorbooleanoptional
disabledbooleanoptional

Responses

200The person as they are now.
object
- userAdminUserrequired

Errors (400, 404, 409, 500, 502)

400invalid_request invalid_json
invalid_request: The query or body doesn’t match the schema (see errors[]).
invalid_json: The body isn’t JSON.
404not_found
not_found: Not an admin (moderator): the same 404 as a missing route.
409self_demotion self_disable already_admin
self_demotion: Admins can’t remove their own admin access.
self_disable: Admins can’t disable their own account.
already_admin: Admins already work the moderation queues.
500internal
internal: Something went wrong on our side (quote the requestId).
502auth_update_failed
auth_update_failed: The sign-in service refused the change.

curl

curl -X PATCH 'https://collection.id/api/v1/admin/users/<id>' \
  -H "Authorization: Bearer $COLLECTOR_TOKEN" \
  -H 'Content-Type: application/json' \
  -d @body.json

TypeScript SDK

await collector.updateAdminUser({ path: { id }, body: { … } });