Users

Make a GET request to /users to retrieve a list of the users in your account. Use this route if you need to find a user's email address in order to create an invitation on their behalf. You must include the email address of one of these users when creating invitations.

Each user includes inviter defaults used by Create Invitation when override fields are not provided.

GET /users

{
    "mode": "live",
    "object": "list",
    "total_count": 3,
    "has_more": false,
    "data": [
        {
            "object": "user_list_item",
            "id": 33123,
            "first_name": "Joe",
            "last_name": "Coach",
            "email": "joe.coach@jofiscore.com",
            "phone": null,
            "created_at": "2026-01-25T05:47:46.598246+00:00",
            "invitations_count": 45,
            "default_team": {
                "id": 178,
                "display_name": "Career Coaching"
            },
            "default_assessments": [
                {
                    "id": 6,
                    "display_name": "JOFI Personality Traits",
                    "short_name": "Personality"
                },
                {
                    "id": 8,
                    "display_name": "JOFI Career Interests",
                    "short_name": "Interests"
                }
            ],
            "default_invitation_email_template": {
                "id": 1000,
                "display_name": "Career Coaching Invitation"
            },
            "default_congrats_email_template": {
                "id": 1001,
                "display_name": "Standard Congrats"
            }
        },
        {
            "object": "user_list_item",
            "id": 33456,
            "first_name": "Jane",
            "last_name": "Recruiter",
            "email": "jane.recruiter@jofiscore.com",
            "phone": "+15551234567",
            "created_at": "2026-01-25T05:43:02.250257+00:00",
            "invitations_count": 106,
            "default_team": {
                "id": 328,
                "display_name": "Recruiting"
            },
            "default_assessments": [
                {
                    "id": 6,
                    "display_name": "JOFI Personality Traits",
                    "short_name": "Personality"
                }
            ],
            "default_invitation_email_template": {
                "id": 1002,
                "display_name": "Recruiting Invitation"
            },
            "default_congrats_email_template": null
        },
        {
            "object": "user_list_item",
            "id": 44123,
            "first_name": "Laura",
            "last_name": "Supervisor",
            "email": "laura.supervisor@jofiscore.com",
            "phone": null,
            "created_at": "2026-01-26T16:09:00.227197+00:00",
            "invitations_count": 0,
            "default_team": null,
            "default_assessments": [],
            "default_invitation_email_template": null,
            "default_congrats_email_template": null
        }
    ]
}

Response fields

List envelope

Field	Description
mode	"live" or "test" depending on your API key
object	Always "list"
total_count	Total number of users in your account
has_more	true if more items exist beyond the current page
data	Array of user_list_item objects

user_list_item fields

Field	Description
object	Always "user_list_item"
id	User ID
first_name	User first name
last_name	User last name
email	User email address
phone	User phone number in E.164 format, or null
created_at	ISO 8601 timestamp when the user was created
invitations_count	Number of invitations sent by this user
default_team	Default team for invitations sent by this user ({ id, display_name }), or null if unset
default_assessments	Default assessments assigned on invitations sent by this user (array of { id, display_name, short_name })
default_invitation_email_template	Default invitation email template ({ id, display_name }), or null if unset
default_congrats_email_template	Default congrats email template ({ id, display_name }), or null if unset. Used when send_congrats_notification is enabled on invitations.

Use GET /email-templates to look up valid email template IDs for your account.