Get information about the current user

curl --request GET \
  --url https://api.withampersand.com/v1/my-info \
  --header 'Authorization: Bearer <token>'

{
  "builder": {
    "id": "builder-id-123",
    "idpProvider": "clerk",
    "idpRef": "<string>",
    "createTime": "2023-11-07T05:31:56Z",
    "firstName": "<string>",
    "lastName": "<string>",
    "fullName": "<string>",
    "primaryEmail": "<string>"
  },
  "projectRoles": {},
  "orgRole": {
    "role": "admin",
    "principalType": "team",
    "principalId": "builder-id-123",
    "org": {
      "id": "9f7c3e2a-61b8-4f5c-8d1a-eb24f3b05d79",
      "label": "Acme Inc",
      "defaultTeamId": "<string>",
      "createTime": "2023-11-07T05:31:56Z",
      "updateTime": "2023-11-07T05:31:56Z"
    }
  }
}

GET

my-info

curl --request GET \
  --url https://api.withampersand.com/v1/my-info \
  --header 'Authorization: Bearer <token>'

{
  "builder": {
    "id": "builder-id-123",
    "idpProvider": "clerk",
    "idpRef": "<string>",
    "createTime": "2023-11-07T05:31:56Z",
    "firstName": "<string>",
    "lastName": "<string>",
    "fullName": "<string>",
    "primaryEmail": "<string>"
  },
  "projectRoles": {},
  "orgRole": {
    "role": "admin",
    "principalType": "team",
    "principalId": "builder-id-123",
    "org": {
      "id": "9f7c3e2a-61b8-4f5c-8d1a-eb24f3b05d79",
      "label": "Acme Inc",
      "defaultTeamId": "<string>",
      "createTime": "2023-11-07T05:31:56Z",
      "updateTime": "2023-11-07T05:31:56Z"
    }
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

Information about the current user and their organizations and projects

builder

Builder · object

required

Show child attributes

builder.id

string

required

The builder ID.

Example:

"builder-id-123"

builder.idpProvider

string

required

The identity provider

Example:

"clerk"

builder.idpRef

string

required

ID used by the identity provider

builder.createTime

string<date-time>

required

The time that the builder joined Ampersand.

builder.firstName

string

builder.lastName

string

builder.fullName

string

builder.primaryEmail

string

projectRoles

object

required

A map of project IDs to project roles for the builder.

Show child attributes

projectRoles.{key}

object

Show child attributes

projectRoles.{key}.role

string

required

The role of the builder in the project.

Example:

"admin"

projectRoles.{key}.principalType

enum<string>

required

The type of the principal.

Available options:

team,

builder

projectRoles.{key}.principalId

string

required

The ID of the team or builder.

Example:

"builder-id-123"

projectRoles.{key}.project

Project · object

required

Show child attributes

projectRoles.{key}.project.id

string

required

The project ID.

Example:

"my-project"

projectRoles.{key}.project.name

string

required

The project name.

Example:

"mailmonkey-staging"

projectRoles.{key}.project.appName

string

required

The name of the application, which is displayed to end users.

Example:

"MailMonkey"

projectRoles.{key}.project.createTime

string<date-time>

required

The time the project was created.

projectRoles.{key}.project.orgId

string

The organization ID that this project belongs to.

Example:

"9f7c3e2a-61b8-4f5c-8d1a-eb24f3b05d79"

projectRoles.{key}.project.updateTime

string<date-time>

The time the project was updated.

projectRoles.{key}.project.entitlements

object

The entitlements for the project.

Show child attributes

projectRoles.{key}.project.entitlements.brandingRemoval

object

Whether branding can be removed from the UI library.

Show child attributes

projectRoles.{key}.project.entitlements.brandingRemoval.value

boolean

required

Whether branding has been removed from the project.

orgRole

object

Show child attributes

orgRole.role

string

required

The role of the builder in the org.

Example:

"admin"

orgRole.principalType

enum<string>

required

The type of the principal.

Available options:

team,

builder

orgRole.principalId

string

required

The ID of the team or builder.

Example:

"builder-id-123"

orgRole.org

Organization · object

required

Show child attributes

orgRole.org.id

string

required

The organization ID.

Example:

"9f7c3e2a-61b8-4f5c-8d1a-eb24f3b05d79"

orgRole.org.label

string

required

The organization label.

Example:

"Acme Inc"

orgRole.org.defaultTeamId

string

required

The ID of the Everyone team for the org.

orgRole.org.createTime

string<date-time>

required

The time the organization was created.

orgRole.org.updateTime

string<date-time>

The time the organization was updated.

List organization's claimed domains Accept an invite

⌘I

Authentication

WRITE API

READ API

PLATFORM API

Get information about the current user

Authorizations

Response