Skip to main content
GET
/
team-members
List team members
curl --request GET \
  --url https://{your-subdomain}.neetorecord.com/api/external/v2/team-members \
  --header 'Accept: <accept>' \
  --header 'X-Api-Key: <x-api-key>'
{
  "team_members": [
    {
      "id": "aaaabbbb-cccc-dddd-eeee-ffff00001111",
      "email": "oliver@example.com",
      "first_name": "Oliver",
      "last_name": "Smith",
      "time_zone": "Asia/Kolkata",
      "profile_image_url": null,
      "active": true,
      "organization_role": "Admin"
    }
  ],
  "pagination": {
    "total_records": 95,
    "total_pages": 4,
    "current_page_number": 1,
    "page_size": 30
  }
}
Replace {your-subdomain} with your workspace’s subdomain.
Learn how to find your subdomain in Identifying subdomain.

Headers

X-Api-Key
string
required

API key. Refer to Authentication for more information.

Accept
enum<string>
default:application/json
required

Must be application/json.

Available options:
application/json

Query Parameters

email
string<email>

Filter team members by email address.

Example:

"oliver@example.com"

page_number
integer

Page number. If absent, all results are returned.

page_size
integer

Number of results per page. Defaults to 30.

Response

200 - application/json

OK - Request succeeded

team_members
object[]
pagination
object