The Sales Person 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.

parent_id string
is_group boolean

Default: false

sales_person_name string required
parent_sales_person string
commission_rate string
enabled boolean

Default: true

employee string
department string
The Sales Person object 
{
  "id": "sales-person_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "parent_id": null,
  "is_group": false,
  "sales_person_name": "sales_person_name_example",
  "parent_sales_person": "parent_sales_person_example",
  "commission_rate": "commission_rate_example",
  "enabled": true,
  "employee": "employee_example",
  "department": "department_example"
}
GET /api/setup/sales-person/{id}

Retrieve a sales person

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

Path parameters

id string required

The identifier of the sales person to retrieve.

Returns

Returns the sales person object if a valid identifier was provided.

GET /api/setup/sales-person/{id} 
curl https://api.overplane.dev/api/setup/sales-person/sales-person_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "sales-person_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "parent_id": null,
  "is_group": false,
  "sales_person_name": "sales_person_name_example",
  "parent_sales_person": "parent_sales_person_example",
  "commission_rate": "commission_rate_example",
  "enabled": true,
  "employee": "employee_example",
  "department": "department_example"
}
GET /api/setup/sales-person

List all sales persons

Returns a list of sales persons. 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 sales person objects.

GET /api/setup/sales-person 
curl https://api.overplane.dev/api/setup/sales-person \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "sales-person_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "parent_id": null,
      "is_group": false,
      "sales_person_name": "sales_person_name_example",
      "parent_sales_person": "parent_sales_person_example",
      "commission_rate": "commission_rate_example",
      "enabled": true,
      "employee": "employee_example",
      "department": "department_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/setup/sales-person

Create a sales person

Creates a new sales person object.

Body parameters

parent_id string
is_group boolean

Default: false

sales_person_name string required
parent_sales_person string
commission_rate string
enabled boolean

Default: true

employee string
department string

Returns

Returns the newly created sales person object if the call succeeded.

POST /api/setup/sales-person 
curl https://api.overplane.dev/api/setup/sales-person \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"sales_person_name":"sales_person_name_example"}'
Response 
{
  "id": "sales-person_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "parent_id": null,
  "is_group": false,
  "sales_person_name": "sales_person_name_example",
  "parent_sales_person": "parent_sales_person_example",
  "commission_rate": "commission_rate_example",
  "enabled": true,
  "employee": "employee_example",
  "department": "department_example"
}
PATCH /api/setup/sales-person/{id}

Update a sales person

Updates the specified sales person 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 sales person to update.

Body parameters

parent_id string
is_group boolean

Default: false

sales_person_name string
parent_sales_person string
commission_rate string
enabled boolean

Default: true

employee string
department string

Returns

Returns the updated sales person object.

PATCH /api/setup/sales-person/{id} 
curl https://api.overplane.dev/api/setup/sales-person/sales-person_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"parent_id":null,"is_group":false}'
Response 
{
  "id": "sales-person_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "parent_id": null,
  "is_group": false,
  "sales_person_name": "sales_person_name_example",
  "parent_sales_person": "parent_sales_person_example",
  "commission_rate": "commission_rate_example",
  "enabled": true,
  "employee": "employee_example",
  "department": "department_example"
}
DELETE /api/setup/sales-person/{id}

Delete a sales person

Permanently deletes a sales person. This cannot be undone.

Path parameters

id string required

The identifier of the sales person to delete.

Returns

Returns a confirmation that the sales person has been deleted.

DELETE /api/setup/sales-person/{id} 
curl https://api.overplane.dev/api/setup/sales-person/sales-person_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "sales-person_abc123",
  "deleted": true
}
GET /api/setup/sales-person/{id}/children

Get children

Returns the direct children of the specified node in the tree.

Path parameters

id string required

The identifier of the sales person to act on.

Returns

A list of direct child objects.

GET /api/setup/sales-person/{id}/children 
curl https://api.overplane.dev/api/setup/sales-person/sales-person_abc123/children \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "sales-person_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "parent_id": null,
  "is_group": false,
  "sales_person_name": "sales_person_name_example",
  "parent_sales_person": "parent_sales_person_example",
  "commission_rate": "commission_rate_example",
  "enabled": true,
  "employee": "employee_example",
  "department": "department_example"
}
GET /api/setup/sales-person/{id}/ancestors

Get ancestors

Returns all ancestors from the immediate parent up to the root of the tree.

Path parameters

id string required

The identifier of the sales person to act on.

Returns

A list of ancestor objects from parent to root.

GET /api/setup/sales-person/{id}/ancestors 
curl https://api.overplane.dev/api/setup/sales-person/sales-person_abc123/ancestors \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "sales-person_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "parent_id": null,
  "is_group": false,
  "sales_person_name": "sales_person_name_example",
  "parent_sales_person": "parent_sales_person_example",
  "commission_rate": "commission_rate_example",
  "enabled": true,
  "employee": "employee_example",
  "department": "department_example"
}
GET /api/setup/sales-person/{id}/descendants

Get descendants

Returns all descendants of the specified node in the tree.

Path parameters

id string required

The identifier of the sales person to act on.

Returns

A list of all descendant objects.

GET /api/setup/sales-person/{id}/descendants 
curl https://api.overplane.dev/api/setup/sales-person/sales-person_abc123/descendants \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "sales-person_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "parent_id": null,
  "is_group": false,
  "sales_person_name": "sales_person_name_example",
  "parent_sales_person": "parent_sales_person_example",
  "commission_rate": "commission_rate_example",
  "enabled": true,
  "employee": "employee_example",
  "department": "department_example"
}