query · Module: Data Network · Requires data:read
Arguments
Returns
AccessGrant!
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 AccessGrant($id: ID!) {
accessGrant(id: $id) {
id
object
status
livemode
created
updated
grantor
grantee
subjects {
shipments
}
fields
purpose
expires_at
}
}
{
"id": "grt_1a2B3c"
}
{
"data": {
"accessGrant": {
"id": "grt_1a2B3c",
"object": "access_grant",
"status": "active",
"livemode": true,
"created": 1791302400,
"updated": 1791302400,
"grantor": "example",
"grantee": "example",
"subjects": {
"shipments": [
"example"
]
},
"fields": [
"example"
],
"purpose": "example",
"expires_at": 1791302400
}
}
}
Retrieve a AccessGrant
query AccessGrant($id: ID!) {
accessGrant(id: $id) {
id
object
status
livemode
created
updated
grantor
grantee
subjects {
shipments
}
fields
purpose
expires_at
}
}
{
"id": "grt_1a2B3c"
}
{
"data": {
"accessGrant": {
"id": "grt_1a2B3c",
"object": "access_grant",
"status": "active",
"livemode": true,
"created": 1791302400,
"updated": 1791302400,
"grantor": "example",
"grantee": "example",
"subjects": {
"shipments": [
"example"
]
},
"fields": [
"example"
],
"purpose": "example",
"expires_at": 1791302400
}
}
}
query · Module: Data Network · Requires data:read
| Argument | Type | Description |
|---|---|---|
id | ID! | The object’s ID. |
AccessGrant!
| Field | Type |
|---|---|
id | String! |
object | AccessGrantObject! |
livemode | Boolean! |
created | Int! |
updated | Int |
grantor | String! |
grantee | String! |
subjects | AccessGrantSubjects |
fields | [String!] |
purpose | String |
expires_at | Int |
status | AccessGrantStatus! |
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 AccessGrant($id: ID!) {
accessGrant(id: $id) {
id
object
status
livemode
created
updated
grantor
grantee
subjects {
shipments
}
fields
purpose
expires_at
}
}
{
"id": "grt_1a2B3c"
}
{
"data": {
"accessGrant": {
"id": "grt_1a2B3c",
"object": "access_grant",
"status": "active",
"livemode": true,
"created": 1791302400,
"updated": 1791302400,
"grantor": "example",
"grantee": "example",
"subjects": {
"shipments": [
"example"
]
},
"fields": [
"example"
],
"purpose": "example",
"expires_at": 1791302400
}
}
}