> ## Documentation Index > Fetch the complete documentation index at: https://vexioncards.mintlify.site/llms.txt > Use this file to discover all available pages before exploring further. # List team members > Lists team members, newest first. Scope: `team_members:read`. **Default excludes terminal states** - filter `status=revoked` (dashboard-revoked) or `status=expired` (auto-expired scanners) explicitly to audit past staff (their records are preserved forever so `Transaction.team_member_id` history stays attributable). Common queries: - Who can act at a store: `?location_id=loc_...` (admins are NOT returned by this filter - they have implicit all-location access; fetch them with `?role=admin`) - Pending invitations: `?status=invited` - Temporary staff: filter client-side on `expires_at != null` See [Pagination](/api-reference/pagination). ## OpenAPI ````yaml /openapi.json get /v1/team_members openapi: 3.1.0 info: title: VEXiON cards Public API description: >- ## Rate limiting Two independent layers, checked in this order: 1. **Per-IP throttle (pre-authentication).** Applied to every `/v1` request BEFORE the API key is checked, keyed on the caller's IP address: - **600 requests/minute** per IP - a flood ceiling, `429 rate_limit_error` / `rate_limited`. - **20 failed authentications per 15 minutes** per IP - a key-guessing ceiling. Only responses that are `401` (missing/invalid/revoked key) count against this ceiling; a `403` from a valid key that simply lacks a scope does not. `429 rate_limit_error` / `too_many_failed_attempts`. Both ceilings send `Retry-After` (seconds). 2. **Per-key, per-bucket limiter (post-authentication).** Documented per endpoint (see each operation's `429` response and the `rate_limit` field on the API Key resource) - e.g. 60/min default, 120/min for transactions, plus the notification-broadcast and lookup-filter buckets described on their own endpoints. ### Rate-limit response headers Every rate-limited response carries the legacy `X-RateLimit-Limit` / `X-RateLimit-Remaining` / `X-RateLimit-Reset` family (the last is an **epoch timestamp**) AND the IETF standards-track headers, side by side: - `RateLimit-Policy: "";q=;w=` - the static policy for the bucket that was hit. - `RateLimit: "";r=;t=` - live state. **`t` is a DURATION (seconds remaining), not the epoch timestamp `X-RateLimit-Reset` carries - the two are never the same value.** version: 1.0.0 servers: - url: https://api.vexioncards.one description: Production - url: https://migration.api.vexioncards.one description: Sandbox security: - apiKey: [] tags: - name: Customers - name: Cards - name: Transactions - name: Notifications - name: Locations - name: Products - name: API keys - name: Organization - name: Webhook endpoints - name: Events - name: Custom fields - name: Team members - name: Icons paths: /v1/team_members: get: tags: - Team members summary: List team members description: >- Lists team members, newest first. Scope: `team_members:read`. **Default excludes terminal states** - filter `status=revoked` (dashboard-revoked) or `status=expired` (auto-expired scanners) explicitly to audit past staff (their records are preserved forever so `Transaction.team_member_id` history stays attributable). Common queries: - Who can act at a store: `?location_id=loc_...` (admins are NOT returned by this filter - they have implicit all-location access; fetch them with `?role=admin`) - Pending invitations: `?status=invited` - Temporary staff: filter client-side on `expires_at != null` See [Pagination](/api-reference/pagination). operationId: listTeamMembers parameters: - name: limit in: query required: false description: Page size, 1-100. Default 25. schema: type: integer minimum: 1 maximum: 100 default: 25 - name: starting_after in: query description: >- Cursor: object id from the previous page (forward walk). Numeric offset or page parameters are not supported; cursors are the only supported paging mechanism. required: false schema: type: string - name: ending_before in: query description: 'Cursor: object id from the previous page (reverse walk).' required: false schema: type: string - name: role in: query description: 'Filter: `admin`, `manager`, `scanner`.' required: false schema: type: string enum: - admin - manager - scanner - name: status in: query description: >- Lifecycle filter. Default (omitted) returns `invited` + `active` only - terminal states must be asked for explicitly. required: false schema: type: string enum: - invited - active - revoked - expired - name: location_id in: query description: Members whose scope includes this location. required: false schema: type: string - name: email in: query description: Exact-match email lookup. required: false schema: type: string responses: '200': description: The team member object. content: application/json: schema: $ref: '#/components/schemas/TeamMemberList' examples: Active team: summary: Direct-created scanner + invited manager value: object: list data: - id: tm_01HW9R6M4XQ2N8MTX1RVTM0001 object: team_member email: anna@demo-coffee.example first_name: Anna last_name: Kováčová role: scanner location_ids: - loc_01HW9R4P2ZK7N8MTX1RVLOCS01 status: active origin: direct expires_at: null language: sk invited_at: null activated_at: 1750000000 created_at: 1750000000 updated_at: 1751500000 - id: tm_01HW9R6M4XQ2N8MTX1RVTM0002 object: team_member email: peter@demo-coffee.example first_name: Peter last_name: Vlk role: manager location_ids: - loc_01HW9R4P2ZK7N8MTX1RVLOCS01 - loc_01HW9R4P2ZK7N8MTX1RVLOCS02 status: active origin: invitation expires_at: null language: sk invited_at: 1749900000 activated_at: 1749986400 created_at: 1749900000 updated_at: 1751500000 has_more: false url: /v1/team_members Pending invitations: summary: '?status=invited - a temp hire with auto-expiry' value: object: list data: - id: tm_01HW9R6M4XQ2N8MTX1RVTM0003 object: team_member email: brigadnik@demo-coffee.example first_name: null last_name: null role: scanner location_ids: - loc_01HW9R4P2ZK7N8MTX1RVLOCS02 status: invited origin: invitation expires_at: 1759269600 language: sk invited_at: 1751600000 activated_at: null created_at: 1751600000 updated_at: 1751600000 has_more: false url: /v1/team_members headers: {} '400': description: >- Invalid pagination parameter: limit outside 1-100, or a malformed cursor. content: application/json: schema: $ref: '#/components/schemas/Error' examples: Invalid limit: summary: limit out of range value: error: type: invalid_request_error code: invalid_limit message: limit must be an integer between 1 and 100. doc_url: >- https://vexioncards.mintlify.site/api-reference/errors#invalid_limit request_id: req_5f8b2c4a9e1d3 param: limit Malformed cursor: summary: starting_after is not a valid cursor value: error: type: invalid_request_error code: invalid_cursor message: starting_after is not a valid tm_ cursor. doc_url: >- https://vexioncards.mintlify.site/api-reference/errors#invalid_cursor request_id: req_5f8b2c4a9e1d3 param: starting_after headers: {} '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error' headers: {} '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error' headers: {} '429': description: Rate limited - respect Retry-After. content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: Server error. Retry-safe on idempotent calls. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: type: api_error code: internal_error message: >- An internal error occurred. The request may be retried with the same Idempotency-Key. doc_url: >- https://vexioncards.mintlify.site/api-reference/errors#internal_error request_id: req_5f8b2c4a9e1d3 examples: Http 500 default: summary: Http 500 default value: error: type: api_error code: internal_error message: >- An internal error occurred. The request may be retried with the same Idempotency-Key. doc_url: >- https://vexioncards.mintlify.site/api-reference/errors#internal_error request_id: req_5f8b2c4a9e1d3 headers: {} deprecated: false components: schemas: TeamMemberList: allOf: - $ref: '#/components/schemas/ListEnvelope' - type: object properties: data: type: array items: $ref: '#/components/schemas/TeamMember' url: type: string const: /v1/team_members Error: type: object required: - error properties: error: type: object required: - type - code - message properties: type: type: string enum: - invalid_request_error - authentication_error - permission_error - not_found_error - rate_limit_error - idempotency_error - api_error code: type: string message: type: string retry_after: type: integer description: >- Seconds to wait before retrying. Present on rate-limit (429) and idempotency-key-in-use (409) errors; mirrors the `Retry-After` HTTP header. Absent on error types that carry no retry guidance. example: 5 param: type: - string - 'null' request_id: type: string doc_url: type: string format: uri field_errors: type: array description: >- Per-field errors on a 422. At most 100 entries: a request with more errors gets the first 100. items: type: object properties: param: type: string code: type: string message: type: string expected_currency: type: string description: >- On `currency_mismatch`: the business currency the request must use. Absent on every other field error. description: >- The error payload: type (category), code (machine-readable), message (human-readable), retry_after (seconds, on rate-limit/idempotency-in-use errors only), param (offending field), request_id, doc_url, field_errors[]. description: >- Standard error envelope. Branch on `error.code`; include `error.request_id` in support requests. See the Errors guide. ListEnvelope: type: object required: - object - data - has_more properties: object: type: string const: list description: Always `"list"`. data: type: array items: {} description: Array of the requested resource type. has_more: type: boolean description: >- True when more pages exist - pass the last item id as `starting_after`. next_cursor: type: - string - 'null' description: >- Cursor for the next page **in the direction you are already paging**, or `null` when this page ends the collection. `has_more: true` always comes with a non-null `next_cursor`. Feed it back to the SAME parameter you used: `starting_after` when paging forward (the default), or `ending_before` when paging backward. Treat it as opaque and do not parse it. You no longer need to take the last object's `id` yourself. That still works and is unchanged, but deriving the cursor from the page put the burden of knowing the sort direction on you, and it broke silently on any endpoint whose cursor is not the object id. example: cus_iofv5j4hn6bphinmmyat27tc5y url: type: string description: Stable collection URL. description: >- Standard cursor-pagination envelope for list endpoints. See the Pagination guide. TeamMember: type: object description: >- A staff account - dashboard and scanner access. Role lives in the auth provider; the location assignment is dual-written: a queryable mirror in VEXiON (surfaced as `Location.team_members[]`) plus auth-time enforcement metadata on the user account, which is what locks a scanner to their single store at every request. `location_ids` here is the ONE write path - both copies sync from it. `id` and this resource's identity fields (`first_name`/`last_name`/`email`/`language`) are anchored to a registry row scoped to YOUR organization - the same person staffing another organization has a DIFFERENT `id` there, and a PATCH here never changes what that other organization sees for them. Manual transactions carry the acting member as `Transaction.team_member_id` - which is why revoked and expired members are preserved as records: history stays attributable forever. Members sign in with their email code (OTP) or social login. required: - id - object - email - role - location_ids - status - origin - created_at properties: id: type: string pattern: ^tm_[A-Za-z0-9]+$ description: >- Team member identifier, `tm_` prefix. For an `active` member it is stable within your organization across role and location changes, and it is never shared with any other organization they may also staff. For a member still `invited` it belongs to the current invitation and changes when the invitation is re-sent, when a PATCH edits the invited member's name, role or expires_at (the invitation is re-issued and a new email sent), and when the invite is accepted; the previous id then returns 404. Key invited members by `email`. example: tm_01HW9R6M4XQ2N8MTX1RVTM0001 object: type: string const: team_member description: Always `"team_member"`. email: type: string format: email description: Sign-in email, unique per organization. example: anna@demo-coffee.example first_name: type: - string - 'null' description: >- Given name. Null until the member fills their profile (invitation origin) or you supply it (direct origin). example: Anna last_name: type: - string - 'null' description: Family name. example: Kováčová role: type: string enum: - admin - manager - scanner description: >- What they can do: - `admin` - everything incl. billing, cards, team; implicit access to ALL locations - `manager` - customers, notifications, scanner at assigned locations; no billing, no card editing - `scanner` - POS scanner only, at exactly one location (a till account) Role changes email the member automatically. example: scanner location_ids: type: array items: type: string pattern: ^loc_[A-Za-z0-9]+$ description: >- Assigned locations - **the write path for the location↔member relationship** (Location.team_members[] is the read mirror). Cardinality is role-bound: `admin` → always `[]` (all locations implicit); `manager` → one or more; `scanner` → exactly one. example: - loc_01HW9R4P2ZK7N8MTX1RVLOCS01 status: type: string enum: - invited - active - revoked - expired description: >- Lifecycle: - `invited` - invitation email sent, account not yet created (invitation origin only) - `active` - can sign in and act - `revoked` - removed by an admin (DELETE); sessions revoked, record preserved - `expired` - `expires_at` passed; sessions revoked automatically, record preserved Terminal states (`revoked`, `expired`) are not editable - add the person again with a new POST. example: active origin: type: string enum: - invitation - direct description: >- How the account came to be: `invitation` - the member accepted an email invite on the branded accept page; `direct` - an API call created the account, active immediately with email-code (OTP) or social sign-in (typical for till/scanner accounts). example: direct expires_at: type: - integer - 'null' description: >- Unix seconds when this member auto-expires - the temporary-staff feature, **available on the scanner role only** (seasonal hires, one-day events; a till account that cleans itself up). Null = permanent, and always null for admin/manager. At expiry the platform revokes all sessions (signed out within ~5 minutes), removes access, sets `status: "expired"`, and emails the member; a heads-up email goes out 24 h before. Extend or clear by PATCHing before expiry. example: null language: type: - string - 'null' enum: - en - sk - cs - de - null description: >- Email language for invitations and lifecycle notices. Defaults to the organization language. example: sk invited_at: type: - integer - 'null' description: When the invitation email was sent. Null for `direct` origin. example: 1750000000 activated_at: type: - integer - 'null' description: >- When the account became active - invitation acceptance time, or creation time for `direct` origin. Null while `invited`. example: 1750003600 created_at: type: integer description: Unix seconds. example: 1750000000 updated_at: type: integer description: Unix seconds of last change. example: 1751500000 securitySchemes: apiKey: type: http scheme: bearer description: >- Your secret API key as a Bearer token: `Authorization: Bearer vxn_sk_...`. Keys are created and scoped in the dashboard - see [Authentication](/api-reference/introduction#authentication). ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.