> ## Documentation Index
> Fetch the complete documentation index at: https://docs.getaptly.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get credential info

> Returns identity information for the credential used in the request. The response shape
depends on the auth method:

- **Delegate token** (`Authorization: DelegateToken <token>`): returns user identity and,
  if the token has an `appClientId`, embedded-app context.
- **API key** (`x-token` header or query param): returns company identity.
- **Partner token** (`Authorization: Bearer <token>`): returns the partner's permission list.




## OpenAPI

````yaml /openapi.yaml get /api/app/me
openapi: 3.0.3
info:
  title: Aptly API
  version: '1.0'
  description: >
    The Aptly API lets you read and write cards on any Aptly board from external
    systems.


    All requests require an API key passed as the `x-token` header.

    API keys are scoped to your company and work across all boards.
servers:
  - url: https://core-api.getaptly.com
    description: Production
security:
  - ApiKeyHeader: []
paths:
  /api/app/me:
    get:
      tags:
        - App
      summary: Get credential info
      description: >
        Returns identity information for the credential used in the request. The
        response shape

        depends on the auth method:


        - **Delegate token** (`Authorization: DelegateToken <token>`): returns
        user identity and,
          if the token has an `appClientId`, embedded-app context.
        - **API key** (`x-token` header or query param): returns company
        identity.

        - **Partner token** (`Authorization: Bearer <token>`): returns the
        partner's permission list.
      operationId: getMe
      responses:
        '200':
          description: Credential identity.
          content:
            application/json:
              schema:
                oneOf:
                  - title: Delegate token — user
                    type: object
                    properties:
                      type:
                        type: string
                        enum:
                          - user
                      userId:
                        type: string
                      email:
                        type: string
                        nullable: true
                      firstName:
                        type: string
                        nullable: true
                      lastName:
                        type: string
                        nullable: true
                      companyId:
                        type: string
                      companyName:
                        type: string
                        nullable: true
                  - title: Delegate token — app
                    type: object
                    properties:
                      type:
                        type: string
                        enum:
                          - app
                      userId:
                        type: string
                      email:
                        type: string
                        nullable: true
                      firstName:
                        type: string
                        nullable: true
                      lastName:
                        type: string
                        nullable: true
                      companyId:
                        type: string
                      companyName:
                        type: string
                        nullable: true
                      appClientId:
                        type: string
                      appTitle:
                        type: string
                        nullable: true
                  - title: API key
                    type: object
                    properties:
                      type:
                        type: string
                        enum:
                          - apiKey
                      companyId:
                        type: string
                      companyName:
                        type: string
                        nullable: true
                  - title: Partner token
                    type: object
                    properties:
                      type:
                        type: string
                        enum:
                          - partner
                      permissions:
                        type: array
                        items:
                          type: string
        '401':
          description: Invalid or missing credential.
      security:
        - ApiKeyHeader: []
        - DelegateToken: []
        - PartnerBearer: []
components:
  securitySchemes:
    ApiKeyHeader:
      type: apiKey
      in: header
      name: x-token
    DelegateToken:
      type: apiKey
      in: header
      name: Authorization
      description: 'Delegate token issued by the platform. Format: `DelegateToken <token>`'
    PartnerBearer:
      type: http
      scheme: bearer
      description: 'Partner token. Format: `Authorization: Bearer <token>`'

````