Records

Projects, companies, contacts and every other record type work the same way. This page covers the requests they share. Each record type's page covers what's particular to it, and lists its fields.

In the requests below, {type} is the record type's URL name, such as projects. The Endpoints page lists them all.

List records

GET https://api.tiny.plus/v2/{type}

Returns a page of records, which you can filter, sort and page through. Listing, filtering and paging covers every parameter.

curl "https://api.tiny.plus/v2/projects?record_status=active&sort=modified_date%20desc&limit=2&return_format=array&with_related=0" \
  -H "Authorization: Bearer {{user_access_token}}"

{
    "total_records": 163,
    "returned_records": 2,
    "records": [
        { "id": "62388", "name": "Example Project", "record_status": "active", ... },
        { "id": "62385", "name": "Second Example Project", "record_status": "active", ... }
    ]
}

Get a record

GET https://api.tiny.plus/v2/{type}/{{id}}

Get a record's change history

GET https://api.tiny.plus/v2/{type}/{{id}}/history

Returns the changes made to a record's fields, newest first, as an array:

created_user made the change. field_old and field_new are the stored values.

• History only covers changes to the fields tiny+ tracks for that record type. It doesn't cover the record's creation, its tags, links or custom fields.

• Unlike the rest of the API, created_date here is in Australia/Sydney time, whatever the account's time zone. created_date_orig is the same moment in UTC, so use that. Each change also comes with the date formatted in several other ways.

• A record with no tracked changes answers 404 {"error": "Could not find history."}.

• A confidential record's history is only available to people who can see the record. Anyone else gets 403 {"error": "This record is confidential."}.

Create a record

POST https://api.tiny.plus/v2/{type}

Send the new record's fields as JSON, or form-encoded. name is the only field every record type requires. Some record types require others, which their field references mark as required.

Update a record

PATCH https://api.tiny.plus/v2/{type}/{{id}}

Send only the fields you want to change. PUT does the same thing.

Fields that are not editable

Some fields are worked out or kept by tiny+ itself, such as record_url, id and a company's relationship plan fields. If a create or an update sends one, tiny+ leaves it out, saves the rest, and names what it left out:

So you can send a record back much as you read it. A create answers with id and ignored_fields in the same way. An update that sends nothing but such fields saves nothing, and answers "results": false.

Delete a record

DELETE https://api.tiny.plus/v2/{type}/{{id}}

The record is marked as deleted rather than erased. Reading it afterwards returns 410.

Search

GET https://api.tiny.plus/v2/search/{type}?q={words}

Finds records whose name, description or a few other key fields contain every word you search for, and returns a short summary of each. Results come newest first.

• Search ignores filters.

• Words of fewer than three letters, and common address words such as "street" and "road", are left out. If that leaves nothing to search for, every record matches.

• A search looks only at the type in the URL, and works for every type the API serves, stages included.

• On accounts that use stages, add stages=1 to a project search to get one result per stage.

• A search of posts (/v2/search/updates) leaves out the posts a search on GET /v2/updates leaves out: posts tiny+ writes automatically, confidential notes, and posts on a confidential record the token's user can't open.

Changing records quietly

Add dont_track=1 to a create or update to make the change quietly:

• tiny+ doesn't run the account's automated actions for it;

• nobody is notified;

• the token's user isn't added to a new record's team;

• an update doesn't change the record's modified_date or modified_user.

This is meant for integrations that keep tiny+ in step with another system, where a change isn't news to anyone.

Fields every record has

These fields are common to every record type. Each record type's page lists the fields particular to it.

A record you read also comes with:

• perm_edit and perm_delete: whether the token's user may change or delete it. See Permissions and confidential records.

• show_obscured: true when a confidential record has been masked.

• record_status_display: the status as tiny+ shows it, with its phase.

• {field}_name for each field that holds another record's id, when you get one record.

• hero_path_uri and hero_thumb_uri: the record's image, when it has one.

• its custom fields, as custom_{id}, and its tags. See Record types and your account's fields.

• on lists, its team.