v3

latestOpenAPI 3.0.1Apache 2.0raw.githubusercontent.com2026-08-014669239.7 KB
Profile

List Profiles

Return a paginated list of profile IDs ordered by most recently created first. Use the optional paging parameters (pageSize, pageToken, orderBy) to control pagination and sorting. This endpoint is optimized for browsing newly created profiles and lightweight lookups where only the identifiers are needed before requesting full profile details.

get/v1/Stores/{storeId}/Profiles

Query parameters

pageSizeinteger

The maximum number of items to return per page, maximum of 1000.

pageTokenstring

The token for the page of results to retrieve.

orderBy'ASC' | 'DESC'

Either 'ASC' or 'DESC' to sort results ascending or descending respectively.

Response

A list of profile IDs up to a maximum of 100.

profilesProfileID[]

Example response

{
  "profiles": [
    "mem_profile_00000000000000000000000000",
    "mem_profile_00000000000000000000000001",
    "mem_profile_00000000000000000000000002",
    "mem_profile_00000000000000000000000003",
    "mem_profile_00000000000000000000000004",
    "mem_profile_00000000000000000000000005",
    "mem_profile_00000000000000000000000006",
    "mem_profile_00000000000000000000000007",
    "mem_profile_00000000000000000000000008",
    "mem_profile_00000000000000000000000009"
  ],
  "meta": {
    "key": "profiles",
    "nextToken": "eyJlYXN0ZXIiOiJlZ2cifQ",
    "previousToken": "eyJlYXN0ZXIiOiJlZ2cifQ"
  }
}