Skip to main content
GET
/
v1
/
users
cURL
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": "[email protected]",
    "firstName": "John",
    "lastName": "Doe",
    "imageUrl": "https://example.com/john-doe.jpg"
  },
  "isGuest": false,
  "email": "[email protected]",
  "firstName": "John",
  "lastName": "Doe",
  "userFlowStates": [
    {
      "flowSlug": "flow_abc",
      "flowState": "COMPLETED_FLOW",
      "flowResponses": [
        {
          "flowSlug": "flow_abc",
          "actionType": "STARTED_STEP",
          "stepId": "step-1",
          "data": "{\"key\": \"value\"}",
          "createdAt": "2024-01-01T00:00:00Z"
        }
      ]
    }
  ],
  "trackingEvents": [
    {
      "event": "SignedUp",
      "properties": {
        "source": "landing-page",
        "campaign": "summer-sale"
      },
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Authentication header of the form Bearer: <token>, where <token> is either your public or private API key. See when to use which

Query Parameters

​
foreignId
string
required
​
userId
string
required

The ID of the user

Response

The user was successfully found

​
userId
string

The ID of the user as defined in your own application

Example:

"d34daa11-3745-4ac0-880e-d4b4d51fe13f"

​
createdAt
string<date-time>

The date and time the user was created

Example:

"2024-01-01T00:00:00Z"

​
modifiedAt
string<date-time>

The date and time the user was last modified

Example:

"2024-01-01T00:00:00Z"

​
properties
string

The properties of the user

Example:
{
  "email": "[email protected]",
  "firstName": "John",
  "lastName": "Doe",
  "imageUrl": "https://example.com/john-doe.jpg"
}
​
isGuest
boolean

Whether the user is a guest

Example:

false

​
email
string

The email address of the user

Example:

"[email protected]"

​
firstName
string

The first name of the user

Example:

"John"

​
lastName
string

The last name of the user

Example:

"Doe"

​
userFlowStates
object[]

The user's state in the Flows they have interacted with

​
trackingEvents
object[]

The tracking events associated with the user

Example:
[
  {
    "event": "SignedUp",
    "properties": {
      "source": "landing-page",
      "campaign": "summer-sale"
    },
    "createdAt": "2024-01-01T00:00:00Z"
  }
]