GET
/
v1
/
users
curl --request GET \
  --url https://api.frigade.com/v1/users \
  --header 'Authorization: Bearer <token>'
{
  "userId": "d34daa11-3745-4ac0-880e-d4b4d51fe13f",
  "createdAt": "2024-01-01T00:00:00Z",
  "modifiedAt": "2024-01-01T00:00:00Z",
  "properties": {
    "email": "john@doe.com",
    "firstName": "John",
    "lastName": "Doe",
    "imageUrl": "https://example.com/john-doe.jpg"
  },
  "isGuest": true,
  "email": "john@doe.com",
  "firstName": "John",
  "lastName": "Doe",
  "trackingEvents": [
    {
      "event": "SignedUp",
      "properties": {
        "source": "landing-page",
        "campaign": "summer-sale"
      },
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ]
}

Authorizations

Authorization
string
headerrequired

Authentication header of the form Bearer: <token>, where <token> is your public or private Frigade API key

Query Parameters

foreignId
string
deprecated

Deprecated. Use userId instead

userId
string
required

The ID of the user

Response

200 - application/json
userId
string

The ID of the user as defined in your own application

createdAt
string

The date and time the user was created

modifiedAt
string

The date and time the user was last modified

properties
string

The properties of the user

isGuest
boolean

Whether the user is a guest

email
string

The email address of the user

firstName
string

The first name of the user

lastName
string

The last name of the user

trackingEvents
object[]

The tracking events associated with the user