query · Module: Accounts · Requires accounts:read
Arguments
Returns
ApiKey!
Errors
Errors are returned inerrors[], with the REST error object in extensions (type, code, param, request_id), using the codes in Conventions §9.
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
query ApiKey($id: ID!) {
apiKey(id: $id) {
id
object
name
type
livemode
created
updated
account
mode
scopes
prefix
last4
secret
created_by
last_used_at
expires_at
}
}
{
"id": "key_1a2B3c"
}
{
"data": {
"apiKey": {
"id": "key_1a2B3c",
"object": "api_key",
"name": "Example",
"type": "secret",
"livemode": true,
"created": 1791302400,
"updated": 1791302400,
"account": "acct_ada",
"mode": "test",
"scopes": [
"example"
],
"prefix": "example",
"last4": "example",
"secret": "example",
"created_by": "example",
"last_used_at": 1791302400,
"expires_at": 1791302400
}
}
}
Retrieve a ApiKey
query ApiKey($id: ID!) {
apiKey(id: $id) {
id
object
name
type
livemode
created
updated
account
mode
scopes
prefix
last4
secret
created_by
last_used_at
expires_at
}
}
{
"id": "key_1a2B3c"
}
{
"data": {
"apiKey": {
"id": "key_1a2B3c",
"object": "api_key",
"name": "Example",
"type": "secret",
"livemode": true,
"created": 1791302400,
"updated": 1791302400,
"account": "acct_ada",
"mode": "test",
"scopes": [
"example"
],
"prefix": "example",
"last4": "example",
"secret": "example",
"created_by": "example",
"last_used_at": 1791302400,
"expires_at": 1791302400
}
}
}
query · Module: Accounts · Requires accounts:read
| Argument | Type | Description |
|---|---|---|
id | ID! | The object’s ID. |
ApiKey!
| Field | Type |
|---|---|
id | String! |
object | ApiKeyObject! |
livemode | Boolean! |
created | Int! |
updated | Int |
account | String |
name | String! |
mode | ApiKeyMode! |
type | ApiKeyType! |
scopes | [String!] |
prefix | String |
last4 | String |
secret | String |
created_by | String |
last_used_at | Int |
expires_at | Int |
allowed_ips | [String!] |
user_metadata | UserMetadata |
carrier_metadata | CarrierMetadata |
system_metadata | SystemMetadata |
errors[], with the REST error object in extensions (type, code, param, request_id), using the codes in Conventions §9.
query ApiKey($id: ID!) {
apiKey(id: $id) {
id
object
name
type
livemode
created
updated
account
mode
scopes
prefix
last4
secret
created_by
last_used_at
expires_at
}
}
{
"id": "key_1a2B3c"
}
{
"data": {
"apiKey": {
"id": "key_1a2B3c",
"object": "api_key",
"name": "Example",
"type": "secret",
"livemode": true,
"created": 1791302400,
"updated": 1791302400,
"account": "acct_ada",
"mode": "test",
"scopes": [
"example"
],
"prefix": "example",
"last4": "example",
"secret": "example",
"created_by": "example",
"last_used_at": 1791302400,
"expires_at": 1791302400
}
}
}