FRfrigadehq
users

GET /v1/users

Find a user by ID

Request

  • The document declares no server URL.
  • Auth
    HTTP bearer

Query parameters

foreignIdstring required
userIdstring required

The ID of the user

Response

The user was successfully found

userIdstring

The ID of the user as defined in your own application

createdAtstring date-time

The date and time the user was created

modifiedAtstring date-time

The date and time the user was last modified

propertiesstring

The properties of the user

isGuestboolean

Whether the user is a guest

emailstring

The email address of the user

firstNamestring

The first name of the user

lastNamestring

The last name of the user

Example response

{
  "userId": "d34daa11-3745-4ac0-880e-d4b4d51fe13f",
  "createdAt": "2024-01-01T00:00:00Z",
  "modifiedAt": "2024-01-01T00:00:00Z",
  "email": "john@doe.com",
  "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"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.