developers
esc

Popular

↑ ↓ navigate↵ openAgents: llms.txt

User APICompanies

Get company detailsdeprecated

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

Authorization

  • Access-Tokenheaderrequired

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

Path parameters

  • outletIdstring (uuid)required
  • companyIdstring (uuid)required

Header parameters

  • correlationIdstring

    Correlation Id for the request

Responses

200OKapplication/json
  • companyobject | null
    20 fields in company
    • idstring (uuid)
    • createdstring (date-time)
    • modifiedstring (date-time)
    • tenantIdstring (uuid)
    • namestring | null
    • businessNumberstring | null
    • addressIdstring (uuid)
    • invoiceAddressobject | null
      4 fields in invoiceAddress
      • streetstring | null
      • street2string | null
      • zipCodestring | null
      • citystring | null
    • countryCodestring | null
    • phoneNumberstring | null
    • invoiceEmailstring | null
    • defaultInvoiceReferenceNotestring | null
    • isDeletedboolean
    • 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.

    • glnstring | null
    • companyReferencestring | null
    • guestGroupIdstring (uuid) | null
    • integrationExternalIdsmap<string, string> | null
401Unauthorizedapplication/json
404Not Foundapplication/json
  • messagestring | null
  • errorCodestring (uuid)