Docs
ES

← Back to schema index

JsonApiResourceBase

Identity of a resource within the JSON:API envelope: the type it belongs to and its identifier. Every resource travelling in `data` carries it, alongside its `attributes`.

Properties

FieldTypeDescription
typestringResource type. It is a fixed value per resource and does not vary between responses; it tells resources apart when a collection mixes several.
idstringResource identifier, unique within its `type`. It always travels as a string, even when it originates from an auto-increment column.

Used in operations

  • GET /v1/auth/otp-status
  • POST /v1/auth/device-credentials
  • DELETE /v1/auth/device-credentials/{id}
  • GET /v1/users/me
  • PUT /v1/users/me
  • GET /v1/users/me/profile-detail
  • GET /v1/users/me/identities
  • POST /v1/validate
  • POST /v1/validate-ocr
  • GET /v1/validations/{id}
  • POST /v1/validations/{id}/cep/send-telegram
  • PUT /v1/validations/{id}/retry-policy
  • POST /v1/validations/{id}/cancel-retries
  • GET /v1/public/banks
  • GET /v1/public/bin-lookup/{bin}
  • GET /v1/beneficiaries
  • POST /v1/beneficiaries
  • PUT /v1/beneficiaries/{id}
  • POST /v1/beneficiaries/imports
  • GET /v1/beneficiaries/imports/{id}
  • GET /v1/beneficiaries/imports/{id}/preview
  • PATCH /v1/beneficiaries/imports/{id}/rows/{row_id}
  • POST /v1/beneficiaries/imports/{id}/commit
  • POST /v1/validations/imports
  • GET /v1/validations/imports/{id}
  • GET /v1/validations/imports/{id}/preview
  • PATCH /v1/validations/imports/{id}/rows/{row_id}
  • POST /v1/validations/imports/{id}/commit
  • GET /v1/summary
  • GET /v1/users/me/changelog/subscribe-status
  • POST /v1/users/me/changelog/subscribe
  • GET /v1/webhook-subscribers
  • POST /v1/webhook-subscribers
  • POST /v1/webhook-subscribers/{id}/rotate-secret
  • POST /v1/webhook-subscribers/{id}/test
  • GET /v1/admin/users
  • POST /v1/admin/users
  • PUT /v1/admin/users/{id}
  • PUT /v1/admin/users/{id}/suspend
  • GET /v1/admin/roles/{role}/users
  • GET /v1/admin/validations/{id}/raw
  • GET /v1/status/banxico
  • GET /v1/status/banxico/timeseries
  • GET /v1/webhooks
  • POST /v1/webhooks
  • PUT /v1/webhooks/{id}
  • GET /v1/webhooks/{id}/deliveries
  • POST /v1/webhooks/{id}/regenerate-secret
  • GET /v1/webhooks/deliveries
  • POST /v1/admin/plans/create/prepare
  • GET /v1/admin/plans/audit
  • GET /v1/admin/plans/audit/{id}
  • POST /v1/admin/plans/{slug}/update/prepare
  • GET /v1/admin/plans/{slug}/features
  • PUT /v1/admin/plans/{slug}/features
  • POST /v1/admin/plans/{slug}/prices/create/prepare
  • POST /v1/admin/plans/{slug}/prices/{id}/archive/prepare
  • POST /v1/admin/plans/{slug}/prices/{id}/edit/prepare
  • GET /v1/admin/plans/{slug}/prices/{id}/archived-sources
  • POST /v1/admin/plans/{slug}/prices/{id}/migrate-subscribers/prepare
  • POST /v1/admin/plans/{slug}/prices/{id}/migrate-subscribers/execute
  • POST /v1/admin/plans/{slug}/sync-stripe/prepare
  • POST /v1/admin/plans/{slug}/sync-stripe/execute
  • POST /v1/admin/plans/{slug}/test-checkout
  • POST /v1/admin/plans/{slug}/duplicate/prepare
  • POST /v1/admin/plans/{slug}/delete/prepare
  • GET /v1/plans
  • GET /v1/plans/public
  • GET /v1/plans/{slug}/prices
  • GET /v1/admin/migrations/status
  • GET /v1/admin/migrations/drift
  • GET /v1/admin/migrations/stats
  • GET /v1/admin/migrations/sql
  • GET /v1/admin/migrations/history
  • GET /v1/admin/seeders/status
  • GET /v1/admin/seeders/last-runs
  • GET /v1/admin/seeders/history
  • GET /v1/admin/tests/list
  • GET /v1/admin/tests/flaky
  • GET /v1/admin/tests/compare
  • GET /v1/admin/tests/cases/history
  • GET /v1/admin/tests/runs
  • GET /v1/admin/tests/runs/{id}
  • GET /v1/admin/tests/runs/{id}/detail
  • POST /v1/admin/tests/run
  • POST /v1/admin/tests/rerun-failed
  • POST /v1/admin/tests/runs/{id}/cancel
  • GET /v1/notifications
  • POST /v1/notifications/push/subscribe
  • POST /v1/notifications/push/fcm-token
  • DELETE /v1/notifications/{id}
  • POST /v1/notifications/{id}/read
  • GET /v1/admin/notifications/deliveries
  • GET /v1/admin/notifications/deliveries/{id}
  • GET /v1/admin/notifications/templates
  • POST /v1/admin/notifications/broadcasts
  • GET /v1/admin/notifications/broadcasts
  • GET /v1/admin/notifications/broadcasts/{id}
  • DELETE /v1/admin/notifications/broadcasts/{id}
  • POST /v1/admin/notifications/broadcasts/{id}/dispatch
  • GET /v1/admin/changelog/subscribers/count
  • POST /v1/admin/changelog/{version}/publish
  • POST /v1/admin/changelog/{version}/schedule
  • POST /v1/admin/changelog/{version}/cancel-publish
  • POST /v1/admin/changelog/{version}/cancel-adhoc
  • POST /v1/admin/changelog/{version}/broadcast-now
  • POST /v1/admin/announcements/broadcast
  • GET /v1/admin/changelog/broadcasts/{id}/detail
  • GET /v1/admin/changelog/stats
  • GET /v1/admin/bots/platforms
  • GET /v1/admin/bots/telegram/overview
  • GET /v1/admin/bots/telegram/settings
  • PUT /v1/admin/bots/telegram/settings
  • GET /v1/admin/bots/telegram/users
  • POST /v1/admin/bots/telegram/users/{id}/block
  • POST /v1/admin/bots/telegram/users/{id}/unblock
  • POST /v1/admin/bots/telegram/users/{id}/unlink
  • GET /v1/admin/bots/telegram/activity
  • GET /v1/admin/bots/telegram/activity/{id}
  • GET /v1/admin/bots/telegram/audit
  • GET /v1/admin/bots/telegram/identity
  • PUT /v1/admin/bots/telegram/identity
  • GET /v1/admin/bots/telegram/custom-commands
  • POST /v1/admin/bots/telegram/custom-commands
  • PUT /v1/admin/bots/telegram/custom-commands/{id}
  • PUT /v1/admin/bots/telegram/system-commands/reorder
  • GET /v1/admin/bots/telegram/system-commands
  • POST /v1/admin/bots/telegram/system-commands
  • PUT /v1/admin/bots/telegram/system-commands/{id}
  • GET /v1/admin/bots/telegram/broadcasts
  • GET /v1/admin/bots/telegram/broadcasts/{id}
  • DELETE /v1/admin/bots/telegram/broadcasts/{id}
  • GET /v1/billing/subscription
  • GET /v1/billing/invoices
  • POST /v1/billing/subscription/resume
  • POST /v1/billing/subscription/refresh
  • POST /v1/billing/subscription/cancel
  • GET /v1/billing/upcoming-invoice
  • GET /v1/billing/credits
  • GET /v1/billing/refunds
  • POST /v1/billing/checkout-session
  • POST /v1/billing/portal-session
  • POST /v1/webhooks/stripe
  • POST /v1/admin/billing/refund/prepare
  • POST /v1/admin/billing/refund/execute
  • POST /v1/admin/billing/comp/prepare
  • POST /v1/admin/billing/comp/execute
  • GET /v1/admin/billing/subscriptions/{user_id}
  • POST /v1/admin/billing/reconcile
  • GET /v1/admin/billing/webhook-events
  • GET /v1/admin/billing/webhook-events/{id}
  • POST /v1/admin/billing/webhook-events/{id}/replay
  • GET /v1/admin/billing/meter-outbox
  • GET /v1/admin/billing/audit
  • GET /v1/admin/billing/audit/{id}
  • POST /v1/billing/overage/enable
  • DELETE /v1/billing/overage/disable

Referenced by schemas