For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
DashboardGet an API key
Get StartedGuidesAPI ReferenceSDKsChangelog
Get StartedGuidesAPI ReferenceSDKsChangelog
  • Meta
    • GETGet current identity
    • GETLiveness probe
  • Customers
    • GETList customers
    • POSTCreate a customer
    • GETRetrieve a customer
    • DELDelete a customer
    • PATCHUpdate a customer
  • Contacts
    • GETList a customer's contacts
    • POSTAdd a contact to a customer
    • GETRetrieve a contact
    • DELDelete a contact
    • PATCHUpdate a contact
  • Onboardings
    • GETList onboardings
    • POSTCreate an onboarding
    • GETList a customer's onboardings
    • GETRetrieve an onboarding
    • DELDelete an onboarding
    • PATCHUpdate an onboarding
LogoLogo
DashboardGet an API key
Meta

Get current identity

|View as Markdown|Open in Claude|
GET
https://my.pivotal.app/api/v1/me
GET
/api/v1/me
1const url = 'https://my.pivotal.app/api/v1/me';
2const options = {
3 method: 'GET',
4 headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
5 body: '{}'
6};
7
8try {
9 const response = await fetch(url, options);
10 const data = await response.json();
11 console.log(data);
12} catch (error) {
13 console.error(error);
14}
200Retrieved
1{
2 "object": "me",
3 "api_key": {
4 "id": "api_1234567890abcdef",
5 "name": "Primary API Key",
6 "prefix": "pivotal_abc123",
7 "scopes": [
8 "read:customers",
9 "write:contacts",
10 "read:onboardings"
11 ],
12 "rate_limit_tier": "standard"
13 },
14 "organization": {
15 "id": "org_9876543210fedcba",
16 "slug": "acme-corp",
17 "name": "Acme Corporation"
18 }
19}

Returns the API key’s identity, organization, scopes, and rate-limit tier. Hit this first to confirm a newly-created key is wired up correctly.

Was this page helpful?
Next

Liveness probe

Built with

Authentication

AuthorizationBearer

Send your key in the Authorization header. Keys start with pivotal_ (production) or pivotal_test_ (test mode, no side effects on integrations). Rotate keys from /admin/api-keys — old keys 401 instantly when revoked.

Response

OK
objectenum
Allowed values:
api_keyobject
organizationobject