WorkOS · Schema
UserApiKeyList
AuthenticationIdentity ProviderSSOSAMLOIDCSCIMDirectory SyncAuthorizationFGAAudit LogsMFAB2B SaaSAgentsMCP
Properties
| Name | Type | Description |
|---|---|---|
| object | string | Indicates this is a list response. |
| data | array | The list of records for the current page. |
| list_metadata | object | Pagination cursors for navigating between pages of results. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/UserApiKeyList",
"title": "UserApiKeyList",
"type": "object",
"properties": {
"object": {
"type": "string",
"description": "Indicates this is a list response.",
"const": "list"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserApiKey"
},
"description": "The list of records for the current page."
},
"list_metadata": {
"type": "object",
"properties": {
"before": {
"type": [
"string",
"null"
],
"description": "An object ID that defines your place in the list. When the ID is not present, you are at the start of the list.",
"example": "api_key_01HXYZ123456789ABCDEFGHIJ"
},
"after": {
"type": [
"string",
"null"
],
"description": "An object ID that defines your place in the list. When the ID is not present, you are at the end of the list.",
"example": "api_key_01HXYZ987654321KJIHGFEDCBA"
}
},
"required": [
"before",
"after"
],
"description": "Pagination cursors for navigating between pages of results."
}
},
"required": [
"object",
"data",
"list_metadata"
]
}