Skip to main content
GET
/
team_members
List all team members
curl --request GET \
  --url https://{your-subdomain}.neetodesk.com/api/external/v1/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,
      "organization_role": "Admin",
      "active": true
    }
  ],
  "pagination": {
    "total_records": 95,
    "total_pages": 4,
    "current_page_number": 1,
    "page_size": 30
  }
}
Deprecated: This is a v1 endpoint. It will continue to work, but we recommend migrating to the v2 equivalent for improved REST compliance (correct HTTP status codes, consistent response envelopes, and hyphenated URLs).
Replace {your-subdomain} with your workspace’s subdomain.
Learn how to find your subdomain in Identifying subdomain.

Headers

X-Api-Key
string
default:your-api-key
required

X-Api-Key is used to authenticate requests using an API key. Provide your API key in this header to access protected endpoints. Refer to Authentication for more information.

Accept
enum<string>
default:application/json
required

Specifies the expected response format. Must be set to application/json for proper API communication.

Available options:
application/json

Query Parameters

page
integer

Retrieve paginated results by specifying the desired page number. Defaults to 1 if not specified.

page_size
integer

Set the number of results returned in the response. Defaulting to 30 when omitted.

email
string<email>

Filter team members by email address. The search is case-insensitive.

Response

200 - application/json

OK - Request succeeded

team_members
object[]
pagination
object