`MeResponse`

Who the calling key is: its display prefix, mode (live or test) and kind (genie for cd_ keys, compuconnect for cc_ keys); its integration (capability, access level, billing class); its store; for each resource the key can read, the fields it may request and the ones an omitted fields returns; its per-key rate limit; and, for the store's own keys, the store's credits for the month, as GET /v1/usage/current reports them without the per-endpoint breakdown. A key your organization holds for a store (a developer's key under the owner's approval, for instance) never sees the store's plan or credits: credits is left out, creditsNote says its calls are billed to your organization (or to the store, when the owner chose to pay), and usageUrl links your organization's usage at https://account.compudime.com/usage. Never the key itself. When billing cannot be read the answer is still 200, with credits left out and creditsNote saying so. Free; a good first call.

Type: object.

Name	Type	Description
`fieldPolicy` required	object	One entry per resource the key can read today, listing the operations that read it with exactly these fields. fields is every name the key may put in fields (fields=* returns all of them except namedOnlyFields); defaultFields is what an omitted fields returns under today's pricing; namedOnlyFields are sensitive fields the store owner granted this integration, returned only when the request names them. source policy: the integration's pinned field policy (policyId) decides the fields; source catalog: the resource's published field catalog does. Empty when the store has not enabled the key's capability (GET /v1/capabilities).
`fieldPolicy.policyId` required	string	The integration's pinned field policy.
`fieldPolicy.resources` required	array of object
`fieldPolicy.resources[].defaultFields` required	array of string	What an omitted fields returns today.
`fieldPolicy.resources[].endpoints` required	array of string	The operation ids that read the resource with these fields.
`fieldPolicy.resources[].fields` required	array of string	Every name the key may request.
`fieldPolicy.resources[].resource` required	string	The field catalog id (x-compudime-field-catalog.resource on the operations).
`fieldPolicy.resources[].source` required	string	policy: the pinned field policy decides the fields; catalog: the resource's published field catalog does. One of: policy, catalog.
`fieldPolicy.resources[].namedOnlyFields`	array of string	Sensitive fields granted to this integration, returned only when named.
`fieldPolicy.version` required	integer	The pinned policy's version, as fieldPolicyVersion on the product answers.
`fieldPolicy.rowScope`	array of object	The pinned row scope: the rows the key is limited to on the reads that honour it (see the Scoped API keys guide). Absent: every row of the store.
`fieldPolicy.rowScope[].field`	string
`fieldPolicy.rowScope[].op`	string	One of: eq, in, prefix.
`fieldPolicy.rowScope[].values`	array of string
`integration` required	object
`integration.accessLevel` required	string	The integration's access level, as GET /v1/capabilities returns it. One of: own, all.
`integration.billingClass` required	string	house: a CompuDime-owned integration, metered at zero (priceSource house); charged: every other integration. One of: charged, house.
`integration.capabilities` required	array of string	The capabilities the key carries: capabilityId for a cd_ key; for a cc_ key every capability CompuConnect lists for it (other CompuDime APIs' included).
`integration.capabilityId` required	string	The capability this integration reads under.
`integration.displayName` required	string
`integration.integrationId` required	string	The integration the key reads through; problem bodies name it too.
`integration.note`	string	Present on a cc_ key that carries more than one Public API capability: each reads through an integration of its own, and this answer describes the one named in capabilityId.
`key` required	object
`key.kind` required	string	genie for a cd_ key, compuconnect for a cc_ key (issued at account.compudime.com). One of: genie, compuconnect.
`key.mode` required	string	test: the key's calls draw on the monthly sandbox allowance of the organization that pays for them and are never charged; live: they are billed to that organization's plan (the store's, or a developer's under a store approval). One of: live, test.
`key.prefix` required	string	The key's display prefix (cd_live_, cd_test_, or the first 12 characters of a cc_ key), as the console and the request logs show it. Never more of the key.
`key.note`	string	Present on a test key: its calls are never charged.
`requestId` required	string
`store` required	object
`store.displayName` required	string
`store.storeId` required	string
`store.sandbox`	boolean	true when the key's store is the demo store (CompuDime Demo Market): its data is invented, only test keys may call it, and it is never billed. Absent for a real store.
`credits`	`UsageSummary`
`creditsNote`	string	Present when credits is absent, and says why: the store's credits could not be read (the rest of the answer is current), the store is the demo store, or the key is held by your organization rather than the store, so its calls are billed to your organization (or to the store, when its owner chose to pay) and the store's plan and credits are not shown to it.
`rateLimit`	object	The per-key limit every authenticated call passes, free ones included (see Rate limits). Billed calls are also held to the store plan's own per-minute ceiling.
`rateLimit.burst`	integer
`rateLimit.requestsPerMinute`	integer
`usageUrl`	string	Present on a key your organization holds for a store: where your organization's own usage is, https://account.compudime.com/usage.

Other fields can appear later. Ignore the ones you do not know.

Used by

GET /v1/me