Skip to main content
GET
/
auth
/
users
/
{id}
Get user details
curl --request GET \
  --url https://backyard.posthoot.com/api/v1/auth/users/{id}
{
  "createdAt": "<string>",
  "email": "<string>",
  "files": [
    {
      "createdAt": "<string>",
      "id": "<string>",
      "isDeleted": true,
      "name": "<string>",
      "path": "<string>",
      "signedUrl": "<string>",
      "size": 2,
      "team": {
        "apiKeys": [
          {
            "createdAt": "<string>",
            "expiresAt": "<string>",
            "id": "<string>",
            "isDeleted": true,
            "key": "<string>",
            "lastUsedAt": "<string>",
            "name": "<string>",
            "permissions": [
              {}
            ],
            "team": {},
            "teamId": "<string>",
            "updatedAt": "<string>"
          }
        ],
        "automations": [
          {
            "createdAt": "<string>",
            "description": "<string>",
            "edges": [
              {}
            ],
            "id": "<string>",
            "isActive": true,
            "isDeleted": true,
            "name": "<string>",
            "nodes": [
              {}
            ],
            "team": {},
            "teamId": "<string>",
            "updatedAt": "<string>"
          }
        ],
        "campaigns": [
          {
            "analytics": [
              {}
            ],
            "batchDelay": -9223372036854776000,
            "batchSize": 123,
            "createdAt": "<string>",
            "cronExpression": "<string>",
            "description": "<string>",
            "id": "<string>",
            "isDeleted": true,
            "list": {
              "contactImports": [
                "<any>"
              ],
              "contacts": [
                "<any>"
              ],
              "createdAt": "<string>",
              "description": "<string>",
              "id": "<string>",
              "isDeleted": true,
              "name": "<string>",
              "team": {},
              "teamId": "<string>",
              "updatedAt": "<string>"
            },
            "listId": "<string>",
            "name": "<string>",
            "processed": 123,
            "recurringSchedule": "DAILY",
            "schedule": "ONE_TIME",
            "scheduledFor": "<string>",
            "sentEmails": [
              {}
            ],
            "smtpConfig": {
              "createdAt": "<string>",
              "fromEmail": "<string>",
              "host": "<string>",
              "id": "<string>",
              "isActive": true,
              "isDefault": true,
              "isDeleted": true,
              "maxSendRate": 2,
              "password": "<string>",
              "port": 32768,
              "provider": "CUSTOM",
              "requiresAuth": true,
              "supportsTls": true,
              "teamId": "<string>",
              "updatedAt": "<string>",
              "username": "<string>"
            },
            "smtpConfigId": "<string>",
            "status": "DRAFT",
            "team": {},
            "teamId": "<string>",
            "template": {
              "category": {},
              "categoryId": "<string>",
              "createdAt": "<string>",
              "designJson": "<string>",
              "emails": [
                "<any>"
              ],
              "htmlFile": {},
              "htmlFileId": "<string>",
              "id": "<string>",
              "isDeleted": true,
              "name": "<string>",
              "subject": "<string>",
              "team": {},
              "teamId": "<string>",
              "updatedAt": "<string>",
              "variables": [
                "<any>"
              ]
            },
            "templateId": "<string>",
            "timezone": "<string>",
            "updatedAt": "<string>"
          }
        ],
        "createdAt": "<string>",
        "domains": [
          {
            "createdAt": "<string>",
            "dnsRecord": "<string>",
            "domain": "<string>",
            "id": "<string>",
            "isDeleted": true,
            "isVerified": true,
            "teamId": "<string>",
            "updatedAt": "<string>"
          }
        ],
        "emailCategories": [
          {
            "createdAt": "<string>",
            "description": "<string>",
            "emails": [
              "<any>"
            ],
            "id": "<string>",
            "isDeleted": true,
            "name": "<string>",
            "team": {},
            "teamId": "<string>",
            "templates": [
              "<any>"
            ],
            "updatedAt": "<string>"
          }
        ],
        "id": "<string>",
        "invites": [
          {
            "code": "<string>",
            "createdAt": "<string>",
            "email": "<string>",
            "expiresAt": "<string>",
            "id": "<string>",
            "inviter": {},
            "inviterId": "<string>",
            "isDeleted": true,
            "name": "<string>",
            "role": "MEMBER",
            "status": "PENDING",
            "team": {},
            "teamId": "<string>",
            "updatedAt": "<string>"
          }
        ],
        "isDeleted": true,
        "mailingLists": [
          {
            "contactImports": [
              "<any>"
            ],
            "contacts": [
              "<any>"
            ],
            "createdAt": "<string>",
            "description": "<string>",
            "id": "<string>",
            "isDeleted": true,
            "name": "<string>",
            "team": {},
            "teamId": "<string>",
            "updatedAt": "<string>"
          }
        ],
        "models": [
          {
            "createdAt": "<string>",
            "description": "<string>",
            "id": "<string>",
            "isDeleted": true,
            "name": "<string>",
            "provider": "<string>",
            "team": {},
            "teamId": "<string>",
            "updatedAt": "<string>"
          }
        ],
        "name": "<string>",
        "settings": [
          {
            "branding": {
              "createdAt": "<string>",
              "dashboardName": "<string>",
              "id": "<string>",
              "isDeleted": true,
              "logoUrl": "<string>",
              "updatedAt": "<string>"
            },
            "brandingSettingsId": "<string>",
            "createdAt": "<string>",
            "id": "<string>",
            "inviteTemplateId": "<string>",
            "isDeleted": true,
            "teamId": "<string>",
            "updatedAt": "<string>",
            "welcomeTemplateId": "<string>"
          }
        ],
        "smtpConfigs": [
          {
            "createdAt": "<string>",
            "fromEmail": "<string>",
            "host": "<string>",
            "id": "<string>",
            "isActive": true,
            "isDefault": true,
            "isDeleted": true,
            "maxSendRate": 2,
            "password": "<string>",
            "port": 32768,
            "provider": "CUSTOM",
            "requiresAuth": true,
            "supportsTls": true,
            "teamId": "<string>",
            "updatedAt": "<string>",
            "username": "<string>"
          }
        ],
        "updatedAt": "<string>",
        "users": [
          {}
        ],
        "webhooks": [
          {
            "createdAt": "<string>",
            "deliveries": [
              {}
            ],
            "events": [
              "<string>"
            ],
            "id": "<string>",
            "isActive": true,
            "isDeleted": true,
            "name": "<string>",
            "secret": "<string>",
            "teamId": "<string>",
            "updatedAt": "<string>",
            "url": "<string>"
          }
        ]
      },
      "teamId": "<string>",
      "type": "<string>",
      "updatedAt": "<string>",
      "user": {},
      "userId": "<string>"
    }
  ],
  "firstName": "<string>",
  "id": "<string>",
  "invites": [
    {
      "code": "<string>",
      "createdAt": "<string>",
      "email": "<string>",
      "expiresAt": "<string>",
      "id": "<string>",
      "inviter": {},
      "inviterId": "<string>",
      "isDeleted": true,
      "name": "<string>",
      "role": "MEMBER",
      "status": "PENDING",
      "team": {},
      "teamId": "<string>",
      "updatedAt": "<string>"
    }
  ],
  "isDeleted": false,
  "lastName": "<string>",
  "permissions": [
    {
      "createdAt": "<string>",
      "id": "<string>",
      "isDeleted": false,
      "resourcePermission": {
        "createdAt": "<string>",
        "id": "<string>",
        "isDeleted": true,
        "resource": {
          "action": "<string>",
          "createdAt": "<string>",
          "id": "<string>",
          "isDeleted": true,
          "name": "<string>",
          "updatedAt": "<string>"
        },
        "resourceId": "<string>",
        "scope": "<string>",
        "updatedAt": "<string>"
      },
      "resourcePermissionId": "<string>",
      "updatedAt": "<string>",
      "user": {},
      "userId": "<string>"
    }
  ],
  "profilePicture": {
    "createdAt": "<string>",
    "id": "<string>",
    "isDeleted": true,
    "name": "<string>",
    "path": "<string>",
    "signedUrl": "<string>",
    "size": 2,
    "team": {
      "apiKeys": [
        {
          "createdAt": "<string>",
          "expiresAt": "<string>",
          "id": "<string>",
          "isDeleted": true,
          "key": "<string>",
          "lastUsedAt": "<string>",
          "name": "<string>",
          "permissions": [
            {}
          ],
          "team": {},
          "teamId": "<string>",
          "updatedAt": "<string>"
        }
      ],
      "automations": [
        {
          "createdAt": "<string>",
          "description": "<string>",
          "edges": [
            {}
          ],
          "id": "<string>",
          "isActive": true,
          "isDeleted": true,
          "name": "<string>",
          "nodes": [
            {}
          ],
          "team": {},
          "teamId": "<string>",
          "updatedAt": "<string>"
        }
      ],
      "campaigns": [
        {
          "analytics": [
            {}
          ],
          "batchDelay": -9223372036854776000,
          "batchSize": 123,
          "createdAt": "<string>",
          "cronExpression": "<string>",
          "description": "<string>",
          "id": "<string>",
          "isDeleted": true,
          "list": {
            "contactImports": [
              "<any>"
            ],
            "contacts": [
              "<any>"
            ],
            "createdAt": "<string>",
            "description": "<string>",
            "id": "<string>",
            "isDeleted": true,
            "name": "<string>",
            "team": {},
            "teamId": "<string>",
            "updatedAt": "<string>"
          },
          "listId": "<string>",
          "name": "<string>",
          "processed": 123,
          "recurringSchedule": "DAILY",
          "schedule": "ONE_TIME",
          "scheduledFor": "<string>",
          "sentEmails": [
            {}
          ],
          "smtpConfig": {
            "createdAt": "<string>",
            "fromEmail": "<string>",
            "host": "<string>",
            "id": "<string>",
            "isActive": true,
            "isDefault": true,
            "isDeleted": true,
            "maxSendRate": 2,
            "password": "<string>",
            "port": 32768,
            "provider": "CUSTOM",
            "requiresAuth": true,
            "supportsTls": true,
            "teamId": "<string>",
            "updatedAt": "<string>",
            "username": "<string>"
          },
          "smtpConfigId": "<string>",
          "status": "DRAFT",
          "team": {},
          "teamId": "<string>",
          "template": {
            "category": {},
            "categoryId": "<string>",
            "createdAt": "<string>",
            "designJson": "<string>",
            "emails": [
              "<any>"
            ],
            "htmlFile": {},
            "htmlFileId": "<string>",
            "id": "<string>",
            "isDeleted": true,
            "name": "<string>",
            "subject": "<string>",
            "team": {},
            "teamId": "<string>",
            "updatedAt": "<string>",
            "variables": [
              "<any>"
            ]
          },
          "templateId": "<string>",
          "timezone": "<string>",
          "updatedAt": "<string>"
        }
      ],
      "createdAt": "<string>",
      "domains": [
        {
          "createdAt": "<string>",
          "dnsRecord": "<string>",
          "domain": "<string>",
          "id": "<string>",
          "isDeleted": true,
          "isVerified": true,
          "teamId": "<string>",
          "updatedAt": "<string>"
        }
      ],
      "emailCategories": [
        {
          "createdAt": "<string>",
          "description": "<string>",
          "emails": [
            "<any>"
          ],
          "id": "<string>",
          "isDeleted": true,
          "name": "<string>",
          "team": {},
          "teamId": "<string>",
          "templates": [
            "<any>"
          ],
          "updatedAt": "<string>"
        }
      ],
      "id": "<string>",
      "invites": [
        {
          "code": "<string>",
          "createdAt": "<string>",
          "email": "<string>",
          "expiresAt": "<string>",
          "id": "<string>",
          "inviter": {},
          "inviterId": "<string>",
          "isDeleted": true,
          "name": "<string>",
          "role": "MEMBER",
          "status": "PENDING",
          "team": {},
          "teamId": "<string>",
          "updatedAt": "<string>"
        }
      ],
      "isDeleted": true,
      "mailingLists": [
        {
          "contactImports": [
            "<any>"
          ],
          "contacts": [
            "<any>"
          ],
          "createdAt": "<string>",
          "description": "<string>",
          "id": "<string>",
          "isDeleted": true,
          "name": "<string>",
          "team": {},
          "teamId": "<string>",
          "updatedAt": "<string>"
        }
      ],
      "models": [
        {
          "createdAt": "<string>",
          "description": "<string>",
          "id": "<string>",
          "isDeleted": true,
          "name": "<string>",
          "provider": "<string>",
          "team": {},
          "teamId": "<string>",
          "updatedAt": "<string>"
        }
      ],
      "name": "<string>",
      "settings": [
        {
          "branding": {
            "createdAt": "<string>",
            "dashboardName": "<string>",
            "id": "<string>",
            "isDeleted": true,
            "logoUrl": "<string>",
            "updatedAt": "<string>"
          },
          "brandingSettingsId": "<string>",
          "createdAt": "<string>",
          "id": "<string>",
          "inviteTemplateId": "<string>",
          "isDeleted": true,
          "teamId": "<string>",
          "updatedAt": "<string>",
          "welcomeTemplateId": "<string>"
        }
      ],
      "smtpConfigs": [
        {
          "createdAt": "<string>",
          "fromEmail": "<string>",
          "host": "<string>",
          "id": "<string>",
          "isActive": true,
          "isDefault": true,
          "isDeleted": true,
          "maxSendRate": 2,
          "password": "<string>",
          "port": 32768,
          "provider": "CUSTOM",
          "requiresAuth": true,
          "supportsTls": true,
          "teamId": "<string>",
          "updatedAt": "<string>",
          "username": "<string>"
        }
      ],
      "updatedAt": "<string>",
      "users": [
        {}
      ],
      "webhooks": [
        {
          "createdAt": "<string>",
          "deliveries": [
            {}
          ],
          "events": [
            "<string>"
          ],
          "id": "<string>",
          "isActive": true,
          "isDeleted": true,
          "name": "<string>",
          "secret": "<string>",
          "teamId": "<string>",
          "updatedAt": "<string>",
          "url": "<string>"
        }
      ]
    },
    "teamId": "<string>",
    "type": "<string>",
    "updatedAt": "<string>",
    "user": {},
    "userId": "<string>"
  },
  "profilePictureId": "<string>",
  "provider": "<string>",
  "providerData": [
    123
  ],
  "providerId": "<string>",
  "role": "SUPER_ADMIN",
  "team": {
    "apiKeys": [
      {
        "createdAt": "<string>",
        "expiresAt": "<string>",
        "id": "<string>",
        "isDeleted": true,
        "key": "<string>",
        "lastUsedAt": "<string>",
        "name": "<string>",
        "permissions": [
          {}
        ],
        "team": {},
        "teamId": "<string>",
        "updatedAt": "<string>"
      }
    ],
    "automations": [
      {
        "createdAt": "<string>",
        "description": "<string>",
        "edges": [
          {}
        ],
        "id": "<string>",
        "isActive": true,
        "isDeleted": true,
        "name": "<string>",
        "nodes": [
          {}
        ],
        "team": {},
        "teamId": "<string>",
        "updatedAt": "<string>"
      }
    ],
    "campaigns": [
      {
        "analytics": [
          {}
        ],
        "batchDelay": -9223372036854776000,
        "batchSize": 123,
        "createdAt": "<string>",
        "cronExpression": "<string>",
        "description": "<string>",
        "id": "<string>",
        "isDeleted": true,
        "list": {
          "contactImports": [
            "<any>"
          ],
          "contacts": [
            "<any>"
          ],
          "createdAt": "<string>",
          "description": "<string>",
          "id": "<string>",
          "isDeleted": true,
          "name": "<string>",
          "team": {},
          "teamId": "<string>",
          "updatedAt": "<string>"
        },
        "listId": "<string>",
        "name": "<string>",
        "processed": 123,
        "recurringSchedule": "DAILY",
        "schedule": "ONE_TIME",
        "scheduledFor": "<string>",
        "sentEmails": [
          {}
        ],
        "smtpConfig": {
          "createdAt": "<string>",
          "fromEmail": "<string>",
          "host": "<string>",
          "id": "<string>",
          "isActive": true,
          "isDefault": true,
          "isDeleted": true,
          "maxSendRate": 2,
          "password": "<string>",
          "port": 32768,
          "provider": "CUSTOM",
          "requiresAuth": true,
          "supportsTls": true,
          "teamId": "<string>",
          "updatedAt": "<string>",
          "username": "<string>"
        },
        "smtpConfigId": "<string>",
        "status": "DRAFT",
        "team": {},
        "teamId": "<string>",
        "template": {
          "category": {},
          "categoryId": "<string>",
          "createdAt": "<string>",
          "designJson": "<string>",
          "emails": [
            "<any>"
          ],
          "htmlFile": {},
          "htmlFileId": "<string>",
          "id": "<string>",
          "isDeleted": true,
          "name": "<string>",
          "subject": "<string>",
          "team": {},
          "teamId": "<string>",
          "updatedAt": "<string>",
          "variables": [
            "<any>"
          ]
        },
        "templateId": "<string>",
        "timezone": "<string>",
        "updatedAt": "<string>"
      }
    ],
    "createdAt": "<string>",
    "domains": [
      {
        "createdAt": "<string>",
        "dnsRecord": "<string>",
        "domain": "<string>",
        "id": "<string>",
        "isDeleted": true,
        "isVerified": true,
        "teamId": "<string>",
        "updatedAt": "<string>"
      }
    ],
    "emailCategories": [
      {
        "createdAt": "<string>",
        "description": "<string>",
        "emails": [
          "<any>"
        ],
        "id": "<string>",
        "isDeleted": true,
        "name": "<string>",
        "team": {},
        "teamId": "<string>",
        "templates": [
          "<any>"
        ],
        "updatedAt": "<string>"
      }
    ],
    "id": "<string>",
    "invites": [
      {
        "code": "<string>",
        "createdAt": "<string>",
        "email": "<string>",
        "expiresAt": "<string>",
        "id": "<string>",
        "inviter": {},
        "inviterId": "<string>",
        "isDeleted": true,
        "name": "<string>",
        "role": "MEMBER",
        "status": "PENDING",
        "team": {},
        "teamId": "<string>",
        "updatedAt": "<string>"
      }
    ],
    "isDeleted": true,
    "mailingLists": [
      {
        "contactImports": [
          "<any>"
        ],
        "contacts": [
          "<any>"
        ],
        "createdAt": "<string>",
        "description": "<string>",
        "id": "<string>",
        "isDeleted": true,
        "name": "<string>",
        "team": {},
        "teamId": "<string>",
        "updatedAt": "<string>"
      }
    ],
    "models": [
      {
        "createdAt": "<string>",
        "description": "<string>",
        "id": "<string>",
        "isDeleted": true,
        "name": "<string>",
        "provider": "<string>",
        "team": {},
        "teamId": "<string>",
        "updatedAt": "<string>"
      }
    ],
    "name": "<string>",
    "settings": [
      {
        "branding": {
          "createdAt": "<string>",
          "dashboardName": "<string>",
          "id": "<string>",
          "isDeleted": true,
          "logoUrl": "<string>",
          "updatedAt": "<string>"
        },
        "brandingSettingsId": "<string>",
        "createdAt": "<string>",
        "id": "<string>",
        "inviteTemplateId": "<string>",
        "isDeleted": true,
        "teamId": "<string>",
        "updatedAt": "<string>",
        "welcomeTemplateId": "<string>"
      }
    ],
    "smtpConfigs": [
      {
        "createdAt": "<string>",
        "fromEmail": "<string>",
        "host": "<string>",
        "id": "<string>",
        "isActive": true,
        "isDefault": true,
        "isDeleted": true,
        "maxSendRate": 2,
        "password": "<string>",
        "port": 32768,
        "provider": "CUSTOM",
        "requiresAuth": true,
        "supportsTls": true,
        "teamId": "<string>",
        "updatedAt": "<string>",
        "username": "<string>"
      }
    ],
    "updatedAt": "<string>",
    "users": [
      {}
    ],
    "webhooks": [
      {
        "createdAt": "<string>",
        "deliveries": [
          {}
        ],
        "events": [
          "<string>"
        ],
        "id": "<string>",
        "isActive": true,
        "isDeleted": true,
        "name": "<string>",
        "secret": "<string>",
        "teamId": "<string>",
        "updatedAt": "<string>",
        "url": "<string>"
      }
    ]
  },
  "teamId": "<string>",
  "updatedAt": "<string>"
}

Path Parameters

id
string
required

User ID

Response

OK

createdAt
string
email
string
files
object[]
firstName
string
id
string
invites
object[]
isDeleted
boolean
default:false
lastName
string
permissions
object[]
profilePicture
object
profilePictureId
string
provider
string

'local', 'google', etc.

providerData
integer[]

Additional data from provider

providerId
string

ID from the OAuth provider

role
enum<string>
Available options:
SUPER_ADMIN,
ADMIN,
MEMBER
team
object
teamId
string
updatedAt
string