---
updatedAt: 2026-06-15T13:01:23.000Z
agentTools:
  projectIndex: https://developers.airsaas.io/llms.txt
---

# Get profile

Get profile information about the authorization token used. Includes information about the corresponding user account and the corresponding workspace. `job_title` and `current_position` both contain the user's job title; `current_position` is kept for backward compatibility. `persona` is the job category selected by the user (`pm`, `pmo`, `director` or `other`). The `email` field is only included when authenticating with an API key or when the OAuth token has the `email` scope.

# OpenAPI definition

```json
{
  "openapi": "3.0.3",
  "info": {
    "title": "API Endpoints",
    "version": "1.0 (v1)",
    "description": "API to access AirSaas resources"
  },
  "paths": {
    "/v1/profile": {
      "get": {
        "operationId": "profile_retrieve",
        "description": "Get profile information about the authorization token used. Includes information about the corresponding user account and the corresponding workspace. `job_title` and `current_position` both contain the user's job title; `current_position` is kept for backward compatibility. `persona` is the job category selected by the user (`pm`, `pmo`, `director` or `other`). The `email` field is only included when authenticating with an API key or when the OAuth token has the `email` scope.",
        "summary": "Get profile",
        "tags": [
          "Profile"
        ],
        "security": [
          {
            "apiKeyAuth": []
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Profile"
                },
                "examples": {
                  "Example1": {
                    "value": {
                      "id": "3cbf5fc9-0785-499f-b267-3c583eee14cb",
                      "given_name": "John",
                      "family_name": "Doe",
                      "name": "John Doe",
                      "initials": "JD",
                      "picture": "",
                      "current_position": "Project Manager",
                      "email": "john.doe@example.com",
                      "workspace": {
                        "id": "0710d0bc-2f16-43c6-ad9d-ed3227c20b5c",
                        "name": "My Workspace",
                        "slug": "my-workspace",
                        "logo": "https://airsaas.io/logo.jpg",
                        "currency": "EUR",
                        "branding_options": {
                          "colors": {
                            "primary": "#3C51E2",
                            "secondary": "#061333",
                            "bg_rect_1": "#eef1f4",
                            "bg_rect_2": "#f5f6ff",
                            "bg_rect_3": "#fbfbfb",
                            "slide_background": "#FFFFFF",
                            "font": "#061333"
                          }
                        }
                      },
                      "sub": "3cbf5fc9-0785-499f-b267-3c583eee14cb",
                      "email_verified": true,
                      "job_title": "Project Manager",
                      "persona": "pm"
                    },
                    "summary": "OK"
                  }
                }
              }
            },
            "description": ""
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "NullEnum": {
        "enum": [
          null
        ]
      },
      "PersonaEnum": {
        "enum": [
          "pm",
          "pmo",
          "director",
          "other"
        ],
        "type": "string"
      },
      "Profile": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "given_name": {
            "type": "string",
            "maxLength": 40
          },
          "family_name": {
            "type": "string",
            "maxLength": 40
          },
          "name": {
            "type": "string",
            "readOnly": true
          },
          "initials": {
            "type": "string",
            "readOnly": true
          },
          "picture": {
            "type": "string",
            "format": "uri",
            "readOnly": true
          },
          "current_position": {
            "type": "string",
            "nullable": true,
            "maxLength": 128
          },
          "sub": {
            "type": "string",
            "readOnly": true
          },
          "email_verified": {
            "type": "boolean",
            "readOnly": true
          },
          "job_title": {
            "type": "string",
            "readOnly": true,
            "nullable": true,
            "description": "Job title of the user"
          },
          "persona": {
            "readOnly": true,
            "nullable": true,
            "description": "Job category selected by the user during onboarding",
            "oneOf": [
              {
                "$ref": "#/components/schemas/PersonaEnum"
              },
              {
                "$ref": "#/components/schemas/NullEnum"
              }
            ]
          },
          "workspace": {
            "allOf": [
              {
                "$ref": "#/components/schemas/SimpleWorkspace"
              }
            ],
            "readOnly": true
          }
        },
        "required": [
          "id"
        ]
      },
      "SimpleWorkspace": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "slug": {
            "type": "string",
            "nullable": true,
            "maxLength": 32,
            "pattern": "^[-a-zA-Z0-9_]+$"
          },
          "logo": {
            "type": "string",
            "readOnly": true
          },
          "currency": {
            "type": "string"
          },
          "branding_options": {
            "allOf": [
              {
                "$ref": "#/components/schemas/WorkspaceBrandingOptions"
              }
            ],
            "readOnly": true
          },
          "feature_flag_effort_generator": {
            "type": "boolean"
          }
        },
        "required": [
          "currency",
          "id",
          "name"
        ]
      },
      "WorkspaceBrandingColors": {
        "type": "object",
        "properties": {
          "primary": {
            "type": "string"
          },
          "secondary": {
            "type": "string"
          },
          "bg_rect_1": {
            "type": "string"
          },
          "bg_rect_2": {
            "type": "string"
          },
          "bg_rect_3": {
            "type": "string"
          },
          "slide_background": {
            "type": "string"
          },
          "font": {
            "type": "string"
          }
        },
        "required": [
          "bg_rect_1",
          "bg_rect_2",
          "bg_rect_3",
          "font",
          "primary",
          "secondary",
          "slide_background"
        ]
      },
      "WorkspaceBrandingOptions": {
        "type": "object",
        "properties": {
          "colors": {
            "$ref": "#/components/schemas/WorkspaceBrandingColors"
          }
        },
        "required": [
          "colors"
        ]
      }
    },
    "securitySchemes": {
      "apiKeyAuth": {
        "type": "apiKey",
        "in": "header",
        "name": "Authorization",
        "description": "Token-based authentication with required prefix \"Api-Key\""
      }
    }
  },
  "x-readme": {
    "samples-languages": [
      "curl",
      "node",
      "python"
    ]
  },
  "servers": [
    {
      "url": "https://api.airsaas.io"
    }
  ],
  "tags": [
    {
      "name": "Profile"
    }
  ]
}
```