> For the complete documentation index, see [llms.txt](https://docs.tiny.plus/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.tiny.plus/api/endpoints.md).

# Endpoints

Every endpoint lives under `https://api.tiny.plus/v2` and answers in JSON. [Working with the API](/api/concepts.md) covers what they all have in common: authentication, requests and errors, lists and filters, your account's fields, permissions and fair use.

## Record types

Each record type has its own URL. Some URLs differ from the name the record type has in tiny+.

| Record type                               | URL              | Page                                           |
| ----------------------------------------- | ---------------- | ---------------------------------------------- |
| Projects                                  | `/v2/projects`   | [Projects](/api/endpoints/projects.md)         |
| Project stages (accounts that use stages) | `/v2/stages`     | [Projects](/api/endpoints/projects.md#stages)  |
| Companies                                 | `/v2/companies`  | [Companies](/api/endpoints/companies.md)       |
| Contacts                                  | `/v2/contacts`   | [Contacts](/api/endpoints/contacts.md)         |
| Enquiries                                 | `/v2/enquiries`  | [Enquiries](/api/endpoints/enquiries.md)       |
| Tasks                                     | `/v2/activities` | [Tasks](/api/endpoints/tasks.md)               |
| Meetings                                  | `/v2/meetings`   | [Meetings](/api/endpoints/meetings.md)         |
| Events                                    | `/v2/events`     | [Events](/api/endpoints/events.md)             |
| Emails                                    | `/v2/emails`     | [Emails](/api/endpoints/emails.md)             |
| Team members                              | `/v2/staff`      | [Team Members](/api/endpoints/team-members.md) |
| Posts                                     | `/v2/updates`    | [Posts](/api/endpoints/updates.md)             |

Every record type supports the same operations, described on the [Records](/api/endpoints/records.md) page. Posts are the exception: `GET /v2/updates` works differently, as described on the [Posts](/api/endpoints/updates.md) page.

| Operation                     | Request                            |
| ----------------------------- | ---------------------------------- |
| List records                  | `GET /v2/{type}`                   |
| Get one record                | `GET /v2/{type}/{id}`              |
| Get a record's change history | `GET /v2/{type}/{id}/history`      |
| Create a record               | `POST /v2/{type}`                  |
| Update a record               | `PATCH /v2/{type}/{id}` (or `PUT`) |
| Delete a record               | `DELETE /v2/{type}/{id}`           |
| Search                        | `GET /v2/search/{type}?q={words}`  |

## Other endpoints

| Request                                                                                                      | What it's for                                                                    | Page                                                                  |
| ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------- | --------------------------------------------------------------------- |
| `GET https://api.tiny.plus/me`                                                                               | The person a token belongs to, their account, and what they may see.             | [Current user](/api/endpoints/me.md)                                  |
| `GET /v2/fields/{type}`, `/v2/form_structure/{type}`, `/v2/record_status/{type}`, `/v2/status_schema/{type}` | Your account's fields, forms, custom fields, tags, statuses and phases.          | [Account structure](/api/endpoints/account-structure.md)              |
| `GET /v2/staff_list`                                                                                         | A short list of every team member.                                               | [Account structure](/api/endpoints/account-structure.md#team-members) |
| `GET /v2/stats/projects`                                                                                     | Pipeline totals by status and phase.                                             | [Pipeline statistics](/api/endpoints/stats.md)                        |
| `GET`, `POST` and `PATCH /v2/relationship_plans`, `GET /v2/relationship_plan_templates`                      | List, start, log and change relationship plans.                                  | [Relationship plans](/api/endpoints/relationship-plans.md)            |
| `GET`, `POST`, `PATCH` and `DELETE /v2/lists`                                                                | Read lists of companies, contacts and projects, and change what's on them.       | [Lists](/api/endpoints/lists.md)                                      |
| `GET`, `POST`, `PATCH` and `DELETE /v2/bid_teams`                                                            | Read and change the competing teams a project is bid through, and a lead firm's. | [Bid teams](/api/endpoints/bid-teams.md)                              |
| `POST /v2/ai/filter`                                                                                         | Turn a plain-English question into list filters.                                 | [Ask filters](/api/endpoints/ai-filter.md)                            |
| `POST /v2/comments`                                                                                          | Comment on a post.                                                               | [Posts](/api/endpoints/updates.md#comments)                           |
| `POST /v2/attachments`                                                                                       | Attach an image or document to a record.                                         | [Attachments](/api/endpoints/attachments.md)                          |
| `GET /v2/buttons`, `POST /v2/webhooks/add`                                                                   | Send a record to your URL when someone presses a button.                         | [Webhooks](/api/endpoints/webhooks.md)                                |
| `POST /v2/actions` with `do=join_team` or `do=leave_team`                                                    | Join or leave a record's team.                                                   | [Linking records](/api/concepts/linking.md)                           |