GET
/
v1
/
users

The users GET endpoint is used to fetch user metadata and properties sent to Frigade. As this endpoint returns PII, you will need to use the private API key.

Only call this endpoint from your backend code.

​
Getting a user by foreignId

curl -i -X GET \
   -H "Authorization:Bearer api_private_t3YtBqLJuOeFzIElTYBARERMQljitCgy7mhusWthcEHKCMpEU4LrQmuhd4RRAawi" \
 'https://api.frigade.com/v1/users?foreignId=my-id'
{
  "name": "John Doe",
  "foreignId": "my-id",
  "createdAt": "2023-08-02T14:58:17.275Z",
  "modifiedAt": "2023-08-02T14:58:17.275Z",
  "slug": "user_vkBjCGzEjRT1INHq",
  "properties": {
    "company": "CoolCo"
  }
}
UsersUsers