List all users

GET

/users

const url = 'https://acme.mykreezalid.com/api/v1/users?group_id=784568%2C784569&page=1&limit=25';
const options = {method: 'GET', headers: {Authorization: 'Basic <credentials>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://acme.mykreezalid.com/api/v1/users?group_id=784568%2C784569&page=1&limit=25' \
  --header 'Authorization: Basic <credentials>'

Returns your users, most recent first, 25 per page by default.

Authorizations

basic

Parameters

Query Parameters

group_id

string

Keep only the users of these groups: one identifier, a comma-separated list (group_id=12,13) or an array (group_id[]=12&group_id[]=13).

Example

784568,784569

page

integer

default: 1

Page to return, starting at 1.

limit

integer

default: 25 <= 100

Number of users per page, at most 100.

fields

string

Comma-separated list of the fields to return for each user, e.g. id,email,group.

Responses

200

A page of users

application/json

object

users

Array<object>

User resource

A member of your marketplace, customer or vendor, as the Admin API returns it.

object

User’s unique identifier

integer

object

string

external_id

Your own identifier for this user

string

nullable

account_type

string

nullable

Allowed values: individual company non_profit soletrader

address_city

string

nullable

address_country

Two-letter country code

string

nullable

address_line1

string

nullable

address_line2

string

nullable

address_state

string

nullable

address_zipcode

string

nullable

attributes

Values of the user’s custom profile fields

object

avatar

Absolute URL of the profile image

string

nullable

birthday

string format: date

nullable

business_name

Company or organization name

string

nullable

can_post_listing

Whether the user’s group may publish listings

boolean

is_onboarding

Whether the user’s group goes through onboarding

boolean

company

Company details. Absent when account_type is individual.

object

object

string

address_line1

string

nullable

address_line2

string

nullable

address_city

string

nullable

address_country

string

nullable

address_state

string

nullable

address_zipcode

string

nullable

name

string

nullable

number

Company registration number

string

nullable

website_url

string

nullable

created_at

Sign-up date, YYYY-MM-DD HH:MM:SS

string

email

string

first_name

string

nullable

group

object

object

string

default: Group

Group’s unique identifier

integer

name

string

alias

string

group_id

Identifier of the user’s group. Deprecated in responses: read group.id.

integer

group_name

Read group.name.

string

group_alias

Read group.alias.

string

lang

Language code

string

nullable

last_name

string

nullable

listing_count

Number of the user’s listings

integer

nullable

listing_count_any_status

Number of the user’s listings, whatever their status

integer

locale

Same value as lang

string

nullable

metafields

The user’s metafields, when they are loaded; null otherwise

Array<object>

nullable

A custom value you attach to a resource, identified by its namespace and title.

object

namespace

required

Group the metafield belongs to

string

title

required

Name of the metafield, unique within its namespace

string

value

required

Value of the metafield. Usually a string; it can be returned as a number or a JSON value depending on how the metafield was defined.

string

nationality

Two-letter country code

string

nullable

average_rating

Average rating from the reviews the user received

number

nullable

phone_country_code

string

nullable

phone_number

string

nullable

profile_url

Absolute URL of the user’s public profile

string

nullable

public_name

Name shown publicly, following your display settings

string

status

Account status

string

Allowed values: enabled disabled unknown

identity_status

Whether the user completed their identity details

string

nullable

Allowed values: not_completed completed

review_count

Number of reviews the user received

integer

nullable

timezone

string

nullable

username

string

nullable

pagination

Paging information, added next to the results of a paginated list. Request another page with the page query parameter and change the page size with limit (at most 100).

object

totalResultsCount

Number of results across all pages.

integer

currentPage

Number of the page returned, starting at 1.

integer

nextPage

Whether a next page exists.

boolean

prevPage

Whether a previous page exists.

boolean

resultOnPageCount

Number of results on this page.

integer

pageCount

Number of pages.

integer

Example

{
  "users": [
    {
      "id": 545353,
      "object": "User",
      "external_id": "ABCdef123456",
      "account_type": "individual",
      "address_city": "New-York City",
      "address_country": "US",
      "address_line1": "253 W 42nd St",
      "address_line2": null,
      "address_state": "NY",
      "address_zipcode": "10036",
      "attributes": {
        "profession": "Web developer"
      },
      "birthday": "1990-05-17",
      "business_name": "ACME",
      "company": {
        "object": "Company",
        "name": "ACME"
      },
      "created_at": "2024-03-18 09:41:05",
      "email": "jane@example.com",
      "first_name": "Jane",
      "group": {
        "object": "Group",
        "id": 784568,
        "name": "VIP Customers",
        "alias": "vip-customers"
      },
      "group_id": 784568,
      "lang": "en",
      "last_name": "Doe",
      "listing_count": 12,
      "listing_count_any_status": 14,
      "locale": "en",
      "metafields": [
        {
          "namespace": "erp",
          "title": "warehouse_code",
          "value": "WH-42"
        }
      ],
      "nationality": "US",
      "average_rating": 4.5,
      "phone_country_code": "+1",
      "phone_number": "212-398-2600",
      "profile_url": "https://acme.mykreezalid.com/shop/a1b2c3d/jane-doe",
      "public_name": "Jane Doe",
      "status": "enabled",
      "identity_status": "not_completed",
      "review_count": 3,
      "timezone": "America/New_York",
      "username": "janedoe"
    }
  ],
  "pagination": {
    "totalResultsCount": 137,
    "currentPage": 1,
    "resultOnPageCount": 25,
    "pageCount": 6
  }
}

400

group_id is not an identifier or a list of identifiers.