> 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](https://docs.tiny.plus/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](https://docs.tiny.plus/api/endpoints/projects.md)                           |
| Project stages (accounts that use stages)              | `/v2/stages`                | [Projects](https://docs.tiny.plus/api/endpoints/projects.md#stages)                    |
| Companies                                              | `/v2/companies`             | [Companies](https://docs.tiny.plus/api/endpoints/companies.md)                         |
| Contacts                                               | `/v2/contacts`              | [Contacts](https://docs.tiny.plus/api/endpoints/contacts.md)                           |
| Enquiries                                              | `/v2/enquiries`             | [Enquiries](https://docs.tiny.plus/api/endpoints/enquiries.md)                         |
| Tasks                                                  | `/v2/activities`            | [Tasks](https://docs.tiny.plus/api/endpoints/tasks.md)                                 |
| Meetings                                               | `/v2/meetings`              | [Meetings](https://docs.tiny.plus/api/endpoints/meetings.md)                           |
| Events                                                 | `/v2/events`                | [Events](https://docs.tiny.plus/api/endpoints/events.md)                               |
| Emails                                                 | `/v2/emails`                | [Emails](https://docs.tiny.plus/api/endpoints/emails.md)                               |
| Team members                                           | `/v2/staff`                 | [Team Members](https://docs.tiny.plus/api/endpoints/team-members.md)                   |
| CVs (accounts with submission packs)                   | `/v2/cvs`                   | [CVs](https://docs.tiny.plus/api/endpoints/cvs.md)                                     |
| Capability statements (accounts with submission packs) | `/v2/capability_statements` | [Capability statements](https://docs.tiny.plus/api/endpoints/capability-statements.md) |
| Posts                                                  | `/v2/updates`               | [Posts](https://docs.tiny.plus/api/endpoints/updates.md)                               |

Every record type supports the same operations, described on the [Records](https://docs.tiny.plus/api/endpoints/records.md) page. Posts are the exception: `GET /v2/updates` works differently, as described on the [Posts](https://docs.tiny.plus/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](https://docs.tiny.plus/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](https://docs.tiny.plus/api/endpoints/account-structure.md)              |
| `GET /v2/staff_list`                                                                                         | A short list of every team member.                                                                 | [Account structure](https://docs.tiny.plus/api/endpoints/account-structure.md#team-members) |
| `GET`, `POST`, `PATCH` and `DELETE /v2/packs`                                                                | Open, shape and build a project's submission pack or fee proposal, and fetch its files.            | [Submission packs](https://docs.tiny.plus/api/endpoints/packs.md)                           |
| `GET /v2/fee_templates`, `GET /v2/rate_cards`                                                                | The fee templates and rate cards a fee proposal starts from, read-only.                            | [Fee templates and rate cards](https://docs.tiny.plus/api/endpoints/fee-templates.md)       |
| `GET /v2/stats/projects`                                                                                     | Pipeline totals by status and phase.                                                               | [Pipeline statistics](https://docs.tiny.plus/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](https://docs.tiny.plus/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](https://docs.tiny.plus/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](https://docs.tiny.plus/api/endpoints/bid-teams.md)                              |
| `GET /v2/connect`, `GET /v2/connect/{contact_id}`, `POST /v2/connect/{contact_id}/log` and `/later`          | Who to contact this week and why, one person's contact history, and logging or putting off a card. | [Connect](https://docs.tiny.plus/api/endpoints/connect.md)                                  |
| `GET /v2/dashboards`, `GET /v2/dashboards/{id}`, `POST /v2/dashboards/{id}/scope`                            | A person's dashboards with each panel's data, read with a scope.                                   | [Dashboards](https://docs.tiny.plus/api/endpoints/dashboards.md)                            |
| `GET /v2/table_views?for={type}`, `GET /v2/{type}?view={id}`                                                 | A person's saved views of a record type's table, and the records a view lists.                     | [Table views](https://docs.tiny.plus/api/endpoints/table-views.md)                          |
| `GET /v2/bulk?for={type}`, `GET` and `POST /v2/bulk/{action}`, `POST /v2/bulk/undo`                          | Change several records at once, as the ticked rows of a table are, with undo.                      | [Bulk actions](https://docs.tiny.plus/api/endpoints/bulk-actions.md)                        |
| `POST /v2/ai/filter`                                                                                         | Turn a plain-English question into list filters.                                                   | [Ask filters](https://docs.tiny.plus/api/endpoints/ai-filter.md)                            |
| `POST /v2/comments`                                                                                          | Comment on a post.                                                                                 | [Posts](https://docs.tiny.plus/api/endpoints/updates.md#comments)                           |
| `POST /v2/attachments`                                                                                       | Attach an image or document to a record.                                                           | [Attachments](https://docs.tiny.plus/api/endpoints/attachments.md)                          |
| `GET /v2/buttons`, `POST /v2/webhooks/add`                                                                   | Send a record to your URL when someone presses a button.                                           | [Webhooks](https://docs.tiny.plus/api/endpoints/webhooks.md)                                |
| `POST /v2/actions` with `do=join_team` or `do=leave_team`                                                    | Join or leave a record's team.                                                                     | [Linking records](https://docs.tiny.plus/api/concepts/linking.md)                           |
