Search API documentation

Type to search the API docs.

Find Users and Resources by Name, Email or Role

Look up a person in your workspace by name, email or role, pick a Task Assignee, check invitations and see which Events they're involved in.

Example use case

Your HR system sends you “Smith, Jane”. You want her ExhibitDay user ID to assign her a Task, to check she hasn't already been invited, and to see which upcoming shows she's working on.

What you'll end up with

The person's id, their workspace role, and the Events they're involved in.

Before you start

Have a workspace API key and the person's name or email address.

Good to know

The lists include the active users and Resources from Users & Permissions. A Resource is a non-user, such as a speaker, a contractor or temporary booth staff, added on the website with Add a Resource (non-user). Resources can't sign in.

At a glance

Time to try

About 10 minutes

Effect on your data

Read-only

Endpoints

4

The requests only read people, open invitations and Event involvements. They change nothing and send no email.

How it works

  1. Search Users & Permissions by name, email or role, and keep the person's id.
  2. Use the users and Resources list to pick someone who can be assigned Tasks.
  3. Check open invitations by email, then list the Events the person is involved in.

How search matching works

  • Searches ignore letter case, accents and spaces before or after your text. Zoe, Zoë and ZOE find the same person.
  • %, _ and [ match themselves. Search for them like any other character.
  • A blank name or email search is ignored, so it doesn't narrow the list.
  • The name search looks for every word you send in the first or last name, in any order. Jane Smith, Smith Jane and Smith, Jane find the same person, whichever name format your workspace uses.
  • The name search doesn't look at email addresses. Use the email filter for those.
  • The email filter matches the whole address.

Step 1: Search by name

Find users and Resources whose first or last name contains every word you send. The results are sorted by display name.

curl -X GET "https://api.exhibitday.com/v1/workspace_settings/users?filter_by_name_contains_text=Jane%20Smith&%24result_sort=display_name_asc&%24limit=50&%24offset=0" -H "Authorization: Bearer YOUR_API_KEY"

Example response (shortened)

{
  "records_found": 2,
  "total_records": 2,
  "has_more": false,
  "list_data": [
    {
      "id": "11111111-2222-4333-8444-555555555555",
      "is_resource": false,
      "first_name": "Illustrative",
      "last_name": "Member",
      "display_name": "Illustrative Member",
      "workspace_role_id": 1,
      "workspace_role": "Admin"
    },
    {
      "id": "66666666-7777-4888-8999-000000000000",
      "is_resource": true,
      "first_name": "Illustrative Resource",
      "last_name": "",
      "display_name": "Illustrative Resource",
      "workspace_role_id": 4,
      "workspace_role": "Resource"
    }
  ]
}

Check: display_name follows your workspace's User Name Display Format Preference, First Last or Last, First. If more than one person matches, compare their email addresses before you keep the id. Treat the id as text.

Step 2: Search by email

Find the person with one whole email address. For a Resource, this is the contact email recorded for them.

curl -X GET "https://api.exhibitday.com/v1/workspace_settings/users?filter_by_email=jane.smith%40example.com&%24limit=50&%24offset=0" -H "Authorization: Bearer YOUR_API_KEY"

Check: jane.smith@example doesn't match jane.smith@example.com, so send the whole address. No match returns an empty list.

Step 3: List everyone with one role

Send filter_by_workspace_role_id: 1 Admin, 2 Team Member, 3 Guest or 4 Resource. This lists every Guest, sorted by display name.

curl -X GET "https://api.exhibitday.com/v1/workspace_settings/users?filter_by_workspace_role_id=3&%24result_sort=display_name_asc&%24limit=50&%24offset=0" -H "Authorization: Bearer YOUR_API_KEY"

Other filters you can add:

To findSend
Only Resources, or only users who can sign infilter_by_is_resource=true, or false
People you already have IDs forfilter_by_user_ids with one ID or an array of IDs
Each user's permissions and content restrictionshydrate_permissions=true
A different order$result_sort: display_name_asc, display_name_desc, id_asc (the default) or id_desc

Check: Filters work together, so a role and a name word find people who match both. While has_more is true, ask for the next page with the same filters and sort, and add 50 to $offset.

Step 4: Pick someone who can be assigned Tasks

Search the users and Resources list by name and keep only people who can be assigned Tasks. This list returns every match at once, without pages.

curl -X GET "https://api.exhibitday.com/v1/references/users_and_resources?filter_by_name_contains_text=smith&filter_by_can_have_tasks_assigned=true" -H "Authorization: Bearer YOUR_API_KEY"

Check: Tasks can't be assigned to Resources, so filter_by_can_have_tasks_assigned=true leaves them out, along with users who can't be assigned Tasks. Use the id as a Task's Assignee, or in the Tasks list's filter_by_assignee_user_id.

Step 5: Check open invitations

Before you invite someone, check whether they already have an open invitation.

curl -X GET "https://api.exhibitday.com/v1/workspace_settings/users/invitations?filter_by_email=jane.smith%40example.com&%24limit=50&%24offset=0" -H "Authorization: Bearer YOUR_API_KEY"

Check: A status of pending means the invitation hasn't been accepted yet. accepted means the person accepted but hasn't joined the workspace yet. Add filter_by_status to see only one of them. Invitations already used to join aren't listed.

Step 6: See which Events someone is involved in

Use the person's id as user_id. This lists their upcoming Events, including Events in progress, for any kind of involvement.

curl -X GET "https://api.exhibitday.com/v1/workspace_settings/users/involvements?user_id=11111111-2222-4333-8444-555555555555&filter_by_event_date_category=upcoming&%24limit=50&%24offset=0" -H "Authorization: Bearer YOUR_API_KEY"

Check: Each Event appears once, with all of the person's involvements. To choose one kind, add filter_by_involvement: creator, attendee, travel_tag, playbook_tag, misc_expense_tag, task_assignee or task_contributor.

Try it

Before running the example

ValueWhat to put in it
YOUR_API_KEYYour workspace API key. Keep it out of shared code and logs.
filter_by_name_contains_textThe name of someone in your workspace. The example uses Jane Smith.
$limit and $offsetThe example reads up to 50 matches starting at offset 0.

Copy the complete example in your language and run it. To try another search, change the request to match one of the steps above.

Complete example program

Code Samples
curl -X GET "https://api.exhibitday.com/v1/workspace_settings/users?filter_by_name_contains_text=Jane%20Smith&%24result_sort=display_name_asc&%24limit=50&%24offset=0" -H "Authorization: Bearer YOUR_API_KEY"

Example response

{
  "records_found": 2,
  "total_records": 2,
  "has_more": false,
  "list_type": "workspace_member",
  "list_data": [
    {
      "id": "11111111-2222-4333-8444-555555555555",
      "is_resource": false,
      "first_name": "Illustrative",
      "last_name": "Member",
      "display_name": "Illustrative Member",
      "email": "member@example.invalid",
      "organization": null,
      "title": null,
      "phone_number": null,
      "profile_photo_url": "https://www.exhibitday.com/Images/Generic-User-Icon.png",
      "workspace_role_id": 1,
      "workspace_role": "Admin",
      "workspace_member_joined_timestamp": null,
      "permissions": null
    },
    {
      "id": "66666666-7777-4888-8999-000000000000",
      "is_resource": true,
      "first_name": "Illustrative Resource",
      "last_name": "",
      "display_name": "Illustrative Resource",
      "email": "resource@example.invalid",
      "organization": "Illustrative supplier",
      "title": "Display equipment",
      "phone_number": "+1 202-555-0146",
      "profile_photo_url": "https://www.exhibitday.com/Images/Associate-Profile-5.png",
      "workspace_role_id": 4,
      "workspace_role": "Resource",
      "workspace_member_joined_timestamp": "2026-01-02T13:00:00Z",
      "permissions": null
    }
  ]
}
Note: GET /v1/workspace_settings/users - HTTP 200. The users and Resources whose first or last names contain both Jane and Smith, sorted by display name. Keep the returned id to use in later requests.

The curl example uses Bash. Node.js needs version 18 or later (save as .mjs). Python uses Requests. C# needs a .NET 8 console project (Program.cs). Java needs Java 11 or later (ExhibitDayExample.java). PHP needs PHP with cURL. Ruby and Go use their standard libraries.

Things to keep in mind

  • Invitations and inactive or deactivated users aren't in the users list. Use the invitations list for people who haven't joined yet.
  • A person's name can change and two people can share a name. Save the id, not the name.
  • GET /v1/workspace_settings/users/info returns one person's full details, including Admin Notes.