Skip to main content
GET
/
auth
/
users
List all users
curl --request GET \
  --url https://backyard.posthoot.com/api/v1/auth/users
[
  {
    "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": [
                "<any>"
              ],
              "team": {},
              "teamId": "<string>",
              "updatedAt": "<string>"
            }
          ],
          "automations": [
            {
              "createdAt": "<string>",
              "description": "<string>",
              "edges": [
                "<any>"
              ],
              "id": "<string>",
              "isActive": true,
              "isDeleted": true,
              "name": "<string>",
              "nodes": [
                "<any>"
              ],
              "team": {},
              "teamId": "<string>",
              "updatedAt": "<string>"
            }
          ],
          "campaigns": [
            {
              "analytics": [
                "<any>"
              ],
              "batchDelay": -9223372036854776000,
              "batchSize": 123,
              "createdAt": "<string>",
              "cronExpression": "<string>",
              "description": "<string>",
              "id": "<string>",
              "isDeleted": true,
              "list": {
                "contactImports": "<any>",
                "contacts": "<any>",
                "createdAt": "<any>",
                "description": "<any>",
                "id": "<any>",
                "isDeleted": "<any>",
                "name": "<any>",
                "team": "<any>",
                "teamId": "<any>",
                "updatedAt": "<any>"
              },
              "listId": "<string>",
              "name": "<string>",
              "processed": 123,
              "recurringSchedule": "DAILY",
              "schedule": "ONE_TIME",
              "scheduledFor": "<string>",
              "sentEmails": [
                "<any>"
              ],
              "smtpConfig": {
                "createdAt": "<any>",
                "fromEmail": "<any>",
                "host": "<any>",
                "id": "<any>",
                "isActive": "<any>",
                "isDefault": "<any>",
                "isDeleted": "<any>",
                "maxSendRate": "<any>",
                "password": "<any>",
                "port": "<any>",
                "provider": "<any>",
                "requiresAuth": "<any>",
                "supportsTls": "<any>",
                "teamId": "<any>",
                "updatedAt": "<any>",
                "username": "<any>"
              },
              "smtpConfigId": "<string>",
              "status": "DRAFT",
              "team": {},
              "teamId": "<string>",
              "template": {
                "category": "<any>",
                "categoryId": "<any>",
                "createdAt": "<any>",
                "designJson": "<any>",
                "emails": "<any>",
                "htmlFile": "<any>",
                "htmlFileId": "<any>",
                "id": "<any>",
                "isDeleted": "<any>",
                "name": "<any>",
                "subject": "<any>",
                "team": "<any>",
                "teamId": "<any>",
                "updatedAt": "<any>",
                "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": "<any>",
              "description": "<any>",
              "emails": "<any>",
              "id": "<any>",
              "isDeleted": "<any>",
              "name": "<any>",
              "team": "<any>",
              "teamId": "<any>",
              "templates": "<any>",
              "updatedAt": "<any>"
            }
          ],
          "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": "<any>",
              "description": "<any>",
              "id": "<any>",
              "isDeleted": "<any>",
              "name": "<any>",
              "team": "<any>",
              "teamId": "<any>",
              "updatedAt": "<any>"
            }
          ],
          "models": [
            {
              "createdAt": "<string>",
              "description": "<string>",
              "id": "<string>",
              "isDeleted": true,
              "name": "<string>",
              "provider": "<string>",
              "team": {},
              "teamId": "<string>",
              "updatedAt": "<string>"
            }
          ],
          "name": "<string>",
          "settings": [
            {
              "branding": {
                "createdAt": "<any>",
                "dashboardName": "<any>",
                "id": "<any>",
                "isDeleted": "<any>",
                "logoUrl": "<any>",
                "updatedAt": "<any>"
              },
              "brandingSettingsId": "<string>",
              "createdAt": "<string>",
              "id": "<string>",
              "inviteTemplateId": "<string>",
              "isDeleted": true,
              "teamId": "<string>",
              "updatedAt": "<string>",
              "welcomeTemplateId": "<string>"
            }
          ],
          "smtpConfigs": [
            {
              "createdAt": "<any>",
              "fromEmail": "<any>",
              "host": "<any>",
              "id": "<any>",
              "isActive": "<any>",
              "isDefault": "<any>",
              "isDeleted": "<any>",
              "maxSendRate": "<any>",
              "password": "<any>",
              "port": "<any>",
              "provider": "<any>",
              "requiresAuth": "<any>",
              "supportsTls": "<any>",
              "teamId": "<any>",
              "updatedAt": "<any>",
              "username": "<any>"
            }
          ],
          "updatedAt": "<string>",
          "users": [
            {}
          ],
          "webhooks": [
            {
              "createdAt": "<string>",
              "deliveries": [
                "<any>"
              ],
              "events": [
                "<any>"
              ],
              "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": [
              "<any>"
            ],
            "team": {},
            "teamId": "<string>",
            "updatedAt": "<string>"
          }
        ],
        "automations": [
          {
            "createdAt": "<string>",
            "description": "<string>",
            "edges": [
              "<any>"
            ],
            "id": "<string>",
            "isActive": true,
            "isDeleted": true,
            "name": "<string>",
            "nodes": [
              "<any>"
            ],
            "team": {},
            "teamId": "<string>",
            "updatedAt": "<string>"
          }
        ],
        "campaigns": [
          {
            "analytics": [
              "<any>"
            ],
            "batchDelay": -9223372036854776000,
            "batchSize": 123,
            "createdAt": "<string>",
            "cronExpression": "<string>",
            "description": "<string>",
            "id": "<string>",
            "isDeleted": true,
            "list": {
              "contactImports": "<any>",
              "contacts": "<any>",
              "createdAt": "<any>",
              "description": "<any>",
              "id": "<any>",
              "isDeleted": "<any>",
              "name": "<any>",
              "team": "<any>",
              "teamId": "<any>",
              "updatedAt": "<any>"
            },
            "listId": "<string>",
            "name": "<string>",
            "processed": 123,
            "recurringSchedule": "DAILY",
            "schedule": "ONE_TIME",
            "scheduledFor": "<string>",
            "sentEmails": [
              "<any>"
            ],
            "smtpConfig": {
              "createdAt": "<any>",
              "fromEmail": "<any>",
              "host": "<any>",
              "id": "<any>",
              "isActive": "<any>",
              "isDefault": "<any>",
              "isDeleted": "<any>",
              "maxSendRate": "<any>",
              "password": "<any>",
              "port": "<any>",
              "provider": "<any>",
              "requiresAuth": "<any>",
              "supportsTls": "<any>",
              "teamId": "<any>",
              "updatedAt": "<any>",
              "username": "<any>"
            },
            "smtpConfigId": "<string>",
            "status": "DRAFT",
            "team": {},
            "teamId": "<string>",
            "template": {
              "category": "<any>",
              "categoryId": "<any>",
              "createdAt": "<any>",
              "designJson": "<any>",
              "emails": "<any>",
              "htmlFile": "<any>",
              "htmlFileId": "<any>",
              "id": "<any>",
              "isDeleted": "<any>",
              "name": "<any>",
              "subject": "<any>",
              "team": "<any>",
              "teamId": "<any>",
              "updatedAt": "<any>",
              "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": "<any>",
            "description": "<any>",
            "emails": "<any>",
            "id": "<any>",
            "isDeleted": "<any>",
            "name": "<any>",
            "team": "<any>",
            "teamId": "<any>",
            "templates": "<any>",
            "updatedAt": "<any>"
          }
        ],
        "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": "<any>",
            "description": "<any>",
            "id": "<any>",
            "isDeleted": "<any>",
            "name": "<any>",
            "team": "<any>",
            "teamId": "<any>",
            "updatedAt": "<any>"
          }
        ],
        "models": [
          {
            "createdAt": "<string>",
            "description": "<string>",
            "id": "<string>",
            "isDeleted": true,
            "name": "<string>",
            "provider": "<string>",
            "team": {},
            "teamId": "<string>",
            "updatedAt": "<string>"
          }
        ],
        "name": "<string>",
        "settings": [
          {
            "branding": {
              "createdAt": "<any>",
              "dashboardName": "<any>",
              "id": "<any>",
              "isDeleted": "<any>",
              "logoUrl": "<any>",
              "updatedAt": "<any>"
            },
            "brandingSettingsId": "<string>",
            "createdAt": "<string>",
            "id": "<string>",
            "inviteTemplateId": "<string>",
            "isDeleted": true,
            "teamId": "<string>",
            "updatedAt": "<string>",
            "welcomeTemplateId": "<string>"
          }
        ],
        "smtpConfigs": [
          {
            "createdAt": "<any>",
            "fromEmail": "<any>",
            "host": "<any>",
            "id": "<any>",
            "isActive": "<any>",
            "isDefault": "<any>",
            "isDeleted": "<any>",
            "maxSendRate": "<any>",
            "password": "<any>",
            "port": "<any>",
            "provider": "<any>",
            "requiresAuth": "<any>",
            "supportsTls": "<any>",
            "teamId": "<any>",
            "updatedAt": "<any>",
            "username": "<any>"
          }
        ],
        "updatedAt": "<string>",
        "users": [
          {}
        ],
        "webhooks": [
          {
            "createdAt": "<string>",
            "deliveries": [
              "<any>"
            ],
            "events": [
              "<any>"
            ],
            "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": [
            "<any>"
          ],
          "team": {},
          "teamId": "<string>",
          "updatedAt": "<string>"
        }
      ],
      "automations": [
        {
          "createdAt": "<string>",
          "description": "<string>",
          "edges": [
            "<any>"
          ],
          "id": "<string>",
          "isActive": true,
          "isDeleted": true,
          "name": "<string>",
          "nodes": [
            "<any>"
          ],
          "team": {},
          "teamId": "<string>",
          "updatedAt": "<string>"
        }
      ],
      "campaigns": [
        {
          "analytics": [
            "<any>"
          ],
          "batchDelay": -9223372036854776000,
          "batchSize": 123,
          "createdAt": "<string>",
          "cronExpression": "<string>",
          "description": "<string>",
          "id": "<string>",
          "isDeleted": true,
          "list": {
            "contactImports": "<any>",
            "contacts": "<any>",
            "createdAt": "<any>",
            "description": "<any>",
            "id": "<any>",
            "isDeleted": "<any>",
            "name": "<any>",
            "team": "<any>",
            "teamId": "<any>",
            "updatedAt": "<any>"
          },
          "listId": "<string>",
          "name": "<string>",
          "processed": 123,
          "recurringSchedule": "DAILY",
          "schedule": "ONE_TIME",
          "scheduledFor": "<string>",
          "sentEmails": [
            "<any>"
          ],
          "smtpConfig": {
            "createdAt": "<any>",
            "fromEmail": "<any>",
            "host": "<any>",
            "id": "<any>",
            "isActive": "<any>",
            "isDefault": "<any>",
            "isDeleted": "<any>",
            "maxSendRate": "<any>",
            "password": "<any>",
            "port": "<any>",
            "provider": "<any>",
            "requiresAuth": "<any>",
            "supportsTls": "<any>",
            "teamId": "<any>",
            "updatedAt": "<any>",
            "username": "<any>"
          },
          "smtpConfigId": "<string>",
          "status": "DRAFT",
          "team": {},
          "teamId": "<string>",
          "template": {
            "category": "<any>",
            "categoryId": "<any>",
            "createdAt": "<any>",
            "designJson": "<any>",
            "emails": "<any>",
            "htmlFile": "<any>",
            "htmlFileId": "<any>",
            "id": "<any>",
            "isDeleted": "<any>",
            "name": "<any>",
            "subject": "<any>",
            "team": "<any>",
            "teamId": "<any>",
            "updatedAt": "<any>",
            "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": "<any>",
          "description": "<any>",
          "emails": "<any>",
          "id": "<any>",
          "isDeleted": "<any>",
          "name": "<any>",
          "team": "<any>",
          "teamId": "<any>",
          "templates": "<any>",
          "updatedAt": "<any>"
        }
      ],
      "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": "<any>",
          "description": "<any>",
          "id": "<any>",
          "isDeleted": "<any>",
          "name": "<any>",
          "team": "<any>",
          "teamId": "<any>",
          "updatedAt": "<any>"
        }
      ],
      "models": [
        {
          "createdAt": "<string>",
          "description": "<string>",
          "id": "<string>",
          "isDeleted": true,
          "name": "<string>",
          "provider": "<string>",
          "team": {},
          "teamId": "<string>",
          "updatedAt": "<string>"
        }
      ],
      "name": "<string>",
      "settings": [
        {
          "branding": {
            "createdAt": "<any>",
            "dashboardName": "<any>",
            "id": "<any>",
            "isDeleted": "<any>",
            "logoUrl": "<any>",
            "updatedAt": "<any>"
          },
          "brandingSettingsId": "<string>",
          "createdAt": "<string>",
          "id": "<string>",
          "inviteTemplateId": "<string>",
          "isDeleted": true,
          "teamId": "<string>",
          "updatedAt": "<string>",
          "welcomeTemplateId": "<string>"
        }
      ],
      "smtpConfigs": [
        {
          "createdAt": "<any>",
          "fromEmail": "<any>",
          "host": "<any>",
          "id": "<any>",
          "isActive": "<any>",
          "isDefault": "<any>",
          "isDeleted": "<any>",
          "maxSendRate": "<any>",
          "password": "<any>",
          "port": "<any>",
          "provider": "<any>",
          "requiresAuth": "<any>",
          "supportsTls": "<any>",
          "teamId": "<any>",
          "updatedAt": "<any>",
          "username": "<any>"
        }
      ],
      "updatedAt": "<string>",
      "users": [
        {}
      ],
      "webhooks": [
        {
          "createdAt": "<string>",
          "deliveries": [
            "<any>"
          ],
          "events": [
            "<any>"
          ],
          "id": "<string>",
          "isActive": true,
          "isDeleted": true,
          "name": "<string>",
          "secret": "<string>",
          "teamId": "<string>",
          "updatedAt": "<string>",
          "url": "<string>"
        }
      ]
    },
    "teamId": "<string>",
    "updatedAt": "<string>"
  }
]

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