PEpennylane
Users

User Profile

Changed on

This endpoint returns information about the company and the user associated to the token.

get/api/external/v2/me

Request

  • Base URL
    https://app.pennylane.com
  • URL
    https://app.pennylane.com/api/external/v2/me
  • Auth
    OAuth 2
    Authorization code: https://app.pennylane.com/oauth/authorize
    Token URL: https://app.pennylane.com/oauth/oauth/token

Headers

X-Company-Idstring
Example:12345

Numeric ID of the company to act on. Required when authenticating with a firm token. Ignored when the token is already bound to a company.

Response

Returns the user and the company

scopesstring[] required

OAuth scopes associated with the access token

Example response

{
  "user": {
    "id": 12345,
    "first_name": "John",
    "last_name": "Doe",
    "email": "jdoe@pennylane.com",
    "locale": "fr"
  },
  "company": {
    "id": 123456,
    "name": "Pennylane",
    "reg_no": "123456789",
    "accounting_logic": "FR_PCG"
  },
  "scopes": [
    "customer_invoices",
    "suppliers"
  ]
}

Changes

  • 871f863307e5Revision changes
    • warning

      added the new ES_PGC enum value to the / response property for the response status

    • info

      added the new optional header request parameter X-Company-Id