API Keys

Model

API Key Model

object "api_key"
The description of the model.

id string
The unique ID of the API key prefixed with key_

name string
A user-defined name for the API key.

last4 string
The last 4 characters of the API Key.

created_at integer
Time in epoch seconds when this resource was created.

updated_at integer
Time in epoch seconds when this resource was last updated.

expires_at integer
The timestamp when this API key will expire. If null, the key has no expiration date.

organization_id string
The unique identifier of the organization that owns this API key.

organization_name string
The name of the organization that owns this API key.

scopes Object
The scopes given to the API Key. Scopes are enumerated as an integer.

write: 2
read: 1
null: 0

Show Object


Object.organizations `integer`
Object.locations `integer`
Object.users `integer`
Object.payments `integer`
Object.payment_methods `integer`
Object.webhooks `integer`
Object.api_keys `integer`
Object.contacts `integer`
Object.groups `integer`
Object.addresses `integer`
Object.shipments `integer`
Object.trackers `integer`
Object.deliveries `integer`
Object.containers `integer`
Object.items `integer`
Object.assets `integer`
Object.fulfillments `integer`
Object.manifests `integer`
Object.lots `integer`
Object.audits `integer`
Object.admin_ai `integer`
Object.ai `integer`
Object.inferences `integer`
Object.scans `integer`
Object.sdk `integer`
Object.sequences `integer`
Object.parcels `integer`
Object.templates `integer`
Object.notifications `integer`
Object.events `integer`
Object.threads `integer`
Object.analytics `integer`

updated_by string
The ID of the user or key who last updated the api key.

system_generated boolean
If this API key was created by a third party or PackageX.

limit_to_location string
A location to which this API key is scoped. This key will only be able to access resources to this location to which is has appropriate scopes.

api_key string
This property will only exist on the key when it's initially created and will show the full API Key. After this, anytime you retrieve the key, this property will not exist. If you lose your API Key, you'll need to create a new one as there is no way for PackageX to retrieve this key either.

Model

# API Key Model

API Key Model