Get company members listdeprecated

gethttps://core-api.ancon.io/api/v1/Outlets/{outletId}/Companies/{companyId}/Members

View .md OpenAPI

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
companyIdstring (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
8 fields in items
- idstring (uuid)
- fullNamestring | null
- firstNamestring | null
- lastNamestring | null
- emailstring | null
- phoneNumberstring | null
- departmentstring | null
- emailVerifiedboolean
metaobject | null
2 fields in meta
- countinteger (int32)
- offsetinteger (int32)

404Not Foundapplication/json

messagestring | null
errorCodestring (uuid)

Request

curl -X GET "https://core-api.ancon.io/api/v1/Outlets/{outletId}/Companies/{companyId}/Members" \
  -H "Access-Token: $ANCON_TOKEN"

Response

{
  "items": [
    {
      "id": "4e694a2f-7db1-4cde-b033-689e09c4ef98",
      "fullName": "John Doe",
      "firstName": "John",
      "lastName": "Doe",
      "email": "johnjoe@ancon.io",
      "phoneNumber": "123456789",
      "department": "IT",
      "emailVerified": true
    }
  ],
  "meta": {
    "count": 1,
    "offset": 0
  }
}

#Authorization

#Path parameters

#Query parameters

#Header parameters

#Responses

Authorization

Path parameters

Query parameters

Header parameters

Responses