System

Get the calling credential

Last updated 7 November 2026

get/v1/me

Authentication

bearerAuth

bearerAuth: http / bearer — Use an Inth API key or OAuth access token in the Authorization header. Product operations need a capability. Feedback intake only requires authentication. An OAuth access token carries the capabilities it was granted as scopes; an organization API key carries a fixed set (`organizations.read`, `projects.read`, `projects.write`, `api-keys.read`, `inbox.read`, `billing.read`), so writes that name the person who made them, such as `inbox.write` and `vendors.write`, need a user token. A credential without the capability an operation needs is answered with `403 INSUFFICIENT_SCOPE`. `GET /v1/me` reports the capabilities of the calling credential. OAuth scopes: - `organizations.read`: List the organizations you belong to. - `organizations.write`: Create organizations you will own. - `projects.read`: Read projects, their consent configuration, and the vendors seen on them. - `projects.write`: Create, update, and delete projects and their consent configuration. - `members.read`: Read member names, email addresses, profile images, roles, and pending invitation email addresses. - `members.write`: Invite members, change member roles, remove members, and cancel invitations. - `api-keys.read`: List organization API keys. - `api-keys.write`: Create, roll, and delete organization API keys. - `code-audit.read`: Read Code Audit scans, their findings, and connected repositories. - `code-audit.write`: Start Code Audit scans and unlock their reports. - `inbox.read`: Read Inbox findings. - `inbox.write`: Change Inbox status or assignment and open GitHub issues for findings. - `vendors.write`: Approve or ignore vendors detected on your projects, which resolves their Inbox findings. - `billing.read`: Read the plan and credit balance of an organization. - `billing.details.read`: Read invoices, billing profiles, and payment method summaries for organizations you own. - `consent.read`: Read consent records, analytics, configuration, and runtime status. - `consent.write`: Update consent settings, translations, IAB configuration, and policies. - `consent.keys.read`: Read consent runtime key metadata. Secret values are never returned. - `website-audit.read`: Read website audit targets, scans, reports, cookies, and evidence. - `website-audit.write`: Manage website audit targets, verify domains, review findings, and start scans. - `account.read`: Read your account profile. - `notifications.read`: Read your notification preferences and organization routing. - `organization-retention.read`: Read organization provider data retention policy. - `support.read`: Read support conversations you own or can access through sharing. - `support.write`: Create support conversations, send messages, share or close them, and upload support attachments. - `consent.lifecycle.write`: Update, upgrade or delete Consent runtimes. - `consent.keys.write`: Create, rotate and revoke Consent runtime keys. - `billing.write`: Preview and change plans, buy credits, manage billing details and subscriptions, and open hosted payment flows. - `account.security.read`: Read your active browser sessions and connected device grants. - `account.security.write`: Revoke your browser sessions and connected device grants. - `integrations.read`: Read connected integration accounts, repositories, provider properties and project links. - `integrations.write`: Connect and sync providers, manage repository settings, project links and pull request monitoring. - `account.write`: Update your name, avatar and PII masking preference. - `account.delete`: Permanently delete your account after ownership checks and confirmation. - `notifications.write`: Update your notification preferences. - `notifications.routing.write`: Manage organization notification routing. - `organization-retention.write`: Change organization provider data retention policy. - `organizations.settings.write`: Update organization name, logo and slug. - `organizations.delete`: Permanently delete organizations you own after confirmation. - `agents.read`: Read your Inth Agent chats and chats shared with your organization. - `agents.write`: Start Inth Agent chats, send messages, share your chats with the organization, and delete your chats. Agent replies use organization credits.

Responses

`200`

The calling credential and its organizations.

Content type application/json

Property	Type	Required	Description
`success`	`boolean`	Required	—
`data`	`object`	Required	—
`data.principal`	`object`	Required	—
`data.principal.type`	`"session" \| "api_key" \| "oauth"`	Required	—
`data.principal.userId`	`string`	Optional	Present for session and oauth principals. API keys are organization credentials and carry no acting user.
`data.principal.keyId`	`string`	Optional	—
`data.principal.organizationId`	`string`	Optional	The organization the API key belongs to (api_key principals only).
`data.principal.createdBy`	`string`	Optional	User who minted the API key. Attribution only, never authorization.
`data.principal.activeOrganizationId`	`string \| null`	Optional	—
`data.activeOrganizationId`	`string \| null`	Required	—
`data.scopes`	"organizations.read" \| "organizations.write" \| "projects.read" \| "projects.write" \| "members.read" \| "members.write" \| "api-keys.read" \| "api-keys.write" \| "code-audit.read" \| "code-audit.write" \| "inbox.read" \| "inbox.write" \| "vendors.write" \| "billing.read" \| "billing.details.read" \| "consent.read" \| "consent.write" \| "consent.keys.read" \| "website-audit.read" \| "website-audit.write" \| "account.read" \| "notifications.read" \| "organization-retention.read" \| "support.read" \| "support.write" \| "consent.lifecycle.write" \| "consent.keys.write" \| "billing.write" \| "account.security.read" \| "account.security.write" \| "integrations.read" \| "integrations.write" \| "account.write" \| "account.delete" \| "notifications.write" \| "notifications.routing.write" \| "organization-retention.write" \| "organizations.settings.write" \| "organizations.delete" \| "agents.read" \| "agents.write"[]	Required	What the calling credential may do, sorted. Derived from the granted OAuth scopes for oauth principals; organization API keys carry a fixed set.
`data.organizations`	`object[]`	Required	Organizations the credential can reach. Empty when organizations.read was not granted.
`data.organizations[].id`	`string`	Required	—
`data.organizations[].slug`	`string`	Required	—
`data.organizations[].name`	`string`	Required	—
`data.organizations[].role`	`"owner" \| "admin" \| "member"`	Required	The role of the calling credential in this organization.

View JSON schema

{
  "type": "object",
  "required": [
    "success",
    "data"
  ],
  "properties": {
    "success": {
      "type": "boolean",
      "const": true
    },
    "data": {
      "type": "object",
      "required": [
        "principal",
        "activeOrganizationId",
        "scopes",
        "organizations"
      ],
      "properties": {
        "principal": {
          "type": "object",
          "required": [
            "type"
          ],
          "properties": {
            "type": {
              "type": "string",
              "enum": [
                "session",
                "api_key",
                "oauth"
              ]
            },
            "userId": {
              "type": "string",
              "description": "Present for session and oauth principals. API keys are organization credentials and carry no acting user."
            },
            "keyId": {
              "type": "string"
            },
            "organizationId": {
              "type": "string",
              "description": "The organization the API key belongs to (api_key principals only)."
            },
            "createdBy": {
              "type": "string",
              "description": "User who minted the API key. Attribution only, never authorization."
            },
            "activeOrganizationId": {
              "oneOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ]
            }
          }
        },
        "activeOrganizationId": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "scopes": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "organizations.read",
              "organizations.write",
              "projects.read",
              "projects.write",
              "members.read",
              "members.write",
              "api-keys.read",
              "api-keys.write",
              "code-audit.read",
              "code-audit.write",
              "inbox.read",
              "inbox.write",
              "vendors.write",
              "billing.read",
              "billing.details.read",
              "consent.read",
              "consent.write",
              "consent.keys.read",
              "website-audit.read",
              "website-audit.write",
              "account.read",
              "notifications.read",
              "organization-retention.read",
              "support.read",
              "support.write",
              "consent.lifecycle.write",
              "consent.keys.write",
              "billing.write",
              "account.security.read",
              "account.security.write",
              "integrations.read",
              "integrations.write",
              "account.write",
              "account.delete",
              "notifications.write",
              "notifications.routing.write",
              "organization-retention.write",
              "organizations.settings.write",
              "organizations.delete",
              "agents.read",
              "agents.write"
            ],
            "description": "Something a credential is allowed to do. Scope names double as OAuth scope strings.\n- `organizations.read`: List the organizations you belong to.\n- `organizations.write`: Create organizations you will own.\n- `projects.read`: Read projects, their consent configuration, and the vendors seen on them.\n- `projects.write`: Create, update, and delete projects and their consent configuration.\n- `members.read`: Read member names, email addresses, profile images, roles, and pending invitation email addresses.\n- `members.write`: Invite members, change member roles, remove members, and cancel invitations.\n- `api-keys.read`: List organization API keys.\n- `api-keys.write`: Create, roll, and delete organization API keys.\n- `code-audit.read`: Read Code Audit scans, their findings, and connected repositories.\n- `code-audit.write`: Start Code Audit scans and unlock their reports.\n- `inbox.read`: Read Inbox findings.\n- `inbox.write`: Change Inbox status or assignment and open GitHub issues for findings.\n- `vendors.write`: Approve or ignore vendors detected on your projects, which resolves their Inbox findings.\n- `billing.read`: Read the plan and credit balance of an organization.\n- `billing.details.read`: Read invoices, billing profiles, and payment method summaries for organizations you own.\n- `consent.read`: Read consent records, analytics, configuration, and runtime status.\n- `consent.write`: Update consent settings, translations, IAB configuration, and policies.\n- `consent.keys.read`: Read consent runtime key metadata. Secret values are never returned.\n- `website-audit.read`: Read website audit targets, scans, reports, cookies, and evidence.\n- `website-audit.write`: Manage website audit targets, verify domains, review findings, and start scans.\n- `account.read`: Read your account profile.\n- `notifications.read`: Read your notification preferences and organization routing.\n- `organization-retention.read`: Read organization provider data retention policy.\n- `support.read`: Read support conversations you own or can access through sharing.\n- `support.write`: Create support conversations, send messages, share or close them, and upload support attachments.\n- `consent.lifecycle.write`: Update, upgrade or delete Consent runtimes.\n- `consent.keys.write`: Create, rotate and revoke Consent runtime keys.\n- `billing.write`: Preview and change plans, buy credits, manage billing details and subscriptions, and open hosted payment flows.\n- `account.security.read`: Read your active browser sessions and connected device grants.\n- `account.security.write`: Revoke your browser sessions and connected device grants.\n- `integrations.read`: Read connected integration accounts, repositories, provider properties and project links.\n- `integrations.write`: Connect and sync providers, manage repository settings, project links and pull request monitoring.\n- `account.write`: Update your name, avatar and PII masking preference.\n- `account.delete`: Permanently delete your account after ownership checks and confirmation.\n- `notifications.write`: Update your notification preferences.\n- `notifications.routing.write`: Manage organization notification routing.\n- `organization-retention.write`: Change organization provider data retention policy.\n- `organizations.settings.write`: Update organization name, logo and slug.\n- `organizations.delete`: Permanently delete organizations you own after confirmation.\n- `agents.read`: Read your Inth Agent chats and chats shared with your organization.\n- `agents.write`: Start Inth Agent chats, send messages, share your chats with the organization, and delete your chats. Agent replies use organization credits."
          },
          "description": "What the calling credential may do, sorted. Derived from the granted OAuth scopes for oauth principals; organization API keys carry a fixed set."
        },
        "organizations": {
          "type": "array",
          "items": {
            "type": "object",
            "required": [
              "id",
              "slug",
              "name",
              "role"
            ],
            "properties": {
              "id": {
                "type": "string"
              },
              "slug": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "role": {
                "type": "string",
                "enum": [
                  "owner",
                  "admin",
                  "member"
                ],
                "description": "The role of the calling credential in this organization."
              }
            }
          },
          "description": "Organizations the credential can reach. Empty when organizations.read was not granted."
        }
      }
    }
  }
}

`401`

Authentication is missing, invalid, or expired.

Content type application/json

Property	Type	Required	Description
`success`	`boolean`	Required	—
`error`	`object`	Required	—
`error.code`	`"UNAUTHORIZED" \| "FORBIDDEN" \| "INSUFFICIENT_SCOPE" \| "PLAN_LIMIT_REACHED" \| "PLAN_REQUIRED" \| "INVALID_ORIGIN" \| "INVALID_REGION" \| "INVALID_PAYLOAD" \| "NOT_FOUND" \| "CONFLICT" \| "KEY_LIMIT_REACHED" \| "INSUFFICIENT_CREDITS" \| "SCAN_IN_PROGRESS" \| "UNLOCK_REQUIRED" \| "REPOSITORY_NOT_LINKED" \| "PAYLOAD_TOO_LARGE" \| "RATE_LIMITED" \| "SERVICE_UNAVAILABLE" \| "INTERNAL_ERROR"`	Required	—
`error.message`	`string`	Required	—
`error.details`	`unknown`	Optional	Optional structured error details.

View JSON schema

{
  "type": "object",
  "required": [
    "success",
    "error"
  ],
  "properties": {
    "success": {
      "type": "boolean",
      "const": false
    },
    "error": {
      "type": "object",
      "required": [
        "code",
        "message"
      ],
      "properties": {
        "code": {
          "type": "string",
          "enum": [
            "UNAUTHORIZED",
            "FORBIDDEN",
            "INSUFFICIENT_SCOPE",
            "PLAN_LIMIT_REACHED",
            "PLAN_REQUIRED",
            "INVALID_ORIGIN",
            "INVALID_REGION",
            "INVALID_PAYLOAD",
            "NOT_FOUND",
            "CONFLICT",
            "KEY_LIMIT_REACHED",
            "INSUFFICIENT_CREDITS",
            "SCAN_IN_PROGRESS",
            "UNLOCK_REQUIRED",
            "REPOSITORY_NOT_LINKED",
            "PAYLOAD_TOO_LARGE",
            "RATE_LIMITED",
            "SERVICE_UNAVAILABLE",
            "INTERNAL_ERROR"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "description": "Optional structured error details."
        }
      }
    }
  }
}

`403`

The credential is valid but may not perform the operation. `INSUFFICIENT_SCOPE`: the credential was never granted the capability the operation needs. `details.requiredScope` names it, and the `WWW-Authenticate` header carries `Bearer error="insufficient_scope"`. An OAuth client fixes this by requesting the scope; an organization API key cannot gain it. `FORBIDDEN`: the capability is present but the membership behind the credential lacks the role, or the resource belongs to another organization.

Content type application/json

Property	Type	Required	Description
`success`	`boolean`	Required	—
`error`	`object`	Required	—
`error.code`	`"UNAUTHORIZED" \| "FORBIDDEN" \| "INSUFFICIENT_SCOPE" \| "PLAN_LIMIT_REACHED" \| "PLAN_REQUIRED" \| "INVALID_ORIGIN" \| "INVALID_REGION" \| "INVALID_PAYLOAD" \| "NOT_FOUND" \| "CONFLICT" \| "KEY_LIMIT_REACHED" \| "INSUFFICIENT_CREDITS" \| "SCAN_IN_PROGRESS" \| "UNLOCK_REQUIRED" \| "REPOSITORY_NOT_LINKED" \| "PAYLOAD_TOO_LARGE" \| "RATE_LIMITED" \| "SERVICE_UNAVAILABLE" \| "INTERNAL_ERROR"`	Required	—
`error.message`	`string`	Required	—
`error.details`	`unknown`	Optional	Optional structured error details.

View JSON schema

{
  "type": "object",
  "required": [
    "success",
    "error"
  ],
  "properties": {
    "success": {
      "type": "boolean",
      "const": false
    },
    "error": {
      "type": "object",
      "required": [
        "code",
        "message"
      ],
      "properties": {
        "code": {
          "type": "string",
          "enum": [
            "UNAUTHORIZED",
            "FORBIDDEN",
            "INSUFFICIENT_SCOPE",
            "PLAN_LIMIT_REACHED",
            "PLAN_REQUIRED",
            "INVALID_ORIGIN",
            "INVALID_REGION",
            "INVALID_PAYLOAD",
            "NOT_FOUND",
            "CONFLICT",
            "KEY_LIMIT_REACHED",
            "INSUFFICIENT_CREDITS",
            "SCAN_IN_PROGRESS",
            "UNLOCK_REQUIRED",
            "REPOSITORY_NOT_LINKED",
            "PAYLOAD_TOO_LARGE",
            "RATE_LIMITED",
            "SERVICE_UNAVAILABLE",
            "INTERNAL_ERROR"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "description": "Optional structured error details."
        }
      }
    }
  }
}

Headers

Name	Type	Description
`WWW-Authenticate`	`string`	Present on `INSUFFICIENT_SCOPE`: `Bearer error="insufficient_scope", scope="<required scope>"`.

`500`

An unexpected internal error occurred.

Content type application/json

Property	Type	Required	Description
`success`	`boolean`	Required	—
`error`	`object`	Required	—
`error.code`	`"UNAUTHORIZED" \| "FORBIDDEN" \| "INSUFFICIENT_SCOPE" \| "PLAN_LIMIT_REACHED" \| "PLAN_REQUIRED" \| "INVALID_ORIGIN" \| "INVALID_REGION" \| "INVALID_PAYLOAD" \| "NOT_FOUND" \| "CONFLICT" \| "KEY_LIMIT_REACHED" \| "INSUFFICIENT_CREDITS" \| "SCAN_IN_PROGRESS" \| "UNLOCK_REQUIRED" \| "REPOSITORY_NOT_LINKED" \| "PAYLOAD_TOO_LARGE" \| "RATE_LIMITED" \| "SERVICE_UNAVAILABLE" \| "INTERNAL_ERROR"`	Required	—
`error.message`	`string`	Required	—
`error.details`	`unknown`	Optional	Optional structured error details.

View JSON schema

{
  "type": "object",
  "required": [
    "success",
    "error"
  ],
  "properties": {
    "success": {
      "type": "boolean",
      "const": false
    },
    "error": {
      "type": "object",
      "required": [
        "code",
        "message"
      ],
      "properties": {
        "code": {
          "type": "string",
          "enum": [
            "UNAUTHORIZED",
            "FORBIDDEN",
            "INSUFFICIENT_SCOPE",
            "PLAN_LIMIT_REACHED",
            "PLAN_REQUIRED",
            "INVALID_ORIGIN",
            "INVALID_REGION",
            "INVALID_PAYLOAD",
            "NOT_FOUND",
            "CONFLICT",
            "KEY_LIMIT_REACHED",
            "INSUFFICIENT_CREDITS",
            "SCAN_IN_PROGRESS",
            "UNLOCK_REQUIRED",
            "REPOSITORY_NOT_LINKED",
            "PAYLOAD_TOO_LARGE",
            "RATE_LIMITED",
            "SERVICE_UNAVAILABLE",
            "INTERNAL_ERROR"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "description": "Optional structured error details."
        }
      }
    }
  }
}

REST API overview: Every operation in this API.

Examples

const response = await fetch("https://api.inth.com/v1/me", {
  method: "GET",
  headers: {
    "Authorization": "Bearer <token>"
  },
});
const data = await response.json();

Response · 200

{
  "success": true,
  "data": {
    "principal": {
      "type": "api_key",
      "keyId": "key_123",
      "organizationId": "org_123",
      "createdBy": "usr_123"
    },
    "activeOrganizationId": "org_123",
    "scopes": [
      "api-keys.read",
      "organizations.read",
      "projects.read",
      "projects.write"
    ],
    "organizations": [
      {
        "id": "org_123",
        "slug": "acme",
        "name": "Acme",
        "role": "owner"
      }
    ]
  }
}

Response · 401

{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Authentication required"
  }
}

Response · 403

{
  "success": false,
  "error": {
    "code": "INSUFFICIENT_SCOPE",
    "message": "This token was not granted the projects.write scope",
    "details": {
      "requiredScope": "projects.write"
    }
  }
}

{
  "success": false,
  "error": {
    "code": "FORBIDDEN",
    "message": "Organization membership is required"
  }
}

Response · 500

{
  "success": false,
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "Internal server error"
  }
}

Authentication

Responses

200

401

403

Headers

500

Related

`200`

`401`

`403`

`500`