The Employee Group object

Attributes

id string

Unique identifier for the object.

created_at string

ISO 8601 timestamp of when the object was created.

updated_at string

ISO 8601 timestamp of when the object was last updated.

employee_group_name string required
The Employee Group object 
{
  "id": "employee-group_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "employee_group_name": "employee_group_name_example"
}
GET /api/setup/employee-group/{id}

Retrieve a employee group

Retrieves the details of an existing employee group. Supply the unique employee group ID that was returned from a previous request.

Path parameters

id string required

The identifier of the employee group to retrieve.

Returns

Returns the employee group object if a valid identifier was provided.

GET /api/setup/employee-group/{id} 
curl https://api.overplane.dev/api/setup/employee-group/employee-group_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "employee-group_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "employee_group_name": "employee_group_name_example"
}
GET /api/setup/employee-group

List all employee groups

Returns a list of employee groups. The results are sorted by creation date, with the most recently created appearing first.

Query parameters

limit integer

Maximum number of objects to return. Default: 20.

offset integer

Number of objects to skip for pagination. Default: 0.

Returns

A paginated list of employee group objects.

GET /api/setup/employee-group 
curl https://api.overplane.dev/api/setup/employee-group \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "employee-group_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "employee_group_name": "employee_group_name_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/setup/employee-group

Create a employee group

Creates a new employee group object.

Body parameters

employee_group_name string required

Returns

Returns the newly created employee group object if the call succeeded.

POST /api/setup/employee-group 
curl https://api.overplane.dev/api/setup/employee-group \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"employee_group_name":"employee_group_name_example"}'
Response 
{
  "id": "employee-group_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "employee_group_name": "employee_group_name_example"
}
PATCH /api/setup/employee-group/{id}

Update a employee group

Updates the specified employee group by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Path parameters

id string required

The identifier of the employee group to update.

Body parameters

employee_group_name string

Returns

Returns the updated employee group object.

PATCH /api/setup/employee-group/{id} 
curl https://api.overplane.dev/api/setup/employee-group/employee-group_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"employee_group_name":"employee_group_name_example"}'
Response 
{
  "id": "employee-group_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "employee_group_name": "employee_group_name_example"
}
DELETE /api/setup/employee-group/{id}

Delete a employee group

Permanently deletes a employee group. This cannot be undone.

Path parameters

id string required

The identifier of the employee group to delete.

Returns

Returns a confirmation that the employee group has been deleted.

DELETE /api/setup/employee-group/{id} 
curl https://api.overplane.dev/api/setup/employee-group/employee-group_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "employee-group_abc123",
  "deleted": true
}

Line items

Child objects that belong to this employee group. These are accessed via the parent's ID.

Employee Group Table

Attributes

idx integer
employee_group_id string required
employee string
employee_name string
user_id string

Endpoints

GET /api/setup/employee-group-table?parent_id={id}
POST /api/setup/employee-group-table
PATCH /api/setup/employee-group-table/{id}
DELETE /api/setup/employee-group-table/{id}
POST /api/setup/employee-group-table/reorder
Employee Group Table object 
{
  "id": "employee-group-table_abc123",
  "idx": 1,
  "employee_group_id": "employee_group_id_example",
  "employee": "employee_example",
  "employee_name": "employee_name_example",
  "user_id": "user_id_example"
}