developers
esc

Popular

↑ ↓ navigate↵ openAgents: llms.txt

Core APIChecks

Get outlet check list V2

gethttps://core-api.ancon.io/api/v2/Outlets/{outletId}/Checks
View .mdOpenAPI

Filtering

Filter the list with filter[field]=operator:value; see how filtering works.

  • referencenumber (long)
  • serialnumber (long)
  • ticketnumber (long)

Try filters

Build a filter for this endpoint and copy the request. How filtering works

Filters

Documented filter fields

Reads asNo filters: the endpoint returns everything (paged).

Request
(no filters)

No sample data for this endpoint; the request above is what you would send.

Authorization

  • Access-Tokenheaderrequired

    Tenant- or outlet-level token from the backoffice. See Get started.

Path parameters

  • outletIdstring (uuid)required

Query parameters

  • MetaFiltermap<string, array<string>>
  • Offsetinteger (int32)

    Offset the result, defaults to 0

  • Limitinteger (int32)

    Limits how many items to get, defaults to 100 min 0, max 1000.

  • Orderstring

    Order the result.

  • Searchstring
  • Filtermap<string, array<string>>

    Filter the result. Filter[created]=gte:2022-01-02 12:00:00&Filter[created]=lte:2022-08-03 22:00:00

Filter takes filter[field]=operator:value on 3 fields. Build a filter

Header parameters

  • correlationIdstring

    Correlation Id for the request

Responses

200OKapplication/json
  • timestampinteger (int64)

    Gets the timestamp in Unix time milliseconds when this response is created.

  • itemsarray<object> | null
    5 fields in items
    • idstring (uuid)
    • ticketNumberinteger (int64)
    • customNamestring | null
    • customTicketNumberinteger (int64) | null
    • orderFormatinteger (int32)

      Allowed values: 0, 1, 2, 4, 8, 16, 32, 64, 128, 159, 191.

401Unauthorizedapplication/json
  • timestampinteger (int64)

    Gets the timestamp in Unix time milliseconds when this response is created.

  • messagestring | null
404Not Foundapplication/json
  • timestampinteger (int64)

    Gets the timestamp in Unix time milliseconds when this response is created.

  • messagestring | null
  • errorCodestring (uuid)