--- updatedAt: 2026-05-19T13:57:37.000Z agentTools: projectIndex: https://trustmarkt.readme.io/llms.txt --- # List Users Display a paginated list of users belonging to the authenticated user's company. The users are ordered by their creation date in descending order, meaning the most recently created users will appear first. The pagination can be controlled using the `page` query parameter, which must be an integer greater than or equal to 1. If the `page` parameter is not provided, the first page of results will be returned by default. # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "Trustmarkt API", "version": "1.1.0", "description": "Die offizielle API für Trustmarkt - Zugriff auf Reviews, Benutzer und Unternehmensdaten." }, "servers": [ { "url": "https://api.trustmarkt.de/v1", "description": "Prod." } ], "security": [ { "http": [] } ], "paths": { "/user": { "get": { "operationId": "user.index", "description": "Display a paginated list of users belonging to the authenticated user's company.\n\nThe users are ordered by their creation date in descending order, meaning the most recently created users will appear first.\n\nThe pagination can be controlled using the `page` query parameter, which must be an integer greater than or equal to 1.\n\nIf the `page` parameter is not provided, the first page of results will be returned by default.", "summary": "List Users", "tags": [ "Users" ], "parameters": [ { "name": "page", "in": "query", "description": "The page parameter is used for pagination. It is optional and must be an integer greater than or equal to 1. If not provided, the first page will be returned.", "schema": { "type": "integer", "minimum": 1 } }, { "name": "per_page", "in": "query", "description": "The per_page parameter is used to specify the number of results to return per page. It is optional and must be an integer between 1 and 50. If not provided, the default value of 15 will be used.", "schema": { "type": "integer", "minimum": 1, "maximum": 50 } } ], "responses": { "200": { "description": "Paginated set of `UserResource`", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/UserResource" } }, "links": { "type": "object", "properties": { "first": { "type": [ "string", "null" ] }, "last": { "type": [ "string", "null" ] }, "prev": { "type": [ "string", "null" ] }, "next": { "type": [ "string", "null" ] } }, "required": [ "first", "last", "prev", "next" ] }, "meta": { "type": "object", "properties": { "current_page": { "type": "integer", "minimum": 1 }, "from": { "type": [ "integer", "null" ], "minimum": 1 }, "last_page": { "type": "integer", "minimum": 1 }, "links": { "type": "array", "description": "Generated paginator links.", "items": { "type": "object", "properties": { "url": { "type": [ "string", "null" ] }, "label": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "url", "label", "active" ] } }, "path": { "type": [ "string", "null" ], "description": "Base path for paginator generated URLs." }, "per_page": { "type": "integer", "description": "Number of items shown per page.", "minimum": 0 }, "to": { "type": [ "integer", "null" ], "description": "Number of the last item in the slice.", "minimum": 1 }, "total": { "type": "integer", "description": "Total number of items being paginated.", "minimum": 0 } }, "required": [ "current_page", "from", "last_page", "links", "path", "per_page", "to", "total" ] } }, "required": [ "data", "links", "meta" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" }, "403": { "$ref": "#/components/responses/AuthorizationException" }, "422": { "$ref": "#/components/responses/ValidationException" }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview." } }, "required": [ "message" ] } } } } } } } }, "components": { "securitySchemes": { "http": { "type": "http", "scheme": "bearer" } }, "schemas": { "ArticleResource": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the article.", "examples": [ "gYW1KaOqEpMdeMQrlwpV" ] }, "company_id": { "type": "string", "description": "The unique identifier of the company the article belongs to.", "examples": [ "XZzyJn9jEB1lWdvVRx6w" ] }, "category_id": { "type": [ "string", "null" ], "description": "The unique identifier of the category the article belongs to, or null if the article has no category.", "examples": [ "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6" ] }, "author_id": { "type": [ "string", "null" ], "description": "The unique identifier of the author of the article, or null if the article has no author.", "examples": [ "u1v2w3x4y5z6a7b8c9d0e1f2g3h4i5j6" ] }, "reading_time": { "type": "integer", "description": "The estimated reading time for the article in minutes.", "examples": [ 5 ] }, "word_count": { "type": "integer", "description": "The number of words in the article.", "examples": [ 1200 ] }, "character_count": { "type": "integer", "description": "The number of characters in the article.", "examples": [ 7500 ] }, "status": { "type": "string", "description": "The publication status of the article, which can be one of the following values: DRAFT, SUBMITTED, APPROVED, REJECTED, or ARCHIVED. Use the `published_at` field to determine when the article was published. An article is considered published if its `published_at` timestamp is in the past, regardless of its status.", "examples": [ "APPROVED" ] }, "title": { "type": "string", "description": "The title of the article.", "examples": [ "How to Build Trust with Your Customers: 5 Proven Strategies" ] }, "slug": { "type": "string", "description": "A URL-friendly version of the article title, typically used in the article's URL.", "examples": [ "how-to-build-trust-with-your-customers-5-proven-strategies" ] }, "excerpt": { "type": [ "string", "null" ], "description": "A short summary or excerpt of the article, which may be null if no excerpt is available.", "examples": [ "Building trust with your customers is essential for any business. In this article, we explore five proven strategies to help you establish and maintain trust with your audience." ] }, "content": { "type": "string", "description": "The main HTML-content of the article, which may be null if the content is not loaded. The content is only included in the response if the `content` relationship is explicitly expanded using the `expand` query parameter.", "examples": [ "

Building trust with your customers is essential for any business. In this article, we explore five proven strategies to help you establish and maintain trust with your audience.

" ] }, "published_at": { "type": [ "string", "null" ], "description": "The timestamp when the article was published, or null if the article has not been published yet. An article is considered published if its `published_at` timestamp is in the past, regardless of its status.", "examples": [ "2025-12-04T12:15:13+01:00" ] }, "created_at": { "type": [ "string", "null" ], "description": "The timestamp when the article was created.", "examples": [ "2025-12-04T12:12:44+01:00" ] }, "updated_at": { "type": [ "string", "null" ], "description": "The timestamp when the article was last updated.", "examples": [ "2026-01-21T10:31:59+01:00" ] }, "company": { "anyOf": [ { "$ref": "#/components/schemas/CompanyResource" }, { "type": "null" } ] }, "author": { "anyOf": [ { "$ref": "#/components/schemas/UserResource" }, { "type": "null" } ] }, "category": { "type": "object", "properties": { "id": { "type": [ "string", "null" ], "description": "The unique identifier of the category.", "examples": [ "gYW1KaOqEpMdeMQrlwpV" ] }, "name": { "type": [ "string", "null" ], "description": "The name of the category.", "examples": [ "Customer Success" ] }, "slug": { "type": [ "string", "null" ], "description": "A URL-friendly version of the category name, typically used in the category's URL.", "examples": [ "customer-success" ] } }, "required": [ "id", "name", "slug" ] } }, "required": [ "id", "company_id", "category_id", "author_id", "reading_time", "word_count", "character_count", "status", "title", "slug", "excerpt", "published_at", "created_at", "updated_at" ], "title": "ArticleResource" }, "CategoryResource": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the category", "examples": [ "Bb1eXjgmE7QZQ2JG0PAz" ] }, "name": { "type": "string", "description": "The name of the category", "examples": [ "Webdesign-Agentur" ] }, "slug": { "type": "string", "description": "The slug of the category, used for URLs", "examples": [ "webdesign" ] } }, "required": [ "id", "name", "slug" ], "title": "CategoryResource" }, "CompanyResource": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the company", "examples": [ "XZzyJn9jEB1lWdvVRx6w" ] }, "employees": { "type": [ "integer", "null" ], "description": "The number of employees working at the company", "examples": [ 50 ] }, "founding_year": { "type": [ "integer", "null" ], "description": "The year the company was founded", "examples": [ 1998 ] }, "name": { "type": "string", "description": "The name of the company", "examples": [ "Musterfirma GmbH" ] }, "slug": { "type": [ "string", "null" ], "description": "The slug of the company, used for URLs", "examples": [ "musterfirma-gmbh" ] }, "catch_phrase": { "type": [ "string", "null" ], "description": "The catch phrase of the company", "examples": [ "We create beautiful websites!" ] }, "website": { "type": [ "string", "null" ], "description": "The website of the company", "examples": [ "https://www.musterfirma.de" ] }, "phone": { "type": "string", "description": "The phone number of the company", "examples": [ "+49 123 4567890" ] }, "email": { "type": [ "string", "null" ], "description": "The email address of the company", "examples": [ "info@diebesteagentur.de" ] }, "url": { "type": "string", "description": "The URL to the company's profile page on the Trustmarkt website", "examples": [ "https://www.trustmarkt.de/unternehmen/musterfirma-gmbh" ] }, "created_at": { "type": [ "string", "null" ], "description": "The date and time when the company was created in ISO 8601 format", "examples": [ "2026-02-28T16:12:10+01:00" ] }, "score": { "type": "object", "description": "The score of the company.", "properties": { "name": { "type": [ "string", "null" ], "description": "The name of the score", "examples": [ "Agentur-Score" ] }, "value": { "type": "number", "description": "The value of the score, rounded to three decimal places", "examples": [ 4.567 ] }, "reviews": { "type": "integer", "description": "The total number of reviews that contribute to the score", "examples": [ 67 ] }, "internal": { "type": "integer", "description": "The amount of reviews that are internal (created on the platform)", "examples": [ 45 ] }, "external": { "type": "integer", "description": "The amount of reviews that are external (imported from other platforms)", "examples": [ 22 ] } }, "required": [ "name", "value", "reviews", "internal", "external" ] }, "site": { "type": "object", "description": "The site the company belongs to.", "properties": { "identifier": { "type": [ "string", "null" ], "description": "The unique identifier of the site, that will not change even if the host or name of the site changes.", "examples": [ "expertenmarkt" ] }, "name": { "type": [ "string", "null" ], "description": "The name of the site", "examples": [ "Expertenmarkt" ] }, "host": { "type": [ "string", "null" ], "description": "The host of the site", "examples": [ "expertenmarkt.de" ] } }, "required": [ "identifier", "name", "host" ] }, "main_category": { "anyOf": [ { "description": "The main category the company belongs to. This relation is only loaded if explicitly requested via the `expand` query parameter.", "$ref": "#/components/schemas/CategoryResource" }, { "type": "null" } ] }, "articles": { "type": "array", "description": "The subcategories the company belongs to. This relation is only loaded if explicitly requested via the `expand` query parameter.", "items": { "$ref": "#/components/schemas/ArticleResource" } } }, "required": [ "id", "employees", "founding_year", "name", "slug", "catch_phrase", "website", "phone", "email", "url", "created_at" ], "title": "CompanyResource" }, "PermissionRoleResource": { "type": "object", "properties": { "identifier": { "type": "string", "description": "The unique identifier of the permission role.", "examples": [ "company-owner" ] }, "name": { "type": "string", "description": "The human-readable name of the permission role.", "examples": [ "Inhaber:in" ] } }, "required": [ "identifier", "name" ], "title": "PermissionRoleResource" }, "UserResource": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the user.", "examples": [ "5GdkVeN8ZLaw29zBDXyb" ] }, "company_id": { "type": [ "string", "null" ], "description": "The unique identifier of the company the user belongs to. This field is null if the user does not belong to any company.", "examples": [ "XZzyJn9jEB1lWdvVRx6w" ] }, "total_reviews": { "type": "integer", "description": "The total number of reviews the user has written.", "examples": [ 42 ] }, "average_rating": { "type": "number", "description": "The average rating of the user. The value is rounded to 2 decimal places.", "examples": [ 4.25 ] }, "name": { "type": "string", "description": "The name of the user.", "examples": [ "John Doe" ] }, "email": { "type": "string", "description": "The email address of the user. **This field is only included if the user belongs to the same company as the authenticated user** or if the authenticated user is requesting their own data.", "examples": [ "john.doe@example.com" ] }, "email_hashed": { "type": [ "string", "null" ], "description": "A SHA-256 hash of the user's email address, computed after trimming whitespace and lowercasing. This value is privacy-safe (the original email cannot be recovered from the hash) and is always included.\nBefore hashing, the email is normalized by **trimming leading and trailing whitespace** and **converting it to lowercase**.", "examples": [ "d709f370e52b57b4eb75f04e2b3422c4d41a05148cad8f81776d94a048fb70af" ] }, "created_at": { "type": [ "string", "null" ], "description": "The date and time when the user was created. This field is only included if the authenticated user is requesting their own data.", "examples": [ "2026-02-28T16:12:10+01:00" ] }, "last_login_at": { "type": [ "string", "null" ], "description": "The date and time when the user last logged in. This field is only included if the user belongs to the same company as the authenticated user or if the authenticated user is requesting their own data. The value is null if there is no information about the last login time available.", "examples": [ "2026-02-28T16:12:10+01:00" ] }, "url": { "type": "string", "description": "The URL to the user's profile on the Trustmarkt website. This field is only included if the user belongs to the same company as the authenticated user or if the authenticated user is requesting their own data.", "examples": [ "https://www.trustmarkt.de/nutzer/john-doe" ] }, "permission_role": { "description": "The permission role of the user within their company. This field is only included if the user belongs to the same company as the authenticated user or if the authenticated user is requesting their own data.", "$ref": "#/components/schemas/PermissionRoleResource" }, "trustability": { "type": "object", "properties": { "social": { "type": "boolean", "description": "Indicates whether the user has verified their account using a social login provider (e.g., Google, Facebook, LinkedIn)." }, "email": { "type": "boolean", "description": "Indicates whether the user's email address has been verified. A value of true means the email address is verified, while false means it is not verified." }, "phone": { "type": "boolean", "description": "Indicates whether the user's phone number has been verified. A value of true means the phone number is verified, while false means it is not verified." } }, "required": [ "social", "email", "phone" ] }, "company": { "anyOf": [ { "description": "The company the user belongs to. This field is only included if the relation has been expanded in the request parameters.", "$ref": "#/components/schemas/CompanyResource" }, { "type": "null" } ] } }, "required": [ "id", "company_id", "total_reviews", "average_rating", "name", "email_hashed", "url", "trustability" ], "title": "UserResource" } }, "responses": { "AuthenticationException": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview." } }, "required": [ "message" ] } } } }, "ValidationException": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Errors overview." }, "errors": { "type": "object", "description": "A detailed description of each field that failed validation.", "additionalProperties": { "type": "array", "items": { "type": "string" } } } }, "required": [ "message", "errors" ] } } } }, "AuthorizationException": { "description": "Authorization error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview." } }, "required": [ "message" ] } } } } } } } ```