Get Directory

Get Directory

Use this endpoint to retrieve a paginated list of all employees (individuals) for the employer. Copy one or more id values from the individuals array — these are the individual_id values needed by Individual and Employment.

GET organization/directory 

Header Parameters

Field	Type	Description
Authorization	string	Required. Bearer token obtained from the Auth endpoint. Format: Bearer <access_token>.
X-TaxBandits-Version	string	API version string. Use 1.0.0.

Query Parameters

Field	Type	Description
entity_ids	string	The organization ID. Must be exactly one UUID.
limit	number	Optional Maximum number of results to return. Default: all.
offset	number	Optional Number of records to skip, for pagination.

Response Body

Field	Type	Description
status	string	SUCCESS or FAILURE.
status_code	number	HTTP-style status code (e.g. 200, 400).
message	string	Human-readable status message.
response	object	Directory results.
paging	object	Pagination info.
count	number	Total number of records.
offset	number	Offset applied to this response.
individuals	object[]	List of employees.
id	string	The employee UUID (individual_id).
first_name	string	Employee first name.
middle_name	string	Employee middle name. null if not set.
last_name	string	Employee last name.
department	object	Department the employee belongs to.
name	string	Department name. null if not set.
is_active	boolean	true if the employee is active; false if terminated.

Payload

Request

GET organization/directory?entity_ids=519a84f4-...&limit=10&offset=0
Header: X-TaxBandits-Version: 1.0.0

Response Json

Sample	Description	Action
200	Success Response - This is a sample response for successful API requests.
400	Bad Request Response - You'll get the below response when entity_ids is missing or invalid.

{
  "status": "SUCCESS",
  "status_code": 200,
  "message": "Request processed successfully",
  "response": {
    "paging": {
      "count": 50,
      "offset": 0
    },
    "individuals": [
      {
        "id": "7a3f1c2d-11bb-4e6a-9c0d-f83a57e12346",
        "first_name": "John",
        "middle_name": null,
        "last_name": "Doe",
        "department": {
          "name": "Engineering"
        },
        "is_active": true
      }
    ]
  }
}