developers
esc

Popular

↑ ↓ navigate↵ openAgents: llms.txt

Core APICompanies

Get company listdeprecated

gethttps://core-api.ancon.io/api/v1/Outlets/{outletId}/Companies
View .mdOpenAPI
Deprecated. Check the description for the replacement and sunset date, and see how deprecation works.

Will no longer work after 2027-03-31 00:00, move over to user service instead.

Authorization

  • Access-Tokenheaderrequired

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

Path parameters

  • outletIdstring (uuid)required

Query parameters

  • 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

Header parameters

  • correlationIdstring

    Correlation Id for the request

Responses

200OKapplication/json
  • itemsarray<object> | null
    9 fields in items
    • idstring (uuid)
    • namestring | null
    • createdstring (date-time)
    • lastOrderedAtstring (date-time) | null
    • invoiceCountinteger (int32)
    • totalSpentnumber (double)
    • originatingOutletIdstring (uuid) | null
    • originatingOutletNamestring | null
    • originatingIntegrationTypeinteger (int32) | null

      Allowed values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, -2, -1.

  • metaobject | null
    2 fields in meta
    • countinteger (int32)
    • offsetinteger (int32)
400Bad Requestapplication/json
  • messagestring | null
  • errorCodestring (uuid)
  • additionalDataany | null
401Unauthorizedapplication/json
  • messagestring | null
404Not Foundapplication/json
  • messagestring | null
  • errorCodestring (uuid)