# MakeLeaps API Documentation - Organization Section

## Navigation
- [Back to index](/api/llms.txt)
- [Current section](/api/llms/organization.md)

## Topics in this Section
- Your Company
- Employees
- Groups




## Your Company


### Endpoints

- `/api/partner/`
  - Name: Partner List
  - Methods: GET, OPTIONS

- `/api/partner/<partner_mid>/`
  - Name: Partner Instance
  - Methods: GET, OPTIONS



Your Company
------------
Your company is represented by a `Partner` object. This object also contains the
endpoints for the resources of this company.

If you've been invited to work in several companies, your user account may
be associated with multiple partners. However, the API keys may only be
associated with and access one `Partner` at a time.

Because API keys are currently restricted to a single company, the simplest way to get
started is to query the Partner List and find your company there.

### Fields

- **`url`** `Read-Only`
  - **Type**: `URL`

- **`name`** `Read-Only`
  - **Type**: `String`
  - **Description**: Name

- **`clients`** `Read-Only`
  - **Type**: `String`
  - **Description**: Clients

- **`contacts`** `Read-Only`
  - **Type**: `String`
  - **Description**: Contacts

- **`documents`** `Read-Only`
  - **Type**: `String`
  - **Description**: Documents

- **`line_item_catalog`** `Read-Only`
  - **Type**: `String`
  - **Description**: Line Item Catalog

- **`tags`** `Read-Only`
  - **Type**: `String`
  - **Description**: Tags

- **`sending_orders`** `Read-Only`
  - **Type**: `String`
  - **Description**: Sending Orders

- **`history`** `Read-Only`
  - **Type**: `String`
  - **Description**: History

- **`integrations`** `Read-Only`
  - **Type**: `JSON Object`
  - **Description**: Relationship with external systems

- **`account_name`** `Read-Only`
  - **Type**: `String`
  - **Description**: Account Name

- **`tax_registration_number`** `Read-Only`
  - **Type**: `String`
  - **Description**: Tax Registration Number






## Employees


### Endpoints

- `/api/partner/<partner_mid>/employee/`
  - Name: Employee List
  - Methods: GET, OPTIONS

- `/api/partner/<partner_mid>/employee/<mid>/`
  - Name: Employee Instance
  - Methods: GET, OPTIONS

- `/api/partner/<partner_mid>/employee/me/`
  - Name: Authenticated Employee Instance
  - Methods: GET, OPTIONS



Employees represent the team members of your company.


### Fields

- **`url`** `Read-Only`
  - **Type**: `URL`

- **`mid`** `Read-Only`
  - **Type**: `MakeLeaps ID`
  - **Description**: MakeLeaps ID

- **`name`** `Read-Only`
  - **Type**: `String`
  - **Description**: Name

- **`email`** `Read-Only`
  - **Type**: `String`
  - **Description**: Email

- **`start_date`** `Read-Only`
  - **Type**: `Timestamp`
  - **Description**: Start Date

- **`end_date`** `Read-Only`
  - **Type**: `Timestamp`
  - **Description**: End Date

- **`integrations`** `Read-Only`
  - **Type**: `JSON Object`
  - **Description**: Relationship with external systems

- **`has_seat`** `Read-Only`
  - **Type**: `Boolean`
  - **Description**: Licensed

- **`is_owner`** `Read-Only`
  - **Type**: `Boolean`
  - **Description**: Owner

- **`is_admin`** `Read-Only`
  - **Type**: `Boolean`
  - **Description**: Administrator


### Extra Filters

- **`search`**
  - **Type**: `String`
  - **Description**: Full text search





## Groups


### Endpoints

- `/api/partner/<partner_mid>/group/`
  - Name: Group List
  - Methods: GET, POST, OPTIONS

- `/api/partner/<partner_mid>/group/<mid>/`
  - Name: Group Instance
  - Methods: GET, PUT, PATCH, DELETE, OPTIONS

- `/api/partner/<partner_mid>/group/<mid>/employee/<employee_mid>/`
  - Name: (No Name)
  - Methods: options, delete

- `/api/partner/<partner_mid>/group/<mid>/client/<client_mid>/`
  - Name: (No Name)
  - Methods: options, delete



Groups
------------------------

Groups are used to control access to Clients and their Documents. If a Client belongs to a given Group, then only Admins and Employees that belong to that Group can see the Client and its data.

A single Employee or a single Client can belong to multiple Groups.

Checking Group Employees and Clients
------------------------

A large number of Employees and Clients can belong to a single group. Use the Group's paginated `employees_url` or `clients_url` to see the Group's Employees or Clients.

Checking if a specific Employee or Client is in a Group can be done via `Employee` or `Client` endpoints.

Creating a Group
------------------------

When you make a Group, only the name can be specified. A Group's Employees or Clients can be managed after Group creation.

    POST /api/partner/<partner_mid>/group/

Sample data:

    {
        "name": "My Group",
    }

Managing a Group's Employees and Clients
---------------------------------------

As described below, only 1 Employee or 1 Client can be added/removed per request.

### Adding an Employee

    POST <employees_url>

Sample data:

    {
        "employee": "<employee_url>"
    }

### Removing an Employee

    DELETE /api/partner/<partner_mid>/group/<mid>/employee/<employee_mid>/

### Adding a Client

    POST <clients_url>

Sample data:

    {
        "client": "<client_url>"
    }

### Removing a Client

    DELETE /api/partner/<partner_mid>/group/<mid>/client/<client_mid>/



### Fields

- **`url`** `Read-Only`
  - **Type**: `URL`

- **`mid`** `Read-Only`
  - **Type**: `MakeLeaps ID`
  - **Description**: MakeLeaps ID

- **`name`** `Required`
  - **Type**: `String`
  - **Description**: Group Name

- **`employees_url`** `Read-Only`
  - **Type**: `URL`
  - **Description**: Group's Employee List URL

- **`clients_url`** `Read-Only`
  - **Type**: `URL`
  - **Description**: Group's Client List URL

- **`employee_count`** `Read-Only`
  - **Type**: `Integer`
  - **Description**: Number of Employees

- **`client_count`** `Read-Only`
  - **Type**: `Integer`
  - **Description**: Number of Clients