v1

latestOpenAPI 3.0.22026-07-24154101.1 MB
Log Book

List Log Book Posts

Beta

get/v2/company/{company_id}/log_book_posts

Path parameters

company_idinteger required

Company ID

Query parameters

location_idinteger

Location ID

log_book_category_idinteger

Log Book Category ID

user_idinteger

Post Author User ID

datestring

A date with YYYY-MM-DD format

Example:2020-01-01

Date of log book creation, format YYYY-MM-DD

posted_date_gtestring

A date with YYYY-MM-DD format

Example:2020-01-01

List only log book posts from dates inclusive after, format YYYY-MM-DD

posted_date_ltestring

A date with YYYY-MM-DD format

Example:2020-01-01

List only log book posts from dates inclusive before, format YYYY-MM-DD

messagestring

List only posts containing the message

order_field'date' | 'id'

Order listed log book posts by a field

order_dir'asc' | 'desc'

Specified direction to order listed log book posts

cursorstring

Cursor for the next or previous page of results.

limitinteger

The number of results desired per page.

Headers

x-api-versionstring

An API version

Example:2022-05-01

7shifts API version

x-company-guidstring uuid

Company GUID

Response

OK

object'log_book_posts' required

Example response

{
  "data": [
    {
      "date": "2020-01-01"
    }
  ]
}