GET /v1/me/employees
Provides summary information for all of a business's employees.
Servers
- https://connect.squareup.com
Query parameters
Name | Type | Required | Description |
---|---|---|---|
end_created_at |
String | No |
If filtering results by their created_at field, the end of the requested reporting period, in ISO 8601 format. |
external_id |
String | No |
If provided, the endpoint returns only employee entities with the specified external_id. |
order |
String | No |
The order in which employees are listed in the response, based on their created_at field. Default value: ASC |
end_updated_at |
String | No |
If filtering results by there updated_at field, the end of the requested reporting period, in ISO 8601 format. |
limit |
Integer | No |
The maximum integer number of employee entities to return in a single response. Default 100, maximum 200. |
begin_updated_at |
String | No |
If filtering results by their updated_at field, the beginning of the requested reporting period, in ISO 8601 format |
status |
String | No |
If provided, the endpoint returns only employee entities with the specified status (ACTIVE or INACTIVE). |
batch_token |
String | No |
A pagination cursor to retrieve the next set of results for your original query to the endpoint. |
begin_created_at |
String | No |
If filtering results by their created_at field, the beginning of the requested reporting period, in ISO 8601 format. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.